1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
|
The X Resize, Rotate and Reflect Extension
Version 1.4.0
2009-10-5
Jim Gettys
Jim.Gettys@hp.com
Cambridge Research Laboratory
HP Labs
Hewlett Packard Company
Keith Packard
keith.packard@intel.com
Open Source Technology Center
Intel Corporation
1. Introduction
The X Resize, Rotate and Reflect Extension, called RandR for short,
brings the ability to resize, rotate and reflect the root window of a
screen. It is based on the X Resize and Rotate Extension as specified
in the Proceedings of the 2001 Usenix Technical Conference [RANDR].
RandR as implemented and integrated into the X server differs in
one substantial fashion from the design discussed in that paper: that
is, RandR 1.0 does not implement the depth switching described in that
document, and the support described for that in the protocol in that
document and in the implementation has been removed from the
protocol described here, as it has been overtaken by events.
These events include:
► Modern toolkits (in this case, GTK+ 2.x) have progressed to the point
of implementing migration between screens of arbitrary depths
► The continued advance of Moore's law has made limited amounts of VRAM
less of an issue, reducing the pressure to implement depth switching
on laptops or desktop systems
► The continued decline of legacy toolkits whose design would have
required depth switching to support migration
► The lack of depth switching implementation experience in the
intervening time, due to events beyond our control
Additionally, the requirement to support depth switching might
complicate other re-engineering of the device independent part of the
X server that is currently being contemplated.
Rather than further delaying RandR's widespread deployment for a feature
long wanted by the community (resizing of screens, particularly on laptops),
or the deployment of a protocol design that might be flawed due to lack of
implementation experience, we decided to remove depth switching from the
protocol. It may be implemented at a later time if resources and
interests permit as a revision to the protocol described here, which will
remain a stable base for applications. The protocol described here has been
implemented in the main X.org server, and more fully in the hw/kdrive
implementation in the distribution, which fully implements resizing,
rotation and reflection.
1.2 Introduction to version 1.2 of the extension
One of the significant limitations found in version 1.1 of the RandR
protocol was the inability to deal with the Xinerama model where multiple
monitors display portions of a common underlying screen. In this environment,
zero or more video outputs are associated with each CRT controller which
defines both a set of video timings and a 'viewport' within the larger
screen. This viewport is independent of the overall size of the screen, and
may be located anywhere within the screen.
The effect is to decouple the reported size of the screen from the size
presented by each video output, and to permit multiple outputs to present
information for a single screen.
To extend RandR for this model, we separate out the output, CRTC and screen
configuration information and permit them to be configured separately. For
compatibility with the 1.1 version of the protocol, we make the 1.1 requests
simultaneously affect both the screen and the (presumably sole) CRTC and
output. The set of available outputs are presented with UTF-8 encoded names
and may be connected to CRTCs as permitted by the underlying hardware. CRTC
configuration is now done with full mode information instead of just size
and refresh rate, and these modes have names. These names also use UTF-8
encoding. New modes may also be added by the user.
Additional requests and events are provided for this new functionality.
┌────────────────────────────────┬──────────┐
┏━━━━━━━┳───────────────┐ ╔════════╗ ╔════════╗
┃ 1 ┃ │ ║ A ║ ║ B ║
┃ ┏━━━╋━━━━━━━━━━━━━━━┫ ║ ║ ║ ║
┣━━━╋━━━┛ ┃ ╚════════╝ ╚════════╝
│ ┃ 2 ┃─────────────────┐
│ ┃ ┃ ╔═══════════════════╗
│ ┃ ┃ ║ ║
│ ┗━━━━━━━━━━━━━━━━━━━┫ ║ C ║
└───────────────────────┘ ║ ║
┌──────┐ ┏━━━━┓ ╔══════╗ ║ ║
│screen│ ┃CRTC┃ ║output║ ╚═══════════════════╝
└──────┘ ┗━━━━┛ ╚══════╝
In this picture, the screen is covered (incompletely) by two CRTCs. CRTC1
is connected to two outputs, A and B. CRTC2 is connected to output C.
Outputs A and B will present exactly the same region of the screen using
the same mode line. Output C will present a different (larger) region of
the screen using a different mode line.
RandR provides information about each available CRTC and output; the
connection between CRTC and output is under application control, although
the hardware will probably impose restrictions on the possible
configurations. The protocol doesn't try to describe these restrictions,
instead it provides a mechanism to find out what combinations are supported.
1.3 Introduction to version 1.3 of the extension
Version 1.3 builds on the changes made with version 1.2 and adds some new
capabilities without fundmentally changing the extension again. The
following features are added in this version:
• Projective Transforms. The implementation work for general rotation
support made it trivial to add full projective transformations. These
can be used to scale the screen up/down as well as perform projector
keystone correct or other effects.
• Panning. It was removed with RandR 1.2 because the old semantics didn't
fit any longer. With RandR 1.3 panning can be specified per crtc.
1.4 Introduction to version 1.4 of the extension
Version 1.4 adds a couple more capabilities to further expose the
underlying hardware to clients
• Per-crtc pixmaps. This provides for multiple scan-out buffers
which applications can create and assign to arbitrary collections
of crtcs.
• Sprite position and image transforms. These provide a projective
transform for both the hot spot location and the sprite image
itself for each CRTC.
• RRSetCrtcConfigs request. This supplies a set of
crtc configurations to the server that must be applied together
or not at all. This can reduce screen flicker while also
providing the server a complete configuration for appropriate
resource management.
The first two additions, per-crtc pixmaps and sprite transforms are
designed to solve two problems:
1) Screen transforms. The software transform code in the X server
uses a shadow frame buffer, adding another copy to every graphics
operation. Worse, the server has no idea about when clients are
done drawing a frame, so the user gets additional latency and
judder.
The goal is to move this operation out to the compositing manager
which already deals with an extra copy of the frame buffer for
many operations. Have the compositing manager create and draw to a
separate pixmap for scanout. It can perform whatever transforms
are required to get the image in the right orientation for the
user.
2) Hardware scanout engine size limits. With a single scanout buffer
for the entire screen, it's possible for the user to ask for a
configuration which requires that scanout buffer to be larger than
the hardware is capable of scanning out from. Again, having the
compositing manager create a pixmap for each CRTC will allow for
any configuration where monitor position within the virtual space
isn't limited by the scanout limits.
In both of these cases, the Sprite transforms are necessary to ensure
that the sprite appears at the desired spot on each CRTC and with the
right shape.
1.99 Acknowledgements
Our thanks to the contributors to the design found on the xpert mailing
list, in particular:
Alan Hourihane for work on the early implementation
Andrew C. Aitchison for help with the XFree86 DDX implementation
Andy Ritger for early questions about how mergefb/Xinerama work with RandR
Carl Worth for editing the specification and Usenix paper
David Dawes for XFree86 DDX integration work
Thomas Winischhofer for the hardware-accelerated SiS rotation implementation
Matthew Tippett and Kevin Martin for splitting outputs and CRTCs to more
fully expose what video hardware can do
❧❧❧❧❧❧❧❧❧❧❧
2. Screen change model
Screens may change dynamically, either under control of this extension, or
due to external events. Examples include: monitors being swapped, pressing a
button to switch from internal display to an external monitor on a laptop,
or, eventually, the hotplug of a display card entirely on busses such as
Cardbus or Express Card which permit hot-swap (which will require other work
in addition to this extension).
Since the screen configuration is dynamic and asynchronous to the client and
may change at any time RandR provides mechanisms to ensure that your clients
view is up to date with the configuration possibilities of the moment and
enforces applications that wish to control the configuration to prove that
their information is up to date before honoring requests to change the
screen configuration (by requiring a timestamp on the request).
Interested applications are notified whenever the screen configuration
changes, providing the current size of the screen and subpixel order (see
the Render extension [RENDER]), to enable proper rendering of subpixel
decimated client text to continue, along with a time stamp of the
configuration change. A client must refresh its knowledge of the screen
configuration before attempting to change the configuration after a
notification, or the request will fail.
To avoid multiplicative explosion between orientation, reflection and sizes,
the sizes are only those sizes in the normal (0) rotation.
Rotation and reflection and how they interact can be confusing. In Randr,
the coordinate system is rotated in a counter-clockwise direction relative
to the normal orientation. Reflection is along the window system coordinate
system, not the physical screen X and Y axis, so that rotation and
reflection do not interact. The other way to consider reflection is to is
specified in the "normal" orientation, before rotation, if you find the
other way confusing.
We expect that most clients and toolkits will be oblivious to changes to the
screen structure, as they generally use the values in the connections Display
structure directly. By toolkits updating the values on the fly, we believe
pop-up menus and other pop up windows will position themselves correctly in
the face of screen configuration changes (the issue is ensuring that pop-ups
are visible on the reconfigured screen).
❧❧❧❧❧❧❧❧❧❧❧
3. Data Types
The subpixel order is shared with the Render extension, and is documented
there. The only datatype defined is the screen size, defined in the normal
(0 degree) orientation.
❧❧❧❧❧❧❧❧❧❧❧
4. Errors
Errors are sent using core X error reports.
Output
A value for an OUTPUT argument does not name a defined OUTPUT.
CRTC
A value for a CRTC argument does not name a defined CRTC.
Mode
A value for a MODE argument does not name a defined MODE.
❧❧❧❧❧❧❧❧❧❧❧
5. Protocol Types
RRCONFIGSTATUS { Success
InvalidConfigTime
InvalidTime
Failed }
A value of type RRCONFIGSTATUS returned when manipulating the output
configuration or querying information from the server that has some
time-dependency.
InvalidConfigTime indicates that the supplied configuration
timestamp does not match the current X server configuration
timestamp. Usually this means that the output configuration has
changed since the timestamp was received by the application.
InvalidTime indicates that the supplied output reconfiguration time
is earlier than the most recent output reconfiguration request.
Generally this indicates that another application has reconfigured
the output using a later timestamp.
Failed is returned whenever the operation is unsuccessful for some
other reason. This generally indicates that the requested output
configuration is unsupported by the hardware. The goal is to make
these limitations expressed by the protocol, but when that isn't
possible it is correct to return this error value. If, as a
implentor, you find this error code required, please submit the
hardware constraints that exist so that a future version of the
extension can correctly capture the configuration constraints in
your system.
ROTATION { Rotate_0
Rotate_90
Rotate_180
Rotate_270
Reflect_X
Reflect_Y }
These values are used both to indicate a set of allowed rotations
and reflections as well as to indicate a specific rotation and
reflection combination.
RRSELECTMASK { RRScreenChangeNotifyMask
RRCrtcChangeNotifyMask (New in version 1.2)
RROutputChangeNotifyMask (New in version 1.2)
RROutputPropertyNotifyMask (New in version 1.2) }
SIZEID { CARD16 }
MODE { XID or None }
CRTC { XID }
OUTPUT { XID }
CONNECTION { Connected, Disconnected, UnknownConnection }
This value provides an indication of whether an output is actually
connected to a monitor or other presentation device.
SUBPIXELORDER { SubPixelUnknown The subpixel order uses the Render
SubPixelHorizontalRGB extensions definitions; they are here
SubPixelHorizontalBGR only for convenience.
SubPixelVerticalRGB
SubPixelVerticalBGR
SubPixelNone }
SCREENSIZE { widthInPixels, heightInPixels: CARD16
widthInMillimeters, heightInMillimeters: CARD16 }
MODEFLAG { HSyncPositive
HSyncNegative
VSyncPositive
VSyncNegative
Interlace
DoubleScan
CSync
CSyncPositive
CSyncNegative
HSkewPresent
BCast
PixelMultiplex
DoubleClock
ClockDivideBy2 }
MODEINFO { id: MODE
name: STRING
width, height: CARD16
dotClock: CARD32
hSyncStart, hSyncEnd, hTotal, hSkew: CARD16
vSyncStart, vSyncEnd, vTotal: CARD16
modeFlags: SETofMODEFLAG }
REFRESH { rates: LISTofCARD16 }
❧❧❧❧❧❧❧❧❧❧❧
5.4. Protocol Types added in version 1.4 of the extension
SCANOUTPIXMAPINFO { format: PICTFORMAT
maxWidth, maxHeight: CARD16
rotations: SETofROTATION }
'format' is the format of the pixels within the scanout
pixmap. Only 'Direct' formats are supported, this will never
be an 'Indexed' format.
'maxWidth' and 'maxHeight' define the largest supported
scanout pixmap. There is no minimum size; scanout pixmaps down
to 1x1 may be created.
'rotations' lists the set of rotations which can be provided
without additional latency or memory usage within the
environment. This typically means that they are supported
directly by the hardware. It is expected that a compositing
manager will perform other transforms as a part of the
compositing process in conjunction with the sprite transforms
described in this extension.
SCREENFLAG { SetScreenPixmapSize
SetScreenSize
SetScreenSizeInMillimeters
SetScreenCrtcs }
CRTCFLAG { SetCrtcPosition
SetCrtcMode
SetCrtcRotation
SetCrtcOutputs
SetCrtcSpritePositionTransform
SetCrtcSpriteImageTransform
SetCrtcPixmap
SetCrtcPixmapPosition }
CRTCCONFIG { crtc: CRTC
set: SETofCRTCFLAG
x, y: INT16
mode: MODE
rotation: ROTATION
sprite-position-transform: TRANSFORM
sprite-image-transform: TRANSFORM
outputs: LISTofOUTPUT
pixmap: PIXMAP or None
pixmap-x, pixmap-y: INT16 }
If 'set' includes SetCrtcSpritePositionTransform, then
sprite-position-transform is used as in the
RRSetCrtcSpriteTransform request position-transform parameter.
If 'set' includes SetCrtcSpriteImageTransform, then
sprite-image-transform is used as in the
RRSetCrtcSpriteTransform request image-transform parameter.
If 'set' includes SetCrtcPixmap, then 'pixmap' specifies the
origin of the pixel data to be presented on 'crtc'. If
'pixmap' is None, then data will be presented from the screen
pixmap.
If 'set' includes SetCrtcPixmapPosition, then 'pixmap-x' and
'pixmap-y' specify the origin of the scanout data within the
pixmap, the area from that location to pixmap-x +
width-of(mode), pixmap-y + height-of(mode) is what will be
seen on the connected outputs.
If 'set' includes SetCrtcPixmap, then 'pixmap' must specify a
scanout pixmap as created by RRCreateScanoutPixmap or
None. Otherwise a Match error results. Furthermore:
* 'pixmap' must be at least as large as the area to be
scanned out, or a Match error results.
* If 'pixmap' is destroyed while still being used as a
scanout pixmap, then the associated CRTC will have its
scanout pixmap set back to None, the CRTC origin set back
to 0,0 (to make sure it fits) and the screen pixmap width
and height increased to be at least as big as the current
CRTC mode.
* Future crtc changes that do not change the scanout pixmap
will cause an existing scanout pixmap to be resized to be
large enough to hold the new mode at the then-current
pixmap-x/pixmap-y location.
If 'set' includes SetCrtcRotation then:
* Any new or existing scanout pixmap must have had the
specified 'rotation' included as a part of its creation
parameters, or a Match error results.
* If no scanout pixmap is in use, then the crtc must support
'rotation' else a Value error results.
❧❧❧❧❧❧❧❧❧❧❧
6. Extension Initialization
The name of this extension is "RANDR".
┌───
RRQueryVersion
client-major-version: CARD32
client-minor-version: CARD32
▶
major-version: CARD32
minor-version: CARD32
└───
The client sends the highest supported version to the server
and the server sends the highest version it supports, but no
higher than the requested version. Major versions changes can
introduce incompatibilities in existing functionality, minor
version changes introduce only backward compatible changes.
It is the clients responsibility to ensure that the server
supports a version which is compatible with its expectations.
❧❧❧❧❧❧❧❧❧❧❧
7. Extension Requests
┌───
RRSelectInput
window: WINDOW
enable: SETofRRSELECTMASK
└───
Errors: Window, Value
If 'enable' is RRScreenChangeNotifyMask, RRScreenChangeNotify events
will be sent when the screen configuration changes, either from
this protocol extension, or due to detected external screen
configuration changes. RRScreenChangeNotify may also be sent when
this request executes if the screen configuration has changed since
the client connected, to avoid race conditions.
New for version 1.2:
If 'enable' contains RRCrtcChangeMask, RRCrtcChangeNotify events
will be sent when a the configuration for a CRTC associated with the
screen changes, either through this protocol extension or due to
detected external changes. RRCrtcChangeNotify may also be sent when
this request executes if the CRTC configuration has changed since
the client connected, to avoid race conditions.
If 'enable' contains RROutputChangeMask, RROutputChangeNotify events
will be sent when a the configuration for an output associated with
the screen changes, either through this protocol extension or due to
detected external changes. RROutputChangeNotify may also be sent
when this request executes if the output configuration has changed
since the client connected, to avoid race conditions.
If 'enable' contains RROutputPropertyNotifyMask,
RROutputPropertyNotify events will be sent when properties change on
this output.
┌───
RRSetScreenConfig
window: WINDOW
timestamp: TIMESTAMP
config-timestamp: TIMESTAMP
size-id: SIZEID
rotation: ROTATION
rate: CARD16
▶
status: RRCONFIGSTATUS
new-timestamp: TIMESTAMP
config-timestamp: TIMESTAMP
root: WINDOW
subpixelOrder: SUBPIXELORDER
└───
Errors: Value, Match
If 'timestamp' is less than the time when the configuration was last
successfully set, the request is ignored and InvalidTime returned in
status.
If 'config-timestamp' is not equal to when the server's screen
configurations last changed, the request is ignored and
InvalidConfigTime returned in status. This could occur if the
screen changed since you last made a RRGetScreenInfo request,
perhaps by a different piece of display hardware being installed.
Rather than allowing an incorrect call to be executed based on stale
data, the server will ignore the request.
'rate' contains the desired refresh rate. If it is zero, the server
selects an appropriate rate.
This request may fail for other indeterminate reasons, in which case
'status' will be set to Failed and no configuration change will be
made.
This request sets the screen to the specified size, rate, rotation
and reflection.
When this request succeeds, 'status' contains Success and the
requested changes to configuration will have been made.
'new-time-stamp' contains the time at which this request was
executed.
'config-timestamp' contains the time when the possible screen
configurations were last changed.
'root' contains the root window for the screen indicated by the
window.
'subpixelOrder' contains the resulting subpixel order of the screen
to allow correct subpixel rendering.
Value errors are generated when 'rotation', 'rate' or 'size-id'
are invalid.
┌───
RRGetScreenInfo
window: WINDOW
▶
rotations: SETofROTATION
root: WINDOW
timestamp: TIMESTAMP
config-timestamp: TIMESTAMP
size-id: SIZEID
rotation: ROTATION
rate: CARD16
sizes: LISTofSCREENSIZE
refresh: LISTofREFRESH
└───
Errors: Window
RRGetScreenInfo returns information about the current and available
configurations for the screen associated with 'window'.
'rotations' contains the set of rotations and reflections supported
by the screen.
'root' is the root window of the screen.
'config-timestamp' indicates when the screen configuration
information last changed: requests to set the screen will fail
unless the timestamp indicates that the information the client
is using is up to date, to ensure clients can be well behaved
in the face of race conditions.
'timestamp' indicates when the configuration was last set.
'size-id' indicates which size is active.
'rate' is the current refresh rate. This is zero when the refresh
rate is unknown or on devices for which refresh is not relevant.
'sizes' is the list of possible frame buffer sizes (at the normal
orientation. Each size indicates both the linear physical size of
the screen and the pixel size.
'refresh' is the list of refresh rates for each size. Each element
of 'sizes' has a corresponding element in 'refresh'. An empty list
indicates no known rates, or a device for which refresh is not
relevant.
The default size of the screen (the size that would become the
current size when the server resets) is the first size in the
list.
7.1. Extension Requests added in version 1.2 of the extension
As introduced above, version 1.2 of the extension splits the screen size
from the crtc and output configuration, permitting the subset of the screen
presented by multiple outputs to be configured. As a separate notion, the
size of the screen itself may be arbitrarily configured within a defined
range. As crtcs and outputs are added and removed from the system, the set
returned by the extension will change so that applications can detect
dynamic changes in the display environment.
┌───
RRGetScreenSizeRange
window: WINDOW
▶
CARD16 minWidth, minHeight
CARD16 maxWidth, maxHeight
└───
Errors: Window
Returns the range of possible screen sizes. The screen may be set to
any size within this range.
┌───
RRSetScreenSize
window: WINDOW
width: CARD16
height: CARD16
width-in-millimeters: CARD32
height-in-millimeters: CARD32
└───
Errors: Window, Match, Value
Sets the screen to the specified size. 'width' and 'height' must be
within the range allowed by GetScreenSizeRanges, otherwise a Value
error results. All active monitors must be configured to display a
subset of the specified size, else a Match error results.
'width-in-millimeters' and 'height-in-millimeters' can be set to
reflect the physical size of the screen reported both through this
extension and the core protocol. They must be non-zero, or Value
error results.
If panning is enabled, the width and height of the panning and the
tracking areas are adapted to the new size and clamped afterwards.
Disabled panning axes remain disabled.
Panning borders are disabled if their requirements are no longer met
(see RRSetPanning).
┌───
RRGetScreenResources
window: WINDOW
▶
timestamp: TIMESTAMP
config-timestamp: TIMESTAMP
crtcs: LISTofCRTC
outputs: LISTofOUTPUT
modes: LISTofMODEINFO
└───
Errors: Window
RRGetScreenResources returns the list of outputs and crtcs connected
to the screen associated with 'window'.
'timestamp' indicates when the configuration was last set.
'config-timestamp' indicates when the configuration information last
changed. Requests to configure the output will fail unless the
timestamp indicates that the information the client is using is up
to date, to ensure clients can be well behaved in the face of race
conditions.
'crtcs' contains the list of CRTCs associated with the screen.
'outputs' contains the list of outputs associated with the screen.
'modes' contains the list of modes associated with the screen
This request explicitly asks the server to ensure that the
configuration data is up-to-date wrt the hardware. If that requires
polling, this is when such polling would take place. If the
current configuration is all that's required, use
RRGetScreenResourcesCurrent instead.
┌───
RRGetOutputInfo
output: OUTPUT
config-timestamp: TIMESTAMP
▶
status: RRCONFIGSTATUS
timestamp: TIMESTAMP
crtc: CRTC
name: STRING
connection: CONNECTION
subpixel-order: SUBPIXELORDER
widthInMillimeters, heightInMillimeters: CARD32
crtcs: LISTofCRTC
clones: LISTofOUTPUT
modes: LISTofMODE
num-preferred: CARD16
└───
Errors: Output
RRGetOutputInfo returns information about the current and available
configurations 'output'.
If 'config-timestamp' does not match the current configuration
timestamp (as returned by RRGetScreenResources), 'status' is set to
InvalidConfigTime and the remaining reply data is empty. Otherwise,
'status' is set to Success.
'timestamp' indicates when the configuration was last set.
'crtc' is the current source CRTC for video data, or Disabled if the
output is not connected to any CRTC.
'name' is a UTF-8 encoded string designed to be presented to the
user to indicate which output this is. E.g. "S-Video" or "DVI".
'connection' indicates whether the hardware was able to detect a
device connected to this output. If the hardware cannot determine
whether something is connected, it will set this to
UnknownConnection.
'subpixel-order' contains the resulting subpixel order of the
connected device to allow correct subpixel rendering.
'widthInMillimeters' and 'heightInMillimeters' report the physical
size of the displayed area. If unknown, or not really fixed (e.g.,
for a projector), these values are both zero.
'crtcs' is the list of CRTCs that this output may be connected to.
Attempting to connect this output to a different CRTC results in a
Match error.
'clones' is the list of outputs which may be simultaneously
connected to the same CRTC along with this output. Attempting to
connect this output with an output not in the 'clones' list
results in a Match error.
'modes' is the list of modes supported by this output. Attempting to
connect this output to a CRTC not using one of these modes results
in a Match error.
The first 'num-preferred' modes in 'modes' are preferred by the
monitor in some way; for fixed-pixel devices, this would generally
indicate which modes match the resolution of the output device.
┌───
RRListOutputProperties
output:OUTPUT
▶
atoms: LISTof ATOM
└───
Errors: Output
This request returns the atoms of properties currently defined on
the output.
┌───
RRQueryOutputProperty
output: OUTPUT
property: ATOM
▶
pending: BOOL
range: BOOL
immutable: BOOL
valid-values: LISTofINT32
└───
Errors: Name, Atom, Output
If the specified property does not exist for the specified output,
then a Name error is returned.
If 'pending' is TRUE, changes made to property values with
RRChangeOutputProperty will be saved in the pending property value
and be automatically copied to the current value on the next
RRSetCrtcConfig request involving the named output. If 'pending' is
FALSE, changes are copied immediately.
If 'range' is TRUE, then the valid-values list will contain
precisely two values indicating the minimum and maximum allowed
values. If 'range' is FALSE, then the valid-values list will contain
the list of possible values; attempts to set other values will
result in a Value error.
If 'immutable' is TRUE, then the property configuration cannot be
changed by clients. Immutable properties are interpreted by the X
server.
┌───
RRConfigureOutputProperty
output: OUTPUT
property: ATOM
pending: BOOL
range: BOOL
valid-values: LISTofINT32
└───
Errors: Access, Name, Atom, Output
If the specified property is 'immutable', an Access error is
returned.
Otherwise, the configuration of the specified property is changed to
the values provided in this request.
If the specified property does not exist for the specified output,
it is created with an empty value and None type.
┌───
RRChangeOutputProperty
output: OUTPUT
property, type: ATOM
format: {8, 16, 32}
mode: { Replace, Prepend, Append }
data: LISTofINT8 or LISTofINT16 or LISTofINT32
└───
Errors: Alloc, Atom, Match, Value, Output
This request alters the value of the property for the specified
output. If the property is marked as a 'pending' property, only the
pending value of the property is changed. Otherwise, changes are
reflected in both the pending and current values of the property.
The type is uninterpreted by the server. The format specifies
whether the data should be viewed as a list of 8-bit, 16-bit, or
32-bit quantities so that the server can correctly byte-swap as
necessary.
If the mode is Replace, the previous property value is discarded.
If the mode is Prepend or Append, then the type and format must
match the existing property value (or a Match error results). If
the property is undefined, it is treated as defined with the correct
type and format with zero-length data.
For Prepend, the data is tacked on to the beginning of the existing
data, and for Append, it is tacked on to the end of the existing data.
This request generates a OutputPropertyNotify
The lifetime of a property is not tied to the storing client.
Properties remain until explicitly deleted, until the output is
destroyed, or until server reset (see section 10).
The maximum size of a property is server-dependent and may vary
dynamically.
┌───
RRDeleteOutputProperty
output: OUTPUT
property: ATOM
└───
Errors: Atom, Output
This request deletes the property from the specified window if the
property exists and generates a OutputPropertyNotify event unless
the property does not exist.
┌───
RRGetOutputProperty
output: OUTPUT
property: ATOM
type: ATOM or AnyPropertyType
long-offset, long-length: CARD32
delete: BOOL
pending: BOOL
▶
type: ATOM or None
format: {0, 8, 16, 32}
bytes-after: CARD32
value: LISTofINT8 or LISTofINT16 or LISTofINT32
└───
Errors: Atom, Value, Output
If the specified property does not exist for the specified output,
then the return type is None, the format and bytes-after are zero,
and the value is empty. The delete argument is ignored in this
case.
If the specified property exists but its type does not match the
specified type, then the return type is the actual type of the
property, the format is the actual format of the property (never
zero), the bytes-after is the length of the property in bytes (even
if the format is 16 or 32), and the value is empty. The delete
argument is ignored in this case.
If the specified property exists and either AnyPropertyType is
specified or the specified type matches the actual type of the
property, then the return type is the actual type of the property,
the format is the actual format of the property (never zero), and
the bytes-after and value are as follows, given:
N = actual length of the stored property in bytes
(even if the format is 16 or 32)
I = 4 × offset
T = N - I
L = MINIMUM(T, 4 × long-length)
A = N - (I + L)
If 'pending' is true, and if the property holds a pending value,
then the value returned will be the pending value of the property
rather than the current value. The returned value starts at byte
index I in the property (indexing from 0), and its length in bytes
is L. However, it is a Value error if long-offset is given such
that L is negative. The value of bytes-after is A, giving the
number of trailing unread bytes in the stored property. If delete
is True and the bytes-after is zero, the property is also deleted
from the output, and a RROutputPropertyNotify event is generated.
┌───
RRCreateMode
window: WINDOW
modeinfo: MODEINFO
▶
mode: MODE
└───
Errors: Window, Name, Value
'modeinfo' provides a new mode for outputs on the screen
associated with 'window'. If the name of 'modeinfo' names an
existing mode, a Name error is returned. If some parameter of the
mode is not valid in some other way, a Value error is returned.
The returned 'mode' provides the id for the mode.
┌───
RRDestroyMode
mode: MODE
└───
Errors: Mode, Access
The user-defined 'mode' is destroyed. 'mode' must name a mode
defined with RRCreateMode, else an Match error is returned. If
'mode' is in use by some CRTC or Output, then an Access error is
returned.
┌───
RRAddOutputMode
output: OUTPUT
mode: MODE
└───
Errors: Output, Mode, Match
'output' indicates which output is to be configured.
'mode' specifies which mode to add. If 'mode' is not valid for
'output', then a Match error is generated.
This request generates OutputChangeNotify events.
┌───
RRDeleteOutputMode
output: OUTPUT
mode: MODE
└───
Errors: Output, Mode
'output' indicates which output is to be configured.
'mode' specifies which mode to delete. 'mode' must have been added
with RRAddOutputMode, else an Access error is returned. 'mode' must
not be active, else a Match error is returned.
This request generates OutputChangeNotify events.
┌───
RRGetCrtcInfo
crtc: CRTC
config-timestamp: TIMESTAMP
▶
status: RRCONFIGSTATUS
timestamp: TIMESTAMP
x, y: INT16
width, height: CARD16
mode: MODE
rotation: ROTATION
outputs: LISTofOUTPUT
rotations: SETofROTATION
possible-outputs: LISTofOUTPUT
└───
Errors: Window
RRGetCrtcModes returns information about the current and available
configurations for the specified crtc connected to the screen
associated with 'window'.
If 'config-timestamp' does not match the current configuration
timestamp (as returned by RRGetScreenResources), 'status' is set to
InvalidConfigTime and the remaining reply data is empty. Otherwise,
'status' is set to Success.
'timestamp' indicates when the configuration was last set.
'x' and 'y' indicate the position of this CRTC within the screen
region. They will be set to 0 when the CRTC is disabled.
'width' and 'height' indicate the size of the area within the screen
presented by this CRTC. This may be different than the size of the
mode due to rotation. They will be set to 0 when the CRTC
is disabled.
'mode' indicates which mode is active, or None indicating that the
CRTC has been disabled and is not displaying the screen contents.
'rotation' indicates the active rotation. It is set to Rotate_0
when the CRTC is disabled.
'outputs' is the list of outputs currently connected to this CRTC
and is empty when the CRTC is disabled.
'rotations' contains the set of rotations and reflections supported
by the CRTC.
'possible-outputs' lists all of the outputs which may be connected
to this CRTC.
┌───
RRSetCrtcConfig
crtc: CRTC
timestamp: TIMESTAMP
config-timestamp: TIMESTAMP
x, y: INT16
mode: MODE
rotation: ROTATION
outputs: LISTofOUTPUT
▶
status: RRCONFIGSTATUS
new-timestamp: TIMESTAMP
└───
Errors: Value, Match
If 'timestamp' is less than the time when the configuration was last
successfully set, the request is ignored and InvalidTime returned in
status.
If 'config-timestamp' is not equal to when the monitor's
configuration last changed, the request is ignored and
InvalidConfigTime returned in status. This could occur if the
monitor changed since you last made a RRGetScreenInfo request,
perhaps by a different monitor being connected to the machine.
Rather than allowing an incorrect call to be executed based on stale
data, the server will ignore the request.
'x' and 'y' contain the desired location within the screen for this
monitor's content. 'x' and 'y' must be within the screen size, else
a Value error results.
'mode' is either the desired mode or None indicating the CRTC should
be disabled. If 'mode' is not one of these values, a Value
error results. 'mode' must be valid for all of the configured outputs,
else a Match error.
'rotation' contains the desired rotation along with which
reflections should be enabled. The rotation and reflection values
must be among those allowed for this monitor, else a Value error
results.
'outputs' contains the set of outputs that this CRTC should be
connected to. The set must be among the list of acceptable output
sets for this CRTC or a Match error results.
If 'mode' is None, then 'outputs' must be empty, else a Match error
results. Conversely, if 'mode' is not None, then 'outputs' must not be
empty, else a Match error results.
This request may fail for other indeterminate reasons, in which case
'status' will be set to Failed and no configuration change will be
made.
This request sets the CRTC to the specified position, mode, rotation
and reflection. The entire area of the CRTC must fit within the
screen size, else a Match error results. As an example, rotating the
screen so that a single CRTC fills the entire screen before and
after may necessitate disabling the CRTC, resizing the screen,
then re-enabling the CRTC at the new configuration to avoid an
invalid intermediate configuration.
If panning is enabled, the width and height of the panning and the
tracking areas are clamped to the new mode size.
Disabled panning axes remain disabled.
Panning borders are disabled if their requirements are no longer met
(see RRSetPanning).
When this request succeeds, 'status' contains Success and the
requested changes to configuration will have been made.
'new-time-stamp' contains the time at which this request was
executed.
┌───
RRGetCrtcGammaSize
crtc: CRTC
▶
size: CARD16
└───
Errors: Crtc
This request returns the size of the gamma ramps used by 'crtc'.
┌───
RRGetCrtcGamma
crtc: CRTC
▶
red: LISTofCARD16
green: LISTofCARD16
blue: LISTofCARD16
└───
Errors: Crtc
This request returns the currently set gamma ramps for 'crtc'. All
three lists will be the size returned by the RRGetCrtcGammaSize
request.
┌───
RRSetCrtcGamma
crtc: CRTC
red: LISTofCARD16
green: LISTofCARD16
blue: LISTofCARD16
└───
Errors: Crtc, Match
This request sets the gamma ramps for 'crtc'. All three lists
must be the size returned by RRGetCrtcGammaSize else a Value error
results.
7.2. Extension Requests added in version 1.3 of the extension
┌───
RRGetScreenResourcesCurrent
window: WINDOW
▶
timestamp: TIMESTAMP
config-timestamp: TIMESTAMP
crtcs: LISTofCRTC
outputs: LISTofOUTPUT
modes: LISTofMODEINFO
└───
Errors: Window
RRGetScreenResourcesCurrent returns the list of outputs and crtcs
connected to the screen associated with 'window'.
'timestamp' indicates when the configuration was last set.
'config-timestamp' indicates when the configuration information last
changed. Requests to configure the output will fail unless the
timestamp indicates that the information the client is using is up
to date, to ensure clients can be well behaved in the face of race
conditions.
'crtcs' contains the list of CRTCs associated with the screen.
'outputs' contains the list of outputs associated with the screen.
'modes' contains the list of modes associated with the screen.
Unlike RRGetScreenResources, this merely returns the current
configuration, and does not poll for hardware changes.
┌───
RRSetCrtcTransform
crtc: CRTC
transform: TRANSFORM
filter: STRING8
values: LISTofFIXED
└───
Errors: Crtc, Match
This request provides a mechanism that is more general than the
existing rotation and reflection values for describing the
transformation from frame buffer image to crtc presentation.
'transform' is a full 2D projective transformation from screen
coordinate space to crtc coordinate space. This transformation is
applied before the rotation and reflection values to compute the
complete transform.
'filter' and 'values' specify a Render filter that may be used by the
server when transforming data from frame buffer to crtc.
This request sets the transform to be used at the next
RRSetCrtcConfig request execution; it does not cause any change to
occur in the current configuration.
When a non-identity transformation is in use, the rectangle returned
by RRGetCrtcInfo defines the bounding rectangle of the screen that is
projected to the crtc. It is this projected rectangle which must be
within the area of the screen when the mode is set.
┌───
RRGetCrtcTransform
crtc: CRTC
▶
pending-transform: TRANSFORM
pending-filter: STRING8
pending-values: LISTofFIXED
current-transform: TRANSFORM
current-filter: STRING8
current-values: LISTofFIXED
└───
This request returns the pending and current transforms for the
specified CRTC. The pending transform will be the same as the current
transform if no new pending transform has been set since the last call
to RRSetCrtcConfig.
┌───
RRGetPanning
crtc: CRTC
▶
status: RRCONFIGSTATUS
timestamp: TIMESTAMP
left, top, width, height: CARD16
track_left, track_top, track_width, track_height: CARD16
border_left, border_top, border_right, border_bottom: INT16
└───
Errors: Crtc
Version 1.3 adds panning support again. If multiple crtcs are active
the panning behavior can be defined per crtc individually.
RRGetPanning returns information about the currently set panning
configuration for the specified crtc. If the CRTC does not support
panning, all fields (except timestamp) will be 0.
'timestamp' indicates when the configuration was last set.
All other entries are explained for RRSetPanning.
┌───
RRSetPanning
crtc: CRTC
timestamp: TIMESTAMP
left, top, width, height: CARD16
track_left, track_top, track_width, track_height: CARD16
border_left, border_top, border_right, border_bottom: INT16
▶
status: RRCONFIGSTATUS
new-timestamp: TIMESTAMP
└───
Errors: Crtc, Match
This request sets the panning parameters. As soon as panning is
enabled, the CRTC position can change with every pointer move.
RRCrtcChangeNotify events are sent to the clients requesting those.
If 'timestamp' is less than the time when the configuration was last
successfully set, the request is ignored and InvalidTime returned in
status.
┌──┳━━━━━━━━━━━━━━┳─────┬ ─ ─ ─ ─ ─ ┐
│ ┃ CRTC ┃ │
│ ┃ ┃ │ │
│ ┃ X┃→ │
│ ┃ ┃ │ │ framebuffer
│ ┗━━━━━━━━━━━━━━┛ │
│ │ │
│panning area │
└───────────────────────┴ ─ ─ ─ ─ ─ ┘
'left', 'top', 'width', and 'height' contain the total panning area
for this CRTC. 'width' has to be larger than or equal to the CRTC's
width or 0, and 'left'+'width' must be within the screen size, else a
Match error results. Equivalent restrictions for the height exist.
'width' or 'height' set to 0 indicate that panning should be disabled
on the according axis. Setting 'width'/'height' to the CRTC's
width/height will disable panning on the X/Y axis as well, but
RRSetScreenSize will silently enable panning if the screen size is
increased. This does not happen if set to 0.
┌────────┳━━━━━━━━━━━━━━┳ ─ ─ ─ ─ ─ ┐
│ ┃ CRTC ┃
│ ┃ ┃ │
│ ┃ ┃
│ ┃ ┃ │ tracking area
│ ┗━━━━━━━━━━━━━━┫ X
│ ↓ │ ↓ │
│panning area │
└───────────────────────┴ ─ ─ ─ ─ ─ ┘
'track_left', 'track_top', 'track_width', and 'track_height' contain
the pointer area for which the panning region is updated. For normal
use cases it should enclose the panning area minus borders, and is
typically set to either the panning area minus borders, or to the
total screen size. If set to the total screen size, the CRTC will pan
in the remaining axis even if the pointer is outside the panning area
on a different CRTC, as shown in the figure above. If the pointer is
outside the tracking area, the CRTC will not pan. Zero can be used as
an alias for the total screen size.
┌──┳━━━━━━━━━━━━━━┳────────────┐
│ ┃ CRTC ┃ │
│ ┃ ┃ │
│ ┃ ┃→ │
│ ┃ X←→┃ │
│ ┃ border_right │
│ ┗━━━━━━━━━━━━━━┛ │
│ │
│panning area │
└──────────────────────────────┘
'border_left', 'border_top', 'border_right', and 'border_bottom'
define the distances from the CRTC borders that will activate panning
if the pointer hits them. If the borders are 0, the screen will pan
when the pointer hits the CRTC borders (behavior of pre-RandR Xserver
panning). If the borders are positive, the screen will pan when the
pointer gets close to the CRTC borders, if they are negative, the
screen will only pan when the pointer is already way past the CRTC
borders. Negative values might confuse users and disable panning to
the very edges of the screen. Thus they are discouraged.
border_left + border_right has to be lower or equal than the CRTC's
width, else a Match error results. An equivalent restriction for the
height exists.
Screen size changes update the panning and the tracking areas to the
new size. Both screen size changes and mode changes clamp these areas
to the current CRTC size. In these cases panning borders are disabled
if their requirements are no longer met.
When this request succeeds, 'status' contains Success and the
requested changes to configuration will have been made.
'new-time-stamp' contains the time at which this request was
executed.
┌───
RRSetOutputPrimary
window: WINDOW
output: OUTPUT
└───
Errors: Match, Output, Window
RRSetOutputPrimary marks 'output' as the primary output for the
screen with the same root window as 'window'. This output's CRTC
will be sorted to the front of the list in Xinerama and RANDR
geometry requests for the benefit of older applications. The
default primary output is None, and None is a legal value to pass
to RRSetOutputPrimary. This request is expected to be used by
desktop environments to mark the screen that should hold the primary
menu bar or panel.
As this changes the logical layout of the screen, ConfigureNotify
and RRScreenChangeNotify will be generated on the appropriate root
window when the primary output is changed by this call. This request
also generates RROutputChangeNotify events on the outputs that gained
and lost primary status.
If an output is disconnected asynchronously (eg. due to recabling),
the primary status does not change, but RROutputChangeNotify events
will be generated if the hardware is capable of detecting this;
clients are expected to reconfigure if appropriate.
If an output is deleted (eg. due to device hotplug), the server will
act as though None was passed to RRSetOutputPrimary, including
generating the appropriate events.
┌───
RRGetOutputPrimary
window: WINDOW
▶
output: OUTPUT
└───
Errors: Window
RRGetOutputPrimary returns the primary output for the screen.
❧❧❧❧❧❧❧❧❧❧❧
7.3. Extension Requests added in version 1.4 of the extension.
┌───
RRQueryScanoutPixmaps
window: WINDOW
▶
infos: LISTofSCANOUTPIXMAPINFO
└───
Errors: Window
This request returns information about the server support for
alternate scanout pixmaps. For each pictformat, there is a set
of rotations and a maximum supported size. The rotations here
are those provided by the scanout hardware itself, not by
software emulation.
┌───
RRCreateScanoutPixmap
pixmap: PIXMAP
drawable: DRAWABLE
width, height: CARD16
format: PICTFORMAT
rotations: SETofROTATION
└───
Errors: Drawable, Match, Value
Creates a pixmap which can subsequently be used as a scanout
buffer for the screen associated with 'drawable'. 'rotations'
is the set of rotation values which may be used with the
resulting scanout buffer when it is associated with a CRTC.
'format' must be one of the supported scanout formats, or a
Match error results.
'width' and 'height' must be within the supported range for
the specified format or a Value error results.
'rotations' must be a subset of those supported for the
specified format or a Match error results.
┌───
RRSetCrtcSpriteTransform
crtc: CRTC
position-transform: TRANSFORM
image-transform: TRANSFORM
└───
Sets the sprite transforms for the specified crtc, any sprites
presented on this crtc will have their positions transformed
by the position-transform matrix. Sprite images displayed on the crtc
will be transformed by the image-transform matrix.
┌───
RRGetCrtcSpriteTransform
crtc: CRTC
▶
position-transform: TRANSFORM
image-transform: TRANSFORM
└───
Gets the sprite transforms for the specified crtc.
┌───
RRSetCrtcConfigs
drawable: DRAWABLE
set: SETofSCREENFLAG
screen-pixmap-width: CARD16
screen-pixmap-height: CARD16
screen-width: CARD16
screen-height: CARD16
width-in-millimeters: CARD32
height-in-millimeters: CARD32
configs: LISTofCRTCCONFIG
▶
status: RRCONFIGSTATUS
└───
Errors: Value, Match
This works much like RRSetScreenSize followed by a sequence of
RRSetCrtcConfig, except that the entire configuration can be set
in a single operation, either succeeding or failing without
any partial execution.
If 'set' includes 'SetScreenPixmapSize', then
'screen-pixmap-width' and 'screen-pixmap-height' specify the
new screen pixmap size.
If 'set' includes 'SetScreenSize', then 'screen-width' and
'screen-height' specify the new screen size.
If 'set' includes 'SetScreenSizeInMillimeters', then
'width-in-millimeters' and 'height-in-millimeters' specify
the new screen physical size.
If 'set' includes 'SetScreenCrtcs', then 'configs' includes
the list of new CRTC configurations.
In addition to the pre-1.4 semantics, this request adds the
ability to specific a scanout pixmap for each crtc, and
integrates the 1.4 sprite transform request as well.
❧❧❧❧❧❧❧❧❧❧❧
8. Extension Events
Clients MAY select for ConfigureNotify on the root window to be
informed of screen changes. This may be advantageous if all your
client needs to know is the size of the root window, as it avoids
round trips to set up the extension.
RRScreenChangeNotify is sent if RRSelectInput has requested it
whenever properties of the screen change, which may be due to external
factors, such as re-cabling a monitor, etc.
┌───
RRScreenChangeNotify
rotation: ROTATION; new rotation
sequenceNumber: CARD16 low 16 bits of request seq. number
timestamp: TIMESTAMP time screen was changed
configTimestamp: TIMESTAMP time config data was changed
root: WINDOW root window of screen
window: WINDOW window requesting notification
size-id: SIZEID index of new SCREENSIZE
subpixelOrder: SUBPIXELORDER order of subpixels
widthInPixels: CARD16 width in pixels of the new SCREENSIZE
heightInPixels: CARD16 height in pixels of the new SCREENSIZE
widthInMillimeters: CARD16 width in mm of the new SCREENSIZE
heightInMillimeters: CARD16 height in mm of the new SCREENSIZE
└───
This event is generated whenever the screen configuration is changed
and sent to requesting clients. 'timestamp' indicates when the
screen configuration was changed. 'configTimestamp' says when the
last time the configuration was changed. 'root' is the root of the
screen the change occurred on, 'window' is window selecting for this
event. 'size-id' contains the index of the current size.
This event is sent whenever the screen's configuration changes
or if a new screen configuration becomes available that was
not available in the past. In this case (config-timestamp in
the event not being equal to the config-timestamp returned in
the last call to RRGetScreenInfo), the client MUST call
RRGetScreenInfo to update its view of possible screen
configurations to have a correct view of possible screen
organizations.
Clients which select screen change notification events may be
sent an event immediately if the screen configuration was
changed between when they connected to the X server and
selected for notification. This is to prevent a common race
that might occur on log-in, where many applications start up
just at the time when a display manager or log in script might
be changing the screen size or configuration.
Note that the sizes in this event reflect the new SCREENSIZE and
thus will appear rotated by the 'rotation' parameter from the sizes
of the screen itself. In other words, when rotation is 90 or 270,
widthInPixels in this event will be the same as the height value
from a ConfigureNotify that reflects the same size change. This
will probably confuse developers.
8.1 Events added in version 1.2 of the RandR extension
┌───
RROutputChangeNotify:
timestamp: TIMESTAMP time screen was reconfigured
config-timestamp: TIMESTAMP time available config data was changed
window: WINDOW window requesting notification
output: OUTPUT output affected by change
crtc: CRTC connected CRTC or None
mode: MODE mode in use on CRTC or None
connection: CONNECTION connection status
└───
This event is generated whenever the available output configurations
have changed and is sent to requesting clients. 'timestamp'
indicates when the crtc configuration was changed by a client.
'config-timestamp' says when the last time the available
configurations changed. 'root' is the root of the screen the change
occurred on, 'window' is window selecting for this event. The
precise change can be detected by examining the new state of the
system.
┌───
RROutputPropertyNotify:
window: WINDOW window requesting notification
output: OUTPUT output affected by change
atom: ATOM affected property
time: TIMESTAMP time property was changed
subpixel-order: SUBPIXELORDER order of subpixels
state: { NewValue, Deleted } new property state
└───
This event is reported to clients selecting RROutputPropertyChange
on the window and is generated with state NewValue when a property
of the window is changed using RRChangeOutputProperty even when
adding zero-length data and when replacing all or part of a property
with identical data. It is generated with state Deleted when a
property of the window is deleted using either
RRDeleteOutputProperty or RRGetOutputProperty. The timestamp
indicates the server time when the property was changed.
┌───
RRCrtcChangeNotify
timestamp: TIMESTAMP time monitor was changed
window: WINDOW window requesting notification
crtc: CRTC CRTC which changed
mode: MODE new mode
rotation: ROTATION; new rotation
x: INT16 x position of CRTC within screen
y: INT16 y position of CRTC within screen
width: CARD16 width of new mode
height: CARD16 height of new mode
└───
This event is generated whenever the CRTC configuration is changed
and sent to requesting clients. 'timestamp' indicates when the
CRTC configuration was changed. 'window' is window selecting for this
event. 'mode' is the new mode, or None if the crtc is disabled.
'x' and 'y' mark the location in the screen where this CRTC
is reading data. 'width' and 'height' indicate the size of the
mode. 'x', 'y, 'width' and 'height' are all zero when 'mode' is None.
This event is sent whenever the monitor's configuration changes
or if a new monitor configuration becomes available that was
not available in the past. In this case, the client MUST call
RRGetCrtcModes to update its view of possible monitor
configurations to have a correct view of possible monitor
organizations.
Clients which select monitor change notification events may be
sent an event immediately if the monitor configuration was
changed between when they connected to the X server and
selected for notification. This is to prevent a common race
that might occur on log-in, where many applications start up
just at the time when a display manager or log in script might
be changing the monitor size or configuration.
❧❧❧❧❧❧❧❧❧❧❧
9. Properties
Properties are used for output specific parameters, and for announcing
static or rarely changing data. Announced data is typically
immutable. Properties are also used for evaluating new parameters
before adding them to the RandR protocol.
The following properties are hereby declared official, and drivers SHOULD
prefix driver specific properties with '_', unless they are planned to be
added to this specification. List values, that are not declared by the table
below, and will remain driver specific or are not planned to be added to this
specification, SHOULD be prefixed with "_" as well in order to avoid name
space or semantics clashes with future extensions of these values.
Beginning with version 1.3 of the RandR extension, certain properties
are mandatory and MUST be provided by implementations. Earlier
versions of the RandR extension MAY provide these properties as well,
as long as the semantics are not altered. Clients SHOULD fall back
gracefully to lower version functionality, though, if the driver
doesn't handle a mandatory property correctly.
9.1 Known properties
"Backlight" aka RR_PROPERTY_BACKLIGHT
Type: INTEGER
Format: 32
Num. items: 1
Flags: -
Range/List: 0-x (driver specific)
This property controls the brightness on laptop panels and equivalent
displays with a backlight controller. The driver specific maximum
value MUST turn the backlight to full brightness, 1 SHOULD turn the
backlight to minimum brightness, 0 SHOULD turn the backlight off.
"CloneList" aka RR_PROPERTY_CLONE_LIST
Type: ATOM
Format: 32
Num. items: 2*n
Flags: Immutable
Range/List: 0-
Some combinations of outputs on some cards cannot be served
independently from each other, because they are wired up to the same
encoder outputs.
This property lists all output + signal format pairs that are
driven together with this output, and thus can only be programmed in
clone mode with the same CRTC.
This property MUST be symmetric, but may change with changing signal
format. I.e. if the property for DVI-1/VGA specifies VGA-1/VGA to be
cloned, VGA-1/VGA has to list DVI-1/VGA as well.
Outputs / format pairs listed in this property MUST be included in the
CompatibilityList.
"CompatibilityList" aka RR_PROPERTY_COMPATIBILITY_LIST
Type: ATOM
Format: 32
Num items: 2*n
Flags: Immutable
Range/List: 0-
Some combinations of outputs on some cards cannot be served at all,
because the according encoder is only capable of driving one output at
a time.
This property lists all output + signal format pairs that can be
driven together with this output. NULL atoms specify any output / any
signal format, respectively.
This property MUST be symmetric, but may change with changing signal
format. I.e. if the property for DVI-1/TMDS specifies VGA-1/VGA to be
available, VGA-1/VGA has to list DVI-1/TMDS as well.
"ConnectorNumber" aka RR_PROPERTY_CONNECTOR_NUMBER
Type: INTEGER
Format: 32
Num items: 1
Flags: Immutable, Static
Range/List: 0-
Outputs that route their signal to the same connector MUST
have the same connector number. Outputs with the same
connector number MUST route their signal to the same
connector, except if it is 0, which indicates unknown
connectivity. 1 is called the primary connector, 2 the
secondary. 3 is typically a TV connector, but that is completely
driver / hardware dependent.
Outputs with the same connector number SHOULD have the same
connector type. Meaning and client behavior for mismatching
connector types is undefined at the moment.
"ConnectorType" aka RR_PROPERTY_CONNECTOR_TYPE
Type: ATOM
Format: 32
Num items: 1
Flags: Immutable, Static
Range/List: unknown VGA DVI DVI‐I DVI‐A DVI‐D HDMI Panel
TV TV-Composite TV-SVideo TV-Component
TV-SCART TV-C4 DisplayPort
Connector type, as far as known to the driver.
Values with dashes (TV‐Composite) describe more specific versions of
the base values (TV). The former SHOULD be used if the connector is
not capable of producing other signal formats. The later SHOULD be
used if the exact connector is unknown, or the connector is a
multi‐format connector that is not described otherwise. DVI, for
instance, SHOULD be handled like a DVI‐I connector, unless additional
information is available to the user agent. PANEL describes
laptop‐internal (normally LVDS) displays. TV, TV‐SCART, TV‐Component,
and TV‐C4 with signal format VGA are valid combinations and describe
RGB TV signals.
"EDID" aka RR_PROPERTY_RANDR_EDID
Type: INTEGER
Format: 8
Num items: n
Flags: Immutable
Range/List: -
Raw EDID data from the device attached to the according
output. Should include main EDID data and all extension
blocks. Previously known as EdidData.
"SignalFormat" aka RR_PROPERTY_SIGNAL_FORMAT
Type: ATOM
Format: 32
Num items: 1
Flags: -
Range/List: unknown VGA TMDS LVDS Composite Composite-PAL
Composite-NTSC Composite-SECAM SVideo
Component DisplayPort
Signal format / physical protocol format that is used for the
specified output. valid-values lists all possible formats on this
output, which SHOULD be a subset of the list above and MUST be static.
Values with dashes (Composite-PAL) describe more specific versions of
the base values (Composite) and SHOULD be used if known to the driver.
A driver MAY change this property of an output if the underlying
hardware indicates a protocol change (e.g. TV formats). Clients are
allowed to change the signal format in order to select a different
signal format (e.g. Composite etc.) or physical protocol (e.g. VGA or
TMDS on DVI-I).
Laptop panels SHOULD not be detected with this property, but rather by
ConnectorType.
"SignalProperties" aka RR_PROPERTY_SIGNAL_FORMAT
Type: ATOM
Format: 32
Num items: n
Flags: -
Range/List: For Composite signals:
NTSC NTSC-M NTSC-J NTSC-N NTSC-4.43 NTSC-film
PAL PAL-B PAL-G PAL-H PAL-H PAL-I PAL-M PAL-D
PAL-N PAL-Nc PAL-L PAL-60
SECAM SECAM-L SECAM-B SECAM-G SECAM-D SECAM-K
SECAM-H SECAM-K
For TMDS signals:
SingleLink DualLink
For DisplayPort signals:
Lane1 Lane2 Lane4 LowSpeed HiSpeed
Properties of the signal format that is currently used for the
specified output. valid-values lists all possible properties on this
output, which SHOULD be a subset of the list above. It will change if
SignalFormat changes. Multiple properties are allowed.
Values with dashes (PAL-B) describe more specific versions of the base
values (PAL) and SHOULD be used if known to the driver. A driver MAY
change this property of an output if the underlying hardware indicates
a signal change (e.g. TV formats). Clients are allowed to change the
properties in order to select a different signal subformat.
9.2 Properties introduced with version 1.2 of the RandR extension
Property Immutable Mandatory since
──────── ───────── ───────────────
EDID yes n/a
EDID is provided by the RandR frontend, thus not driver specific.
9.3 Properties introduced with version 1.3 of the RandR extension
Property Immutable Mandatory since
──────── ───────── ───────────────
CloneList yes not mandatory
CompatibilityList yes not mandatory
ConnectorNumber yes: static not mandatory
ConnectorType yes: static RandR 1.3
SignalFormat no RandR 1.3
SignalProperties no not mandatory
9.4 Properties introduced with version 1.3.1 of the RandR extension
Property Immutable Mandatory since
──────── ───────── ───────────────
Backlight no not mandatory
❧❧❧❧❧❧❧❧❧❧❧
10. Extension Versioning
The RandR extension was developed in parallel with the implementation
to ensure the feasibility of various portions of the design. As
portions of the extension are implemented, the version number of the
extension has changed to reflect the portions of the standard provided.
This document describes the version 1.2 of the specification, the
partial implementations have version numbers less than that. Here's a
list of what each version provided:
0.0: This prototype implemented resize and rotation in the
TinyX server Used approximately the protocol described in
the Usenix paper. Appeared in the TinyX server in
XFree86 4.2, but not in the XFree86 main server.
0.1: Added subpixel order, added an event for subpixel order.
This version was never checked in to XFree86 CVS.
1.0: Implements resize, rotation, and reflection. Implemented
both in the XFree86 main server (size change only at this
date), and fully (size change, rotation, and reflection)
in XFree86's TinyX server.
1.1: Added refresh rates
1.2: Separate screens from CRTCs and outputs, switch to full VESA
modes
1.3: Added cheap version of RRGetScreenResources. Added CRTC
transformations. Added panning. Added primary outputs.
Added standard properties.
Compatibility between 0.0 and 1.0 was *NOT* preserved, and 0.0 clients
will fail against 1.0 servers. The wire encoding op-codes were
changed for GetScreenInfo to ensure this failure in a relatively
graceful way. Version 1.1 servers and clients are cross compatible with
1.0. Version 1.1 is considered to be stable and we intend upward
compatibility from this point. Version 1.2 offers an extended model of the
system with multiple output support. Version 1.3 adds a cheap version of
GetScreenResources to avoid expensive DDC operations, CRTC transformations,
panning, and the primary output concept. 1.2 and 1.3 are backward-compatible
with 1.1.
❧❧❧❧❧❧❧❧❧❧❧
11. Relationship with other extensions
Two other extensions have a direct relationship with this extension. This
section attempts to explain how these three are supposed to work together.
11.1 XFree86-VidModeExtension
XFree86-VidModeExtension changes the configuration of a single monitor
attached to the screen without changing the configuration of the screen
itself. It provides the ability to specify new mode lines for the server to
use along with selecting among existing mode lines. As it uses screen
numbers instead of window identifiers, it can be used to affect multiple
monitors in a single-screen Xinerama configuration. However, the association
between screen numbers and root windows in a multi-Screen environment is not
defined by the extension. Version 2.0 of this extension added the ability to
adjust the DAC values in a TrueColor server to modify the brightness curves
of the display.
All of the utility of this extension is subsumed by RandR version 1.2, RandR
should be used in preference to XFree86-VidModeExtension where both are
present.
11.2 Xinerama
Xinerama provides a mechanism for describing the relationship between the
overall screen display and monitors placed within that area. As such, it
provides the query functionality of RandR 1.2 without any of the
configuration functionality. Applications using Xinerama to discover
monitor geometry can continue to do so, with the caveat that they will not be
informed of changes when they occur. However, Xinerama configuration data
will be updated, so applications selecting for RandR notification and
re-querying the configuration with the Xinerama extension will get updated
information. It is probably better to view RandR as a superset of Xinerama
at this point and use it in preference to Xinerama where both are present.
❧❧❧❧❧❧❧❧❧❧❧
Appendix A. Protocol Encoding
Syntactic Conventions
This document uses the same syntactic conventions as the core X
protocol encoding document.
A.1 Common Types
┌───
ROTATION
0x0001 Rotate_0
0x0002 Rotate_90
0x0004 Rotate_180
0x0008 Rotate_270
0x0010 Reflect_X
0x0020 Reflect_Y
└───
Used to encode both sets of possible rotations and individual
selected rotations.
┌───
RRSELECTMASK
0x0001 ScreenChangeNotifyMask
0x0002 CrtcChangeNotifyMask Added in version 1.2
0x0004 OutputChangeNotifyMask Added in version 1.2
0x0008 OutputPropertyNotifyMask Added in version 1.2
└───
Event select mask for RRSelectInput
┌───
RRCONFIGSTATUS
0x0 Success
0x1 InvalidConfigTime
0x2 InvalidTime
0x3 Failed
└───
Return status for requests which depend on time.
┌───
MODEINFO (32) Added in version 1.2
4 CARD32 id
2 CARD16 width in pixels
2 CARD16 height in pixels
4 CARD32 dot clock
2 CARD16 h sync start
2 CARD16 h sync end
2 CARD16 h total
2 CARD16 h skew
2 CARD16 v sync start
2 CARD16 v sync end
2 CARD16 v total
2 CARD16 name length
4 SETofMODEFLAG mode flags
└───
An output mode specifies the complete CRTC timings for
a specific mode. The vertical and horizontal synchronization rates
can be computed given the dot clock and the h total/v total
values. If the dot clock is zero, then all of the timing
parameters and flags are not used, and must be zero as this
indicates that the timings are unknown or otherwise unused.
The name itself will be encoded separately in each usage.
┌───
MODEFLAG
0x00000001 HSyncPositive
0x00000002 HSyncNegative
0x00000004 VSyncPositive
0x00000008 VSyncNegative
0x00000010 Interlace
0x00000020 DoubleScan
0x00000040 CSync
0x00000080 CSyncPositive
0x00000100 CSyncNegative
0x00000200 HSkewPresent
0x00000400 BCast
0x00000800 PixelMultiplex
0x00001000 DoubleClock
0x00002000 ClockDivideBy2
└───
┌───
CONNECTION
0 Connected
1 Disconnected
2 UnknownConnection
└───
A.2 Protocol Requests
Opcodes 1 and 3 were used in the 0.0 protocols, and will return
errors if used in version 1.0.
┌───
RRQueryVersion
1 CARD8 major opcode
1 0 RandR opcode
2 3 length
4 CARD32 major version
4 CARD32 minor version
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 0 reply length
1 CARD32 major version
1 CARD32 minor version
└───
┌───
RRSetScreenConfig
1 CARD8 major opcode
1 2 RandR opcode
2 6 length
4 WINDOW window on screen to be configured
4 TIMESTAMP timestamp
4 TIMESTAMP config timestamp
2 SIZEID size index
2 ROTATION rotation/reflection
2 CARD16 refresh rate (1.1 only)
2 CARD16 pad
▶
1 1 Reply
1 RRCONFIGSTATUS status
2 CARD16 sequence number
4 0 reply length
4 TIMESTAMP new timestamp
4 TIMESTAMP new configuration timestamp
4 WINDOW root
2 SUBPIXELORDER subpixel order defined in Render
2 CARD16 pad4
4 CARD32 pad5
4 CARD32 pad6
└───
┌───
RRSelectInput
1 CARD8 major opcode
1 4 RandR opcode
2 3 length
4 WINDOW window
2 SETofRRSELECTMASK enable
2 CARD16 pad
└───
┌───
RRGetScreenInfo
1 CARD8 major opcode
1 5 RandR opcode
2 2 length
4 WINDOW window
▶
1 1 Reply
1 CARD8 set of Rotations
2 CARD16 sequence number
4 0 reply length
4 WINDOW root window
4 TIMESTAMP timestamp
4 TIMESTAMP config timestamp
2 CARD16 number of SCREENSIZE following
2 SIZEID current size index
2 ROTATION current rotation and reflection
2 CARD16 current rate (added in version 1.1)
2 CARD16 length of rate info (number of CARD16s)
2 CARD16 pad
SCREENSIZE
2 CARD16 width in pixels
2 CARD16 height in pixels
2 CARD16 width in millimeters
2 CARD16 height in millimeters
REFRESH
2 CARD16 number of rates (n)
2n CARD16 rates
└───
A.2.1 Protocol Requests added with version 1.2
┌───
RRGetScreenSizeRange
1 CARD8 major opcode
1 6 RandR opcode
2 2 length
4 WINDOW window
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 0 reply length
2 CARD16 minWidth
2 CARD16 minHeight
2 CARD16 maxWidth
2 CARD16 maxHeight
16 unused
└───
┌───
RRSetScreenSize
1 CARD8 major opcode
1 7 RandR opcode
2 5 length
4 WINDOW window
2 CARD16 width
2 CARD16 height
4 CARD32 width in millimeters
4 CARD32 height in millimeters
└───
┌───
RRGetScreenResources
1 CARD8 major opcode
1 8 RandR opcode
2 2 length
4 WINDOW window
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 c+o+8m+(b+p)/4 reply length
4 TIMESTAMP timestamp
4 TIMESTAMP config-timestamp
2 c number of CRTCs
2 o number of outputs
2 m number of modeinfos
2 b total bytes in mode names
8 unused
4c LISTofCRTC crtcs
4o LISTofOUTPUT outputs
32m LISTofMODEINFO modeinfos
b STRING8 mode names
p unused, p=pad(b)
└───
┌───
RRGetOutputInfo
1 CARD8 major opcode
1 9 RandR opcode
2 3 length
4 OUTPUT output
4 TIMESTAMP config-timestamp
▶
1 1 Reply
1 RRCONFIGSTATUS status
2 CARD16 sequence number
4 1+c+m+(n+p)/4 reply length
4 TIMESTAMP timestamp
4 CRTC current connected crtc
4 CARD32 width in millimeters
4 CARD32 height in millimeters
1 CONNECTION connection
1 SUBPIXELORDER subpixel-order
2 c number of CRTCs
2 m number of modes
2 p number of preferred modes
2 o number of clones
2 n length of name
4c LISTofCRTC crtcs
4m LISTofMODE modes
4o LISTofOUTPUT clones
n STRING8 name
p unused, p=pad(n)
└───
┌───
RRListOutputProperties
1 CARD8 major opcode
1 10 RandR opcode
2 2 length
4 OUTPUT output
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 n reply length
2 n number of ATOMs in atoms
22 unused
4n LISTofATOM atoms
└───
┌───
RRQueryOutputProperty
1 CARD8 major opcode
1 11 RandR opcode
2 3 request length
4 OUTPUT output
4 ATOM property
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 n reply length
1 BOOL pending
1 BOOL range
1 BOOL immutable
21 unused
4n LISTofINT32 valid values
└───
┌───
RRConfigureOutputProperty
1 CARD8 major opcode
1 12 RandR opcode
2 4+n request length
4 OUTPUT output
4 ATOM property
1 BOOL pending
1 BOOL range
2 unused
4n LISTofINT32 valid values
└───
┌───
RRChangeOutputProperty
1 CARD8 major opcode
1 13 RandR opcode
2 6+(n+p)/4 request length
4 OUTPUT output
4 ATOM property
4 ATOM type
1 CARD8 format
1 mode
0 Replace
1 Prepend
2 Append
2 unused
4 CARD32 length of data in format units
(= n for format = 8)
(= n/2 for format = 16)
(= n/4 for format = 32)
n LISTofBYTE data
(n is a multiple of 2 for format = 16)
(n is a multiple of 4 for format = 32)
p unused, p=pad(n)
└───
┌───
RRDeleteOutputProperty
1 CARD8 major opcode
1 14 RandR opcode
2 3 request length
4 OUTPUT output
4 ATOM property
└───
┌───
RRGetOutputProperty
1 CARD8 major opcode
1 15 RandR opcode
2 7 request length
4 OUTPUT output
4 ATOM property
4 ATOM type
0 AnyPropertyType
4 CARD32 long-offset
4 CARD32 long-length
1 BOOL delete
1 BOOL pending
2 unused
▶
1 1 Reply
1 CARD8 format
2 CARD16 sequence number
4 (n+p)/4 reply length
4 ATOM type
0 None
4 CARD32 bytes-after
4 CARD32 length of value in format units
(= 0 for format = 0)
(= n for format = 8)
(= n/2 for format = 16)
(= n/4 for format = 32)
12 unused
n LISTofBYTE value
(n is zero for format = 0)
(n is a multiple of 2 for format = 16)
(n is a multiple of 4 for format = 32)
p unused, p=pad(n)
└───
┌───
RRCreateMode
1 CARD8 major opcode
1 16 RandR opcode
2 12+(n+p)/4 length
4 WINDOW window
32 MODEINFO mode
n STRING8 mode name
p unused, p=pad(n)
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 0 reply length
4 MODE mode
20 unused
└───
┌───
RRDestroyMode
1 CARD8 major opcode
1 17 RandR opcode
2 2 length
4 MODE mode
└───
┌───
RRAddOutputMode
1 CARD8 major opcode
1 18 RandR opcode
2 3 length
4 OUTPUT output
4 MODE mode
└───
┌───
RRDeleteOutputMode
1 CARD8 major opcode
1 19 RandR opcode
2 3 length
4 OUTPUT output
4 MODE mode
└───
┌───
RRGetCrtcInfo
1 CARD8 major opcode
1 20 RandR opcode
2 3 length
4 CRTC crtc
4 TIMESTAMP config-timestamp
▶
1 1 Reply
1 RRCONFIGSTATUS status
2 CARD16 sequence number
4 o+p reply length
4 TIMESTATMP timestamp
2 INT16 x
2 INT16 y
2 CARD16 width
2 CARD16 height
4 MODE mode
2 ROTATION current rotation and reflection
2 ROTATION set of possible rotations
2 o number of outputs
2 p number of possible outputs
4o LISTofOUTPUT outputs
4p LISTofOUTPUT possible outputs
└───
┌───
RRSetCrtcConfig
1 CARD8 major opcode
1 21 RandR opcode
2 7+2n length
4 CRTC crtc
4 TIMESTAMP timestamp
4 TIMESTAMP config timestamp
2 INT16 x
2 INT16 y
4 MODE mode
2 ROTATION rotation/reflection
2 unused
8n LISTofOUTPUT outputs
▶
1 1 Reply
1 RRCONFIGSTATUS status
2 CARD16 sequence number
4 0 reply length
4 TIMESTAMP new timestamp
20 unused
└───
┌───
RRGetCrtcGammaSize
1 CARD8 major opcode
1 22 RandR opcode
2 2 length
4 CRTC crtc
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 0 reply length
2 CARD16 size
22 unused
└───
┌───
RRGetCrtcGamma
1 CARD8 major opcode
1 23 RandR opcode
2 2 length
4 CRTC crtc
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 (6n+2)/4 reply length
2 n size
20 unused
2n LISTofCARD16 red
2n LISTofCARD16 green
2n LISTofCARD16 blue
p unused, p=pad(6n)
└───
┌───
RRSetCrtcGamma
1 CARD8 major opcode
1 24 RandR opcode
2 3+(6n+2)/4 length
4 CRTC crtc
2 n size
2 unused
2n LISTofCARD16 red
2n LISTofCARD16 green
2n LISTofCARD16 blue
p unused, p=pad(6n)
└───
A.2.2 Protocol Requests added with version 1.3
┌───
RRGetScreenResourcesCurrent
1 CARD8 major opcode
1 25 RandR opcode
2 2 length
4 WINDOW window
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 c+o+8m+(b+p)/4 reply length
4 TIMESTAMP timestamp
4 TIMESTAMP config-timestamp
2 c number of CRTCs
2 o number of outputs
2 m number of modeinfos
2 b total bytes in mode names
8 unused
4c LISTofCRTC crtcs
4o LISTofOUTPUT outputs
32m LISTofMODEINFO modeinfos
b STRING8 mode names
p unused, p=pad(b)
└───
┌───
RRSetCrtcTransform
1 CARD8 major opcode
1 26 RandR opcode
2 12+(n+p)/4+v length
4 CRTC crtc
36 TRANSFORM transform
2 CARD16 filter length
2 unused
n STRING8 filter name
p unused, p=pad(n)
4v FIXED filter params
└───
┌───
RRGetCrtcTransform
1 CARD8 major opcode
1 27 RandR opcode
2 2 length
4 CRTC crtc
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 16+(pn+pnp)/4+(cn+cnp)/4+pf+cf reply length
36 TRANSFORM pending transform
1 BOOL has transforms
3 unused
36 TRANSFORM current transform
4 unused
2 pn pending filter name length
2 pf pending filter num params
2 cn current filter name length
2 cf current filter num params
pn STRING8 pending filter name
pnp unused, pnp=pad(pn)
4*pf FIXED pending filter params
cn STRING8 current filter name
cnp unused, cnp=pad(cn)
4*cf FIXED current filter params
└───
┌───
RRGetPanning
1 CARD8 major opcode
1 28 RandR opcode
2 2 length
4 CRTC crtc
▶
1 1 Reply
1 RRCONFIGSTATUS status
2 CARD16 sequence number
4 1 reply length
4 TIMESTAMP timestamp
2 CARD16 left
2 CARD16 top
2 CARD16 width
2 CARD16 height
2 CARD16 track_left
2 CARD16 track_top
2 CARD16 track_width
2 CARD16 track_height
2 INT16 border_left
2 INT16 border_top
2 INT16 border_right
2 INT16 border_bottom
└───
┌───
RRSetPanning
1 CARD8 major opcode
1 29 RandR opcode
2 9 length
4 CRTC crtc
4 TIMESTAMP timestamp
2 CARD16 left
2 CARD16 top
2 CARD16 width
2 CARD16 height
2 CARD16 track_left
2 CARD16 track_top
2 CARD16 track_width
2 CARD16 track_height
2 INT16 border_left
2 INT16 border_top
2 INT16 border_right
2 INT16 border_bottom
▶
1 1 Reply
1 RRCONFIGSTATUS status
2 CARD16 sequence number
4 0 reply length
4 TIMESTAMP new timestamp
20 unused
└───
┌───
RRSetOutputPrimary
1 CARD8 major opcode
1 30 RandR opcode
2 3 length
4 WINDOW window
4 OUTPUT output
└───
┌───
RRGetOutputPrimary
1 CARD8 major opcode
1 31 RandR opcode
2 2 length
4 WINDOW window
▶
1 1 Reply
1 unused
2 CARD16 sequence number
4 CARD32 length
4 OUTPUT output
4 CARD32 pad1
4 CARD32 pad2
4 CARD32 pad3
4 CARD32 pad4
└───
A.3 Protocol Events
┌───
RRScreenChangeNotify
1 Base + 0 code
1 ROTATION new rotation and reflection
2 CARD16 sequence number
4 TIMESTAMP timestamp
4 TIMESTAMP configuration timestamp
4 WINDOW root window
4 WINDOW request window
2 SIZEID size ID
2 SUBPIXELORDER subpixel order defined in Render
2 CARD16 width in pixels
2 CARD16 height in pixels
2 CARD16 width in millimeters
2 CARD16 height in millimeters
└───
A.3.1 Protocol Events added with version 1.2
┌───
RRCrtcChangeNotify
1 Base + 1 code
1 0 sub-code
2 CARD16 sequence number
4 TIMESTAMP timestamp
4 WINDOW request window
4 CRTC crtc affected
4 MODE mode in use
2 ROTATION new rotation and reflection
2 unused
2 INT16 x
2 INT16 y
2 CARD16 width
2 CARD16 height
└───
┌───
RROutputChangeNotify
1 Base + 1 code
1 1 sub-code
2 CARD16 sequence number
4 TIMESTAMP timestamp
4 TIMESTAMP configuration timestamp
4 WINDOW request window
4 OUTPUT output affected
4 CRTC crtc in use
4 MODE mode in use
2 ROTATION rotation in use
1 CONNECTION connection status
1 SUBPIXELORDER subpixel order
└───
┌───
RROutputPropertyNotify
1 Base + 1 code
1 2 sub-code
2 CARD16 sequence number
4 WINDOW window
4 OUTPUT output
4 ATOM atom
4 TIMESTAMP time
1 state
0 NewValue
1 Deleted
11 unused
└───
A.4 Protocol Errors
┌───
ERRORS
Base + 0 Output
Base + 1 Crtc
Base + 2 Mode
└───
Bibliography
[RANDR] Gettys, Jim and Keith Packard, "The X Resize and Rotate
Extension - RandR", Proceedings of the 2001 USENIX Annual
Technical Conference, Boston, MA
[RENDER]
Packard, Keith, "The X Rendering Extension", work in progress,
http://cgit.freedesktop.org/xorg/proto/renderproto/tree/renderproto.txt
|