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
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
|
/* SCANNER TEST */
#ifndef WAYLAND_CLIENT_PROTOCOL_H
#define WAYLAND_CLIENT_PROTOCOL_H
#include <stdint.h>
#include <stddef.h>
#include "wayland-client.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @page page_wayland The wayland protocol
* @section page_ifaces_wayland Interfaces
* - @subpage page_iface_wl_display - core global object
* - @subpage page_iface_wl_registry - global registry object
* - @subpage page_iface_wl_callback - callback object
* - @subpage page_iface_wl_compositor - the compositor singleton
* - @subpage page_iface_wl_shm_pool - a shared memory pool
* - @subpage page_iface_wl_shm - shared memory support
* - @subpage page_iface_wl_buffer - content for a wl_surface
* - @subpage page_iface_wl_data_offer - offer to transfer data
* - @subpage page_iface_wl_data_source - offer to transfer data
* - @subpage page_iface_wl_data_device - data transfer device
* - @subpage page_iface_wl_data_device_manager - data transfer interface
* - @subpage page_iface_wl_shell - create desktop-style surfaces
* - @subpage page_iface_wl_shell_surface - desktop-style metadata interface
* - @subpage page_iface_wl_surface - an onscreen surface
* - @subpage page_iface_wl_seat - group of input devices
* - @subpage page_iface_wl_pointer - pointer input device
* - @subpage page_iface_wl_keyboard - keyboard input device
* - @subpage page_iface_wl_touch - touchscreen input device
* - @subpage page_iface_wl_output - compositor output region
* - @subpage page_iface_wl_region - region interface
* - @subpage page_iface_wl_subcompositor - sub-surface compositing
* - @subpage page_iface_wl_subsurface - sub-surface interface to a wl_surface
* @section page_copyright_wayland Copyright
* <pre>
*
* Copyright © 2008-2011 Kristian Høgsberg
* Copyright © 2010-2011 Intel Corporation
* Copyright © 2012-2013 Collabora, Ltd.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation files
* (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge,
* publish, distribute, sublicense, and/or sell copies of the Software,
* and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
* </pre>
*/
struct wl_buffer;
struct wl_callback;
struct wl_compositor;
struct wl_data_device;
struct wl_data_device_manager;
struct wl_data_offer;
struct wl_data_source;
struct wl_display;
struct wl_keyboard;
struct wl_output;
struct wl_pointer;
struct wl_region;
struct wl_registry;
struct wl_seat;
struct wl_shell;
struct wl_shell_surface;
struct wl_shm;
struct wl_shm_pool;
struct wl_subcompositor;
struct wl_subsurface;
struct wl_surface;
struct wl_touch;
/**
* @page page_iface_wl_display wl_display
* @section page_iface_wl_display_desc Description
*
* The core global object. This is a special singleton object. It
* is used for internal Wayland protocol features.
* @section page_iface_wl_display_api API
* See @ref iface_wl_display.
*/
/**
* @defgroup iface_wl_display The wl_display interface
*
* The core global object. This is a special singleton object. It
* is used for internal Wayland protocol features.
*/
extern const struct wl_interface wl_display_interface;
/**
* @page page_iface_wl_registry wl_registry
* @section page_iface_wl_registry_desc Description
*
* The singleton global registry object. The server has a number of
* global objects that are available to all clients. These objects
* typically represent an actual object in the server (for example,
* an input device) or they are singleton objects that provide
* extension functionality.
*
* When a client creates a registry object, the registry object
* will emit a global event for each global currently in the
* registry. Globals come and go as a result of device or
* monitor hotplugs, reconfiguration or other events, and the
* registry will send out global and global_remove events to
* keep the client up to date with the changes. To mark the end
* of the initial burst of events, the client can use the
* wl_display.sync request immediately after calling
* wl_display.get_registry.
*
* A client can bind to a global object by using the bind
* request. This creates a client-side handle that lets the object
* emit events to the client and lets the client invoke requests on
* the object.
* @section page_iface_wl_registry_api API
* See @ref iface_wl_registry.
*/
/**
* @defgroup iface_wl_registry The wl_registry interface
*
* The singleton global registry object. The server has a number of
* global objects that are available to all clients. These objects
* typically represent an actual object in the server (for example,
* an input device) or they are singleton objects that provide
* extension functionality.
*
* When a client creates a registry object, the registry object
* will emit a global event for each global currently in the
* registry. Globals come and go as a result of device or
* monitor hotplugs, reconfiguration or other events, and the
* registry will send out global and global_remove events to
* keep the client up to date with the changes. To mark the end
* of the initial burst of events, the client can use the
* wl_display.sync request immediately after calling
* wl_display.get_registry.
*
* A client can bind to a global object by using the bind
* request. This creates a client-side handle that lets the object
* emit events to the client and lets the client invoke requests on
* the object.
*/
extern const struct wl_interface wl_registry_interface;
/**
* @page page_iface_wl_callback wl_callback
* @section page_iface_wl_callback_desc Description
*
* Clients can handle the 'done' event to get notified when
* the related request is done.
* @section page_iface_wl_callback_api API
* See @ref iface_wl_callback.
*/
/**
* @defgroup iface_wl_callback The wl_callback interface
*
* Clients can handle the 'done' event to get notified when
* the related request is done.
*/
extern const struct wl_interface wl_callback_interface;
/**
* @page page_iface_wl_compositor wl_compositor
* @section page_iface_wl_compositor_desc Description
*
* A compositor. This object is a singleton global. The
* compositor is in charge of combining the contents of multiple
* surfaces into one displayable output.
* @section page_iface_wl_compositor_api API
* See @ref iface_wl_compositor.
*/
/**
* @defgroup iface_wl_compositor The wl_compositor interface
*
* A compositor. This object is a singleton global. The
* compositor is in charge of combining the contents of multiple
* surfaces into one displayable output.
*/
extern const struct wl_interface wl_compositor_interface;
/**
* @page page_iface_wl_shm_pool wl_shm_pool
* @section page_iface_wl_shm_pool_desc Description
*
* The wl_shm_pool object encapsulates a piece of memory shared
* between the compositor and client. Through the wl_shm_pool
* object, the client can allocate shared memory wl_buffer objects.
* All objects created through the same pool share the same
* underlying mapped memory. Reusing the mapped memory avoids the
* setup/teardown overhead and is useful when interactively resizing
* a surface or for many small buffers.
* @section page_iface_wl_shm_pool_api API
* See @ref iface_wl_shm_pool.
*/
/**
* @defgroup iface_wl_shm_pool The wl_shm_pool interface
*
* The wl_shm_pool object encapsulates a piece of memory shared
* between the compositor and client. Through the wl_shm_pool
* object, the client can allocate shared memory wl_buffer objects.
* All objects created through the same pool share the same
* underlying mapped memory. Reusing the mapped memory avoids the
* setup/teardown overhead and is useful when interactively resizing
* a surface or for many small buffers.
*/
extern const struct wl_interface wl_shm_pool_interface;
/**
* @page page_iface_wl_shm wl_shm
* @section page_iface_wl_shm_desc Description
*
* A singleton global object that provides support for shared
* memory.
*
* Clients can create wl_shm_pool objects using the create_pool
* request.
*
* At connection setup time, the wl_shm object emits one or more
* format events to inform clients about the valid pixel formats
* that can be used for buffers.
* @section page_iface_wl_shm_api API
* See @ref iface_wl_shm.
*/
/**
* @defgroup iface_wl_shm The wl_shm interface
*
* A singleton global object that provides support for shared
* memory.
*
* Clients can create wl_shm_pool objects using the create_pool
* request.
*
* At connection setup time, the wl_shm object emits one or more
* format events to inform clients about the valid pixel formats
* that can be used for buffers.
*/
extern const struct wl_interface wl_shm_interface;
/**
* @page page_iface_wl_buffer wl_buffer
* @section page_iface_wl_buffer_desc Description
*
* A buffer provides the content for a wl_surface. Buffers are
* created through factory interfaces such as wl_drm, wl_shm or
* similar. It has a width and a height and can be attached to a
* wl_surface, but the mechanism by which a client provides and
* updates the contents is defined by the buffer factory interface.
* @section page_iface_wl_buffer_api API
* See @ref iface_wl_buffer.
*/
/**
* @defgroup iface_wl_buffer The wl_buffer interface
*
* A buffer provides the content for a wl_surface. Buffers are
* created through factory interfaces such as wl_drm, wl_shm or
* similar. It has a width and a height and can be attached to a
* wl_surface, but the mechanism by which a client provides and
* updates the contents is defined by the buffer factory interface.
*/
extern const struct wl_interface wl_buffer_interface;
/**
* @page page_iface_wl_data_offer wl_data_offer
* @section page_iface_wl_data_offer_desc Description
*
* A wl_data_offer represents a piece of data offered for transfer
* by another client (the source client). It is used by the
* copy-and-paste and drag-and-drop mechanisms. The offer
* describes the different mime types that the data can be
* converted to and provides the mechanism for transferring the
* data directly from the source client.
* @section page_iface_wl_data_offer_api API
* See @ref iface_wl_data_offer.
*/
/**
* @defgroup iface_wl_data_offer The wl_data_offer interface
*
* A wl_data_offer represents a piece of data offered for transfer
* by another client (the source client). It is used by the
* copy-and-paste and drag-and-drop mechanisms. The offer
* describes the different mime types that the data can be
* converted to and provides the mechanism for transferring the
* data directly from the source client.
*/
extern const struct wl_interface wl_data_offer_interface;
/**
* @page page_iface_wl_data_source wl_data_source
* @section page_iface_wl_data_source_desc Description
*
* The wl_data_source object is the source side of a wl_data_offer.
* It is created by the source client in a data transfer and
* provides a way to describe the offered data and a way to respond
* to requests to transfer the data.
* @section page_iface_wl_data_source_api API
* See @ref iface_wl_data_source.
*/
/**
* @defgroup iface_wl_data_source The wl_data_source interface
*
* The wl_data_source object is the source side of a wl_data_offer.
* It is created by the source client in a data transfer and
* provides a way to describe the offered data and a way to respond
* to requests to transfer the data.
*/
extern const struct wl_interface wl_data_source_interface;
/**
* @page page_iface_wl_data_device wl_data_device
* @section page_iface_wl_data_device_desc Description
*
* There is one wl_data_device per seat which can be obtained
* from the global wl_data_device_manager singleton.
*
* A wl_data_device provides access to inter-client data transfer
* mechanisms such as copy-and-paste and drag-and-drop.
* @section page_iface_wl_data_device_api API
* See @ref iface_wl_data_device.
*/
/**
* @defgroup iface_wl_data_device The wl_data_device interface
*
* There is one wl_data_device per seat which can be obtained
* from the global wl_data_device_manager singleton.
*
* A wl_data_device provides access to inter-client data transfer
* mechanisms such as copy-and-paste and drag-and-drop.
*/
extern const struct wl_interface wl_data_device_interface;
/**
* @page page_iface_wl_data_device_manager wl_data_device_manager
* @section page_iface_wl_data_device_manager_desc Description
*
* The wl_data_device_manager is a singleton global object that
* provides access to inter-client data transfer mechanisms such as
* copy-and-paste and drag-and-drop. These mechanisms are tied to
* a wl_seat and this interface lets a client get a wl_data_device
* corresponding to a wl_seat.
*
* Depending on the version bound, the objects created from the bound
* wl_data_device_manager object will have different requirements for
* functioning properly. See wl_data_source.set_actions,
* wl_data_offer.accept and wl_data_offer.finish for details.
* @section page_iface_wl_data_device_manager_api API
* See @ref iface_wl_data_device_manager.
*/
/**
* @defgroup iface_wl_data_device_manager The wl_data_device_manager interface
*
* The wl_data_device_manager is a singleton global object that
* provides access to inter-client data transfer mechanisms such as
* copy-and-paste and drag-and-drop. These mechanisms are tied to
* a wl_seat and this interface lets a client get a wl_data_device
* corresponding to a wl_seat.
*
* Depending on the version bound, the objects created from the bound
* wl_data_device_manager object will have different requirements for
* functioning properly. See wl_data_source.set_actions,
* wl_data_offer.accept and wl_data_offer.finish for details.
*/
extern const struct wl_interface wl_data_device_manager_interface;
/**
* @page page_iface_wl_shell wl_shell
* @section page_iface_wl_shell_desc Description
*
* This interface is implemented by servers that provide
* desktop-style user interfaces.
*
* It allows clients to associate a wl_shell_surface with
* a basic surface.
* @section page_iface_wl_shell_api API
* See @ref iface_wl_shell.
*/
/**
* @defgroup iface_wl_shell The wl_shell interface
*
* This interface is implemented by servers that provide
* desktop-style user interfaces.
*
* It allows clients to associate a wl_shell_surface with
* a basic surface.
*/
extern const struct wl_interface wl_shell_interface;
/**
* @page page_iface_wl_shell_surface wl_shell_surface
* @section page_iface_wl_shell_surface_desc Description
*
* An interface that may be implemented by a wl_surface, for
* implementations that provide a desktop-style user interface.
*
* It provides requests to treat surfaces like toplevel, fullscreen
* or popup windows, move, resize or maximize them, associate
* metadata like title and class, etc.
*
* On the server side the object is automatically destroyed when
* the related wl_surface is destroyed. On the client side,
* wl_shell_surface_destroy() must be called before destroying
* the wl_surface object.
* @section page_iface_wl_shell_surface_api API
* See @ref iface_wl_shell_surface.
*/
/**
* @defgroup iface_wl_shell_surface The wl_shell_surface interface
*
* An interface that may be implemented by a wl_surface, for
* implementations that provide a desktop-style user interface.
*
* It provides requests to treat surfaces like toplevel, fullscreen
* or popup windows, move, resize or maximize them, associate
* metadata like title and class, etc.
*
* On the server side the object is automatically destroyed when
* the related wl_surface is destroyed. On the client side,
* wl_shell_surface_destroy() must be called before destroying
* the wl_surface object.
*/
extern const struct wl_interface wl_shell_surface_interface;
/**
* @page page_iface_wl_surface wl_surface
* @section page_iface_wl_surface_desc Description
*
* A surface is a rectangular area that is displayed on the screen.
* It has a location, size and pixel contents.
*
* The size of a surface (and relative positions on it) is described
* in surface-local coordinates, which may differ from the buffer
* coordinates of the pixel content, in case a buffer_transform
* or a buffer_scale is used.
*
* A surface without a "role" is fairly useless: a compositor does
* not know where, when or how to present it. The role is the
* purpose of a wl_surface. Examples of roles are a cursor for a
* pointer (as set by wl_pointer.set_cursor), a drag icon
* (wl_data_device.start_drag), a sub-surface
* (wl_subcompositor.get_subsurface), and a window as defined by a
* shell protocol (e.g. wl_shell.get_shell_surface).
*
* A surface can have only one role at a time. Initially a
* wl_surface does not have a role. Once a wl_surface is given a
* role, it is set permanently for the whole lifetime of the
* wl_surface object. Giving the current role again is allowed,
* unless explicitly forbidden by the relevant interface
* specification.
*
* Surface roles are given by requests in other interfaces such as
* wl_pointer.set_cursor. The request should explicitly mention
* that this request gives a role to a wl_surface. Often, this
* request also creates a new protocol object that represents the
* role and adds additional functionality to wl_surface. When a
* client wants to destroy a wl_surface, they must destroy this 'role
* object' before the wl_surface.
*
* Destroying the role object does not remove the role from the
* wl_surface, but it may stop the wl_surface from "playing the role".
* For instance, if a wl_subsurface object is destroyed, the wl_surface
* it was created for will be unmapped and forget its position and
* z-order. It is allowed to create a wl_subsurface for the same
* wl_surface again, but it is not allowed to use the wl_surface as
* a cursor (cursor is a different role than sub-surface, and role
* switching is not allowed).
* @section page_iface_wl_surface_api API
* See @ref iface_wl_surface.
*/
/**
* @defgroup iface_wl_surface The wl_surface interface
*
* A surface is a rectangular area that is displayed on the screen.
* It has a location, size and pixel contents.
*
* The size of a surface (and relative positions on it) is described
* in surface-local coordinates, which may differ from the buffer
* coordinates of the pixel content, in case a buffer_transform
* or a buffer_scale is used.
*
* A surface without a "role" is fairly useless: a compositor does
* not know where, when or how to present it. The role is the
* purpose of a wl_surface. Examples of roles are a cursor for a
* pointer (as set by wl_pointer.set_cursor), a drag icon
* (wl_data_device.start_drag), a sub-surface
* (wl_subcompositor.get_subsurface), and a window as defined by a
* shell protocol (e.g. wl_shell.get_shell_surface).
*
* A surface can have only one role at a time. Initially a
* wl_surface does not have a role. Once a wl_surface is given a
* role, it is set permanently for the whole lifetime of the
* wl_surface object. Giving the current role again is allowed,
* unless explicitly forbidden by the relevant interface
* specification.
*
* Surface roles are given by requests in other interfaces such as
* wl_pointer.set_cursor. The request should explicitly mention
* that this request gives a role to a wl_surface. Often, this
* request also creates a new protocol object that represents the
* role and adds additional functionality to wl_surface. When a
* client wants to destroy a wl_surface, they must destroy this 'role
* object' before the wl_surface.
*
* Destroying the role object does not remove the role from the
* wl_surface, but it may stop the wl_surface from "playing the role".
* For instance, if a wl_subsurface object is destroyed, the wl_surface
* it was created for will be unmapped and forget its position and
* z-order. It is allowed to create a wl_subsurface for the same
* wl_surface again, but it is not allowed to use the wl_surface as
* a cursor (cursor is a different role than sub-surface, and role
* switching is not allowed).
*/
extern const struct wl_interface wl_surface_interface;
/**
* @page page_iface_wl_seat wl_seat
* @section page_iface_wl_seat_desc Description
*
* A seat is a group of keyboards, pointer and touch devices. This
* object is published as a global during start up, or when such a
* device is hot plugged. A seat typically has a pointer and
* maintains a keyboard focus and a pointer focus.
* @section page_iface_wl_seat_api API
* See @ref iface_wl_seat.
*/
/**
* @defgroup iface_wl_seat The wl_seat interface
*
* A seat is a group of keyboards, pointer and touch devices. This
* object is published as a global during start up, or when such a
* device is hot plugged. A seat typically has a pointer and
* maintains a keyboard focus and a pointer focus.
*/
extern const struct wl_interface wl_seat_interface;
/**
* @page page_iface_wl_pointer wl_pointer
* @section page_iface_wl_pointer_desc Description
*
* The wl_pointer interface represents one or more input devices,
* such as mice, which control the pointer location and pointer_focus
* of a seat.
*
* The wl_pointer interface generates motion, enter and leave
* events for the surfaces that the pointer is located over,
* and button and axis events for button presses, button releases
* and scrolling.
* @section page_iface_wl_pointer_api API
* See @ref iface_wl_pointer.
*/
/**
* @defgroup iface_wl_pointer The wl_pointer interface
*
* The wl_pointer interface represents one or more input devices,
* such as mice, which control the pointer location and pointer_focus
* of a seat.
*
* The wl_pointer interface generates motion, enter and leave
* events for the surfaces that the pointer is located over,
* and button and axis events for button presses, button releases
* and scrolling.
*/
extern const struct wl_interface wl_pointer_interface;
/**
* @page page_iface_wl_keyboard wl_keyboard
* @section page_iface_wl_keyboard_desc Description
*
* The wl_keyboard interface represents one or more keyboards
* associated with a seat.
* @section page_iface_wl_keyboard_api API
* See @ref iface_wl_keyboard.
*/
/**
* @defgroup iface_wl_keyboard The wl_keyboard interface
*
* The wl_keyboard interface represents one or more keyboards
* associated with a seat.
*/
extern const struct wl_interface wl_keyboard_interface;
/**
* @page page_iface_wl_touch wl_touch
* @section page_iface_wl_touch_desc Description
*
* The wl_touch interface represents a touchscreen
* associated with a seat.
*
* Touch interactions can consist of one or more contacts.
* For each contact, a series of events is generated, starting
* with a down event, followed by zero or more motion events,
* and ending with an up event. Events relating to the same
* contact point can be identified by the ID of the sequence.
* @section page_iface_wl_touch_api API
* See @ref iface_wl_touch.
*/
/**
* @defgroup iface_wl_touch The wl_touch interface
*
* The wl_touch interface represents a touchscreen
* associated with a seat.
*
* Touch interactions can consist of one or more contacts.
* For each contact, a series of events is generated, starting
* with a down event, followed by zero or more motion events,
* and ending with an up event. Events relating to the same
* contact point can be identified by the ID of the sequence.
*/
extern const struct wl_interface wl_touch_interface;
/**
* @page page_iface_wl_output wl_output
* @section page_iface_wl_output_desc Description
*
* An output describes part of the compositor geometry. The
* compositor works in the 'compositor coordinate system' and an
* output corresponds to a rectangular area in that space that is
* actually visible. This typically corresponds to a monitor that
* displays part of the compositor space. This object is published
* as global during start up, or when a monitor is hotplugged.
* @section page_iface_wl_output_api API
* See @ref iface_wl_output.
*/
/**
* @defgroup iface_wl_output The wl_output interface
*
* An output describes part of the compositor geometry. The
* compositor works in the 'compositor coordinate system' and an
* output corresponds to a rectangular area in that space that is
* actually visible. This typically corresponds to a monitor that
* displays part of the compositor space. This object is published
* as global during start up, or when a monitor is hotplugged.
*/
extern const struct wl_interface wl_output_interface;
/**
* @page page_iface_wl_region wl_region
* @section page_iface_wl_region_desc Description
*
* A region object describes an area.
*
* Region objects are used to describe the opaque and input
* regions of a surface.
* @section page_iface_wl_region_api API
* See @ref iface_wl_region.
*/
/**
* @defgroup iface_wl_region The wl_region interface
*
* A region object describes an area.
*
* Region objects are used to describe the opaque and input
* regions of a surface.
*/
extern const struct wl_interface wl_region_interface;
/**
* @page page_iface_wl_subcompositor wl_subcompositor
* @section page_iface_wl_subcompositor_desc Description
*
* The global interface exposing sub-surface compositing capabilities.
* A wl_surface, that has sub-surfaces associated, is called the
* parent surface. Sub-surfaces can be arbitrarily nested and create
* a tree of sub-surfaces.
*
* The root surface in a tree of sub-surfaces is the main
* surface. The main surface cannot be a sub-surface, because
* sub-surfaces must always have a parent.
*
* A main surface with its sub-surfaces forms a (compound) window.
* For window management purposes, this set of wl_surface objects is
* to be considered as a single window, and it should also behave as
* such.
*
* The aim of sub-surfaces is to offload some of the compositing work
* within a window from clients to the compositor. A prime example is
* a video player with decorations and video in separate wl_surface
* objects. This should allow the compositor to pass YUV video buffer
* processing to dedicated overlay hardware when possible.
* @section page_iface_wl_subcompositor_api API
* See @ref iface_wl_subcompositor.
*/
/**
* @defgroup iface_wl_subcompositor The wl_subcompositor interface
*
* The global interface exposing sub-surface compositing capabilities.
* A wl_surface, that has sub-surfaces associated, is called the
* parent surface. Sub-surfaces can be arbitrarily nested and create
* a tree of sub-surfaces.
*
* The root surface in a tree of sub-surfaces is the main
* surface. The main surface cannot be a sub-surface, because
* sub-surfaces must always have a parent.
*
* A main surface with its sub-surfaces forms a (compound) window.
* For window management purposes, this set of wl_surface objects is
* to be considered as a single window, and it should also behave as
* such.
*
* The aim of sub-surfaces is to offload some of the compositing work
* within a window from clients to the compositor. A prime example is
* a video player with decorations and video in separate wl_surface
* objects. This should allow the compositor to pass YUV video buffer
* processing to dedicated overlay hardware when possible.
*/
extern const struct wl_interface wl_subcompositor_interface;
/**
* @page page_iface_wl_subsurface wl_subsurface
* @section page_iface_wl_subsurface_desc Description
*
* An additional interface to a wl_surface object, which has been
* made a sub-surface. A sub-surface has one parent surface. A
* sub-surface's size and position are not limited to that of the parent.
* Particularly, a sub-surface is not automatically clipped to its
* parent's area.
*
* A sub-surface becomes mapped, when a non-NULL wl_buffer is applied
* and the parent surface is mapped. The order of which one happens
* first is irrelevant. A sub-surface is hidden if the parent becomes
* hidden, or if a NULL wl_buffer is applied. These rules apply
* recursively through the tree of surfaces.
*
* The behaviour of a wl_surface.commit request on a sub-surface
* depends on the sub-surface's mode. The possible modes are
* synchronized and desynchronized, see methods
* wl_subsurface.set_sync and wl_subsurface.set_desync. Synchronized
* mode caches the wl_surface state to be applied when the parent's
* state gets applied, and desynchronized mode applies the pending
* wl_surface state directly. A sub-surface is initially in the
* synchronized mode.
*
* Sub-surfaces have also other kind of state, which is managed by
* wl_subsurface requests, as opposed to wl_surface requests. This
* state includes the sub-surface position relative to the parent
* surface (wl_subsurface.set_position), and the stacking order of
* the parent and its sub-surfaces (wl_subsurface.place_above and
* .place_below). This state is applied when the parent surface's
* wl_surface state is applied, regardless of the sub-surface's mode.
* As the exception, set_sync and set_desync are effective immediately.
*
* The main surface can be thought to be always in desynchronized mode,
* since it does not have a parent in the sub-surfaces sense.
*
* Even if a sub-surface is in desynchronized mode, it will behave as
* in synchronized mode, if its parent surface behaves as in
* synchronized mode. This rule is applied recursively throughout the
* tree of surfaces. This means, that one can set a sub-surface into
* synchronized mode, and then assume that all its child and grand-child
* sub-surfaces are synchronized, too, without explicitly setting them.
*
* If the wl_surface associated with the wl_subsurface is destroyed, the
* wl_subsurface object becomes inert. Note, that destroying either object
* takes effect immediately. If you need to synchronize the removal
* of a sub-surface to the parent surface update, unmap the sub-surface
* first by attaching a NULL wl_buffer, update parent, and then destroy
* the sub-surface.
*
* If the parent wl_surface object is destroyed, the sub-surface is
* unmapped.
* @section page_iface_wl_subsurface_api API
* See @ref iface_wl_subsurface.
*/
/**
* @defgroup iface_wl_subsurface The wl_subsurface interface
*
* An additional interface to a wl_surface object, which has been
* made a sub-surface. A sub-surface has one parent surface. A
* sub-surface's size and position are not limited to that of the parent.
* Particularly, a sub-surface is not automatically clipped to its
* parent's area.
*
* A sub-surface becomes mapped, when a non-NULL wl_buffer is applied
* and the parent surface is mapped. The order of which one happens
* first is irrelevant. A sub-surface is hidden if the parent becomes
* hidden, or if a NULL wl_buffer is applied. These rules apply
* recursively through the tree of surfaces.
*
* The behaviour of a wl_surface.commit request on a sub-surface
* depends on the sub-surface's mode. The possible modes are
* synchronized and desynchronized, see methods
* wl_subsurface.set_sync and wl_subsurface.set_desync. Synchronized
* mode caches the wl_surface state to be applied when the parent's
* state gets applied, and desynchronized mode applies the pending
* wl_surface state directly. A sub-surface is initially in the
* synchronized mode.
*
* Sub-surfaces have also other kind of state, which is managed by
* wl_subsurface requests, as opposed to wl_surface requests. This
* state includes the sub-surface position relative to the parent
* surface (wl_subsurface.set_position), and the stacking order of
* the parent and its sub-surfaces (wl_subsurface.place_above and
* .place_below). This state is applied when the parent surface's
* wl_surface state is applied, regardless of the sub-surface's mode.
* As the exception, set_sync and set_desync are effective immediately.
*
* The main surface can be thought to be always in desynchronized mode,
* since it does not have a parent in the sub-surfaces sense.
*
* Even if a sub-surface is in desynchronized mode, it will behave as
* in synchronized mode, if its parent surface behaves as in
* synchronized mode. This rule is applied recursively throughout the
* tree of surfaces. This means, that one can set a sub-surface into
* synchronized mode, and then assume that all its child and grand-child
* sub-surfaces are synchronized, too, without explicitly setting them.
*
* If the wl_surface associated with the wl_subsurface is destroyed, the
* wl_subsurface object becomes inert. Note, that destroying either object
* takes effect immediately. If you need to synchronize the removal
* of a sub-surface to the parent surface update, unmap the sub-surface
* first by attaching a NULL wl_buffer, update parent, and then destroy
* the sub-surface.
*
* If the parent wl_surface object is destroyed, the sub-surface is
* unmapped.
*/
extern const struct wl_interface wl_subsurface_interface;
#ifndef WL_DISPLAY_ERROR_ENUM
#define WL_DISPLAY_ERROR_ENUM
/**
* @ingroup iface_wl_display
* global error values
*
* These errors are global and can be emitted in response to any
* server request.
*/
enum wl_display_error {
/**
* server couldn't find object
*/
WL_DISPLAY_ERROR_INVALID_OBJECT = 0,
/**
* method doesn't exist on the specified interface
*/
WL_DISPLAY_ERROR_INVALID_METHOD = 1,
/**
* server is out of memory
*/
WL_DISPLAY_ERROR_NO_MEMORY = 2,
};
#endif /* WL_DISPLAY_ERROR_ENUM */
/**
* @ingroup iface_wl_display
* @struct wl_display_listener
*/
struct wl_display_listener {
/**
* fatal error event
*
* The error event is sent out when a fatal (non-recoverable)
* error has occurred. The object_id argument is the object where
* the error occurred, most often in response to a request to that
* object. The code identifies the error and is defined by the
* object interface. As such, each interface defines its own set of
* error codes. The message is a brief description of the error,
* for (debugging) convenience.
* @param object_id object where the error occurred
* @param code error code
* @param message error description
*/
void (*error)(void *data,
struct wl_display *wl_display,
void *object_id,
uint32_t code,
const char *message);
/**
* acknowledge object ID deletion
*
* This event is used internally by the object ID management
* logic. When a client deletes an object, the server will send
* this event to acknowledge that it has seen the delete request.
* When the client receives this event, it will know that it can
* safely reuse the object ID.
* @param id deleted object ID
*/
void (*delete_id)(void *data,
struct wl_display *wl_display,
uint32_t id);
};
/**
* @ingroup iface_wl_display
*/
static inline int
wl_display_add_listener(struct wl_display *wl_display,
const struct wl_display_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_display,
(void (**)(void)) listener, data);
}
#define WL_DISPLAY_SYNC 0
#define WL_DISPLAY_GET_REGISTRY 1
/**
* @ingroup iface_wl_display
*/
#define WL_DISPLAY_ERROR_SINCE_VERSION 1
/**
* @ingroup iface_wl_display
*/
#define WL_DISPLAY_DELETE_ID_SINCE_VERSION 1
/**
* @ingroup iface_wl_display
*/
#define WL_DISPLAY_SYNC_SINCE_VERSION 1
/**
* @ingroup iface_wl_display
*/
#define WL_DISPLAY_GET_REGISTRY_SINCE_VERSION 1
/** @ingroup iface_wl_display */
static inline void
wl_display_set_user_data(struct wl_display *wl_display, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_display, user_data);
}
/** @ingroup iface_wl_display */
static inline void *
wl_display_get_user_data(struct wl_display *wl_display)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_display);
}
static inline uint32_t
wl_display_get_version(struct wl_display *wl_display)
{
return wl_proxy_get_version((struct wl_proxy *) wl_display);
}
/**
* @ingroup iface_wl_display
*
* The sync request asks the server to emit the 'done' event
* on the returned wl_callback object. Since requests are
* handled in-order and events are delivered in-order, this can
* be used as a barrier to ensure all previous requests and the
* resulting events have been handled.
*
* The object returned by this request will be destroyed by the
* compositor after the callback is fired and as such the client must not
* attempt to use it after that point.
*
* The callback_data passed in the callback is the event serial.
*/
static inline struct wl_callback *
wl_display_sync(struct wl_display *wl_display)
{
struct wl_proxy *callback;
callback = wl_proxy_marshal_constructor((struct wl_proxy *) wl_display,
WL_DISPLAY_SYNC, &wl_callback_interface, NULL);
return (struct wl_callback *) callback;
}
/**
* @ingroup iface_wl_display
*
* This request creates a registry object that allows the client
* to list and bind the global objects available from the
* compositor.
*/
static inline struct wl_registry *
wl_display_get_registry(struct wl_display *wl_display)
{
struct wl_proxy *registry;
registry = wl_proxy_marshal_constructor((struct wl_proxy *) wl_display,
WL_DISPLAY_GET_REGISTRY, &wl_registry_interface, NULL);
return (struct wl_registry *) registry;
}
/**
* @ingroup iface_wl_registry
* @struct wl_registry_listener
*/
struct wl_registry_listener {
/**
* announce global object
*
* Notify the client of global objects.
*
* The event notifies the client that a global object with the
* given name is now available, and it implements the given version
* of the given interface.
* @param name numeric name of the global object
* @param interface interface implemented by the object
* @param version interface version
*/
void (*global)(void *data,
struct wl_registry *wl_registry,
uint32_t name,
const char *interface,
uint32_t version);
/**
* announce removal of global object
*
* Notify the client of removed global objects.
*
* This event notifies the client that the global identified by
* name is no longer available. If the client bound to the global
* using the bind request, the client should now destroy that
* object.
*
* The object remains valid and requests to the object will be
* ignored until the client destroys it, to avoid races between the
* global going away and a client sending a request to it.
* @param name numeric name of the global object
*/
void (*global_remove)(void *data,
struct wl_registry *wl_registry,
uint32_t name);
};
/**
* @ingroup iface_wl_registry
*/
static inline int
wl_registry_add_listener(struct wl_registry *wl_registry,
const struct wl_registry_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_registry,
(void (**)(void)) listener, data);
}
#define WL_REGISTRY_BIND 0
/**
* @ingroup iface_wl_registry
*/
#define WL_REGISTRY_GLOBAL_SINCE_VERSION 1
/**
* @ingroup iface_wl_registry
*/
#define WL_REGISTRY_GLOBAL_REMOVE_SINCE_VERSION 1
/**
* @ingroup iface_wl_registry
*/
#define WL_REGISTRY_BIND_SINCE_VERSION 1
/** @ingroup iface_wl_registry */
static inline void
wl_registry_set_user_data(struct wl_registry *wl_registry, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_registry, user_data);
}
/** @ingroup iface_wl_registry */
static inline void *
wl_registry_get_user_data(struct wl_registry *wl_registry)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_registry);
}
static inline uint32_t
wl_registry_get_version(struct wl_registry *wl_registry)
{
return wl_proxy_get_version((struct wl_proxy *) wl_registry);
}
/** @ingroup iface_wl_registry */
static inline void
wl_registry_destroy(struct wl_registry *wl_registry)
{
wl_proxy_destroy((struct wl_proxy *) wl_registry);
}
/**
* @ingroup iface_wl_registry
*
* Binds a new, client-created object to the server using the
* specified name as the identifier.
*/
static inline void *
wl_registry_bind(struct wl_registry *wl_registry, uint32_t name, const struct wl_interface *interface, uint32_t version)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor_versioned((struct wl_proxy *) wl_registry,
WL_REGISTRY_BIND, interface, version, name, interface->name, version, NULL);
return (void *) id;
}
/**
* @ingroup iface_wl_callback
* @struct wl_callback_listener
*/
struct wl_callback_listener {
/**
* done event
*
* Notify the client when the related request is done.
* @param callback_data request-specific data for the callback
*/
void (*done)(void *data,
struct wl_callback *wl_callback,
uint32_t callback_data);
};
/**
* @ingroup iface_wl_callback
*/
static inline int
wl_callback_add_listener(struct wl_callback *wl_callback,
const struct wl_callback_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_callback,
(void (**)(void)) listener, data);
}
/**
* @ingroup iface_wl_callback
*/
#define WL_CALLBACK_DONE_SINCE_VERSION 1
/** @ingroup iface_wl_callback */
static inline void
wl_callback_set_user_data(struct wl_callback *wl_callback, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_callback, user_data);
}
/** @ingroup iface_wl_callback */
static inline void *
wl_callback_get_user_data(struct wl_callback *wl_callback)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_callback);
}
static inline uint32_t
wl_callback_get_version(struct wl_callback *wl_callback)
{
return wl_proxy_get_version((struct wl_proxy *) wl_callback);
}
/** @ingroup iface_wl_callback */
static inline void
wl_callback_destroy(struct wl_callback *wl_callback)
{
wl_proxy_destroy((struct wl_proxy *) wl_callback);
}
#define WL_COMPOSITOR_CREATE_SURFACE 0
#define WL_COMPOSITOR_CREATE_REGION 1
/**
* @ingroup iface_wl_compositor
*/
#define WL_COMPOSITOR_CREATE_SURFACE_SINCE_VERSION 1
/**
* @ingroup iface_wl_compositor
*/
#define WL_COMPOSITOR_CREATE_REGION_SINCE_VERSION 1
/** @ingroup iface_wl_compositor */
static inline void
wl_compositor_set_user_data(struct wl_compositor *wl_compositor, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_compositor, user_data);
}
/** @ingroup iface_wl_compositor */
static inline void *
wl_compositor_get_user_data(struct wl_compositor *wl_compositor)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_compositor);
}
static inline uint32_t
wl_compositor_get_version(struct wl_compositor *wl_compositor)
{
return wl_proxy_get_version((struct wl_proxy *) wl_compositor);
}
/** @ingroup iface_wl_compositor */
static inline void
wl_compositor_destroy(struct wl_compositor *wl_compositor)
{
wl_proxy_destroy((struct wl_proxy *) wl_compositor);
}
/**
* @ingroup iface_wl_compositor
*
* Ask the compositor to create a new surface.
*/
static inline struct wl_surface *
wl_compositor_create_surface(struct wl_compositor *wl_compositor)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_compositor,
WL_COMPOSITOR_CREATE_SURFACE, &wl_surface_interface, NULL);
return (struct wl_surface *) id;
}
/**
* @ingroup iface_wl_compositor
*
* Ask the compositor to create a new region.
*/
static inline struct wl_region *
wl_compositor_create_region(struct wl_compositor *wl_compositor)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_compositor,
WL_COMPOSITOR_CREATE_REGION, &wl_region_interface, NULL);
return (struct wl_region *) id;
}
#define WL_SHM_POOL_CREATE_BUFFER 0
#define WL_SHM_POOL_DESTROY 1
#define WL_SHM_POOL_RESIZE 2
/**
* @ingroup iface_wl_shm_pool
*/
#define WL_SHM_POOL_CREATE_BUFFER_SINCE_VERSION 1
/**
* @ingroup iface_wl_shm_pool
*/
#define WL_SHM_POOL_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_wl_shm_pool
*/
#define WL_SHM_POOL_RESIZE_SINCE_VERSION 1
/** @ingroup iface_wl_shm_pool */
static inline void
wl_shm_pool_set_user_data(struct wl_shm_pool *wl_shm_pool, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_shm_pool, user_data);
}
/** @ingroup iface_wl_shm_pool */
static inline void *
wl_shm_pool_get_user_data(struct wl_shm_pool *wl_shm_pool)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_shm_pool);
}
static inline uint32_t
wl_shm_pool_get_version(struct wl_shm_pool *wl_shm_pool)
{
return wl_proxy_get_version((struct wl_proxy *) wl_shm_pool);
}
/**
* @ingroup iface_wl_shm_pool
*
* Create a wl_buffer object from the pool.
*
* The buffer is created offset bytes into the pool and has
* width and height as specified. The stride argument specifies
* the number of bytes from the beginning of one row to the beginning
* of the next. The format is the pixel format of the buffer and
* must be one of those advertised through the wl_shm.format event.
*
* A buffer will keep a reference to the pool it was created from
* so it is valid to destroy the pool immediately after creating
* a buffer from it.
*/
static inline struct wl_buffer *
wl_shm_pool_create_buffer(struct wl_shm_pool *wl_shm_pool, int32_t offset, int32_t width, int32_t height, int32_t stride, uint32_t format)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_shm_pool,
WL_SHM_POOL_CREATE_BUFFER, &wl_buffer_interface, NULL, offset, width, height, stride, format);
return (struct wl_buffer *) id;
}
/**
* @ingroup iface_wl_shm_pool
*
* Destroy the shared memory pool.
*
* The mmapped memory will be released when all
* buffers that have been created from this pool
* are gone.
*/
static inline void
wl_shm_pool_destroy(struct wl_shm_pool *wl_shm_pool)
{
wl_proxy_marshal((struct wl_proxy *) wl_shm_pool,
WL_SHM_POOL_DESTROY);
wl_proxy_destroy((struct wl_proxy *) wl_shm_pool);
}
/**
* @ingroup iface_wl_shm_pool
*
* This request will cause the server to remap the backing memory
* for the pool from the file descriptor passed when the pool was
* created, but using the new size. This request can only be
* used to make the pool bigger.
*/
static inline void
wl_shm_pool_resize(struct wl_shm_pool *wl_shm_pool, int32_t size)
{
wl_proxy_marshal((struct wl_proxy *) wl_shm_pool,
WL_SHM_POOL_RESIZE, size);
}
#ifndef WL_SHM_ERROR_ENUM
#define WL_SHM_ERROR_ENUM
/**
* @ingroup iface_wl_shm
* wl_shm error values
*
* These errors can be emitted in response to wl_shm requests.
*/
enum wl_shm_error {
/**
* buffer format is not known
*/
WL_SHM_ERROR_INVALID_FORMAT = 0,
/**
* invalid size or stride during pool or buffer creation
*/
WL_SHM_ERROR_INVALID_STRIDE = 1,
/**
* mmapping the file descriptor failed
*/
WL_SHM_ERROR_INVALID_FD = 2,
};
#endif /* WL_SHM_ERROR_ENUM */
#ifndef WL_SHM_FORMAT_ENUM
#define WL_SHM_FORMAT_ENUM
/**
* @ingroup iface_wl_shm
* pixel formats
*
* This describes the memory layout of an individual pixel.
*
* All renderers should support argb8888 and xrgb8888 but any other
* formats are optional and may not be supported by the particular
* renderer in use.
*
* The drm format codes match the macros defined in drm_fourcc.h.
* The formats actually supported by the compositor will be
* reported by the format event.
*/
enum wl_shm_format {
/**
* 32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian
*/
WL_SHM_FORMAT_ARGB8888 = 0,
/**
* 32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian
*/
WL_SHM_FORMAT_XRGB8888 = 1,
/**
* 8-bit color index format, [7:0] C
*/
WL_SHM_FORMAT_C8 = 0x20203843,
/**
* 8-bit RGB format, [7:0] R:G:B 3:3:2
*/
WL_SHM_FORMAT_RGB332 = 0x38424752,
/**
* 8-bit BGR format, [7:0] B:G:R 2:3:3
*/
WL_SHM_FORMAT_BGR233 = 0x38524742,
/**
* 16-bit xRGB format, [15:0] x:R:G:B 4:4:4:4 little endian
*/
WL_SHM_FORMAT_XRGB4444 = 0x32315258,
/**
* 16-bit xBGR format, [15:0] x:B:G:R 4:4:4:4 little endian
*/
WL_SHM_FORMAT_XBGR4444 = 0x32314258,
/**
* 16-bit RGBx format, [15:0] R:G:B:x 4:4:4:4 little endian
*/
WL_SHM_FORMAT_RGBX4444 = 0x32315852,
/**
* 16-bit BGRx format, [15:0] B:G:R:x 4:4:4:4 little endian
*/
WL_SHM_FORMAT_BGRX4444 = 0x32315842,
/**
* 16-bit ARGB format, [15:0] A:R:G:B 4:4:4:4 little endian
*/
WL_SHM_FORMAT_ARGB4444 = 0x32315241,
/**
* 16-bit ABGR format, [15:0] A:B:G:R 4:4:4:4 little endian
*/
WL_SHM_FORMAT_ABGR4444 = 0x32314241,
/**
* 16-bit RBGA format, [15:0] R:G:B:A 4:4:4:4 little endian
*/
WL_SHM_FORMAT_RGBA4444 = 0x32314152,
/**
* 16-bit BGRA format, [15:0] B:G:R:A 4:4:4:4 little endian
*/
WL_SHM_FORMAT_BGRA4444 = 0x32314142,
/**
* 16-bit xRGB format, [15:0] x:R:G:B 1:5:5:5 little endian
*/
WL_SHM_FORMAT_XRGB1555 = 0x35315258,
/**
* 16-bit xBGR 1555 format, [15:0] x:B:G:R 1:5:5:5 little endian
*/
WL_SHM_FORMAT_XBGR1555 = 0x35314258,
/**
* 16-bit RGBx 5551 format, [15:0] R:G:B:x 5:5:5:1 little endian
*/
WL_SHM_FORMAT_RGBX5551 = 0x35315852,
/**
* 16-bit BGRx 5551 format, [15:0] B:G:R:x 5:5:5:1 little endian
*/
WL_SHM_FORMAT_BGRX5551 = 0x35315842,
/**
* 16-bit ARGB 1555 format, [15:0] A:R:G:B 1:5:5:5 little endian
*/
WL_SHM_FORMAT_ARGB1555 = 0x35315241,
/**
* 16-bit ABGR 1555 format, [15:0] A:B:G:R 1:5:5:5 little endian
*/
WL_SHM_FORMAT_ABGR1555 = 0x35314241,
/**
* 16-bit RGBA 5551 format, [15:0] R:G:B:A 5:5:5:1 little endian
*/
WL_SHM_FORMAT_RGBA5551 = 0x35314152,
/**
* 16-bit BGRA 5551 format, [15:0] B:G:R:A 5:5:5:1 little endian
*/
WL_SHM_FORMAT_BGRA5551 = 0x35314142,
/**
* 16-bit RGB 565 format, [15:0] R:G:B 5:6:5 little endian
*/
WL_SHM_FORMAT_RGB565 = 0x36314752,
/**
* 16-bit BGR 565 format, [15:0] B:G:R 5:6:5 little endian
*/
WL_SHM_FORMAT_BGR565 = 0x36314742,
/**
* 24-bit RGB format, [23:0] R:G:B little endian
*/
WL_SHM_FORMAT_RGB888 = 0x34324752,
/**
* 24-bit BGR format, [23:0] B:G:R little endian
*/
WL_SHM_FORMAT_BGR888 = 0x34324742,
/**
* 32-bit xBGR format, [31:0] x:B:G:R 8:8:8:8 little endian
*/
WL_SHM_FORMAT_XBGR8888 = 0x34324258,
/**
* 32-bit RGBx format, [31:0] R:G:B:x 8:8:8:8 little endian
*/
WL_SHM_FORMAT_RGBX8888 = 0x34325852,
/**
* 32-bit BGRx format, [31:0] B:G:R:x 8:8:8:8 little endian
*/
WL_SHM_FORMAT_BGRX8888 = 0x34325842,
/**
* 32-bit ABGR format, [31:0] A:B:G:R 8:8:8:8 little endian
*/
WL_SHM_FORMAT_ABGR8888 = 0x34324241,
/**
* 32-bit RGBA format, [31:0] R:G:B:A 8:8:8:8 little endian
*/
WL_SHM_FORMAT_RGBA8888 = 0x34324152,
/**
* 32-bit BGRA format, [31:0] B:G:R:A 8:8:8:8 little endian
*/
WL_SHM_FORMAT_BGRA8888 = 0x34324142,
/**
* 32-bit xRGB format, [31:0] x:R:G:B 2:10:10:10 little endian
*/
WL_SHM_FORMAT_XRGB2101010 = 0x30335258,
/**
* 32-bit xBGR format, [31:0] x:B:G:R 2:10:10:10 little endian
*/
WL_SHM_FORMAT_XBGR2101010 = 0x30334258,
/**
* 32-bit RGBx format, [31:0] R:G:B:x 10:10:10:2 little endian
*/
WL_SHM_FORMAT_RGBX1010102 = 0x30335852,
/**
* 32-bit BGRx format, [31:0] B:G:R:x 10:10:10:2 little endian
*/
WL_SHM_FORMAT_BGRX1010102 = 0x30335842,
/**
* 32-bit ARGB format, [31:0] A:R:G:B 2:10:10:10 little endian
*/
WL_SHM_FORMAT_ARGB2101010 = 0x30335241,
/**
* 32-bit ABGR format, [31:0] A:B:G:R 2:10:10:10 little endian
*/
WL_SHM_FORMAT_ABGR2101010 = 0x30334241,
/**
* 32-bit RGBA format, [31:0] R:G:B:A 10:10:10:2 little endian
*/
WL_SHM_FORMAT_RGBA1010102 = 0x30334152,
/**
* 32-bit BGRA format, [31:0] B:G:R:A 10:10:10:2 little endian
*/
WL_SHM_FORMAT_BGRA1010102 = 0x30334142,
/**
* packed YCbCr format, [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian
*/
WL_SHM_FORMAT_YUYV = 0x56595559,
/**
* packed YCbCr format, [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian
*/
WL_SHM_FORMAT_YVYU = 0x55595659,
/**
* packed YCbCr format, [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian
*/
WL_SHM_FORMAT_UYVY = 0x59565955,
/**
* packed YCbCr format, [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian
*/
WL_SHM_FORMAT_VYUY = 0x59555956,
/**
* packed AYCbCr format, [31:0] A:Y:Cb:Cr 8:8:8:8 little endian
*/
WL_SHM_FORMAT_AYUV = 0x56555941,
/**
* 2 plane YCbCr Cr:Cb format, 2x2 subsampled Cr:Cb plane
*/
WL_SHM_FORMAT_NV12 = 0x3231564e,
/**
* 2 plane YCbCr Cb:Cr format, 2x2 subsampled Cb:Cr plane
*/
WL_SHM_FORMAT_NV21 = 0x3132564e,
/**
* 2 plane YCbCr Cr:Cb format, 2x1 subsampled Cr:Cb plane
*/
WL_SHM_FORMAT_NV16 = 0x3631564e,
/**
* 2 plane YCbCr Cb:Cr format, 2x1 subsampled Cb:Cr plane
*/
WL_SHM_FORMAT_NV61 = 0x3136564e,
/**
* 3 plane YCbCr format, 4x4 subsampled Cb (1) and Cr (2) planes
*/
WL_SHM_FORMAT_YUV410 = 0x39565559,
/**
* 3 plane YCbCr format, 4x4 subsampled Cr (1) and Cb (2) planes
*/
WL_SHM_FORMAT_YVU410 = 0x39555659,
/**
* 3 plane YCbCr format, 4x1 subsampled Cb (1) and Cr (2) planes
*/
WL_SHM_FORMAT_YUV411 = 0x31315559,
/**
* 3 plane YCbCr format, 4x1 subsampled Cr (1) and Cb (2) planes
*/
WL_SHM_FORMAT_YVU411 = 0x31315659,
/**
* 3 plane YCbCr format, 2x2 subsampled Cb (1) and Cr (2) planes
*/
WL_SHM_FORMAT_YUV420 = 0x32315559,
/**
* 3 plane YCbCr format, 2x2 subsampled Cr (1) and Cb (2) planes
*/
WL_SHM_FORMAT_YVU420 = 0x32315659,
/**
* 3 plane YCbCr format, 2x1 subsampled Cb (1) and Cr (2) planes
*/
WL_SHM_FORMAT_YUV422 = 0x36315559,
/**
* 3 plane YCbCr format, 2x1 subsampled Cr (1) and Cb (2) planes
*/
WL_SHM_FORMAT_YVU422 = 0x36315659,
/**
* 3 plane YCbCr format, non-subsampled Cb (1) and Cr (2) planes
*/
WL_SHM_FORMAT_YUV444 = 0x34325559,
/**
* 3 plane YCbCr format, non-subsampled Cr (1) and Cb (2) planes
*/
WL_SHM_FORMAT_YVU444 = 0x34325659,
};
#endif /* WL_SHM_FORMAT_ENUM */
/**
* @ingroup iface_wl_shm
* @struct wl_shm_listener
*/
struct wl_shm_listener {
/**
* pixel format description
*
* Informs the client about a valid pixel format that can be used
* for buffers. Known formats include argb8888 and xrgb8888.
* @param format buffer pixel format
*/
void (*format)(void *data,
struct wl_shm *wl_shm,
uint32_t format);
};
/**
* @ingroup iface_wl_shm
*/
static inline int
wl_shm_add_listener(struct wl_shm *wl_shm,
const struct wl_shm_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_shm,
(void (**)(void)) listener, data);
}
#define WL_SHM_CREATE_POOL 0
/**
* @ingroup iface_wl_shm
*/
#define WL_SHM_FORMAT_SINCE_VERSION 1
/**
* @ingroup iface_wl_shm
*/
#define WL_SHM_CREATE_POOL_SINCE_VERSION 1
/** @ingroup iface_wl_shm */
static inline void
wl_shm_set_user_data(struct wl_shm *wl_shm, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_shm, user_data);
}
/** @ingroup iface_wl_shm */
static inline void *
wl_shm_get_user_data(struct wl_shm *wl_shm)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_shm);
}
static inline uint32_t
wl_shm_get_version(struct wl_shm *wl_shm)
{
return wl_proxy_get_version((struct wl_proxy *) wl_shm);
}
/** @ingroup iface_wl_shm */
static inline void
wl_shm_destroy(struct wl_shm *wl_shm)
{
wl_proxy_destroy((struct wl_proxy *) wl_shm);
}
/**
* @ingroup iface_wl_shm
*
* Create a new wl_shm_pool object.
*
* The pool can be used to create shared memory based buffer
* objects. The server will mmap size bytes of the passed file
* descriptor, to use as backing memory for the pool.
*/
static inline struct wl_shm_pool *
wl_shm_create_pool(struct wl_shm *wl_shm, int32_t fd, int32_t size)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_shm,
WL_SHM_CREATE_POOL, &wl_shm_pool_interface, NULL, fd, size);
return (struct wl_shm_pool *) id;
}
/**
* @ingroup iface_wl_buffer
* @struct wl_buffer_listener
*/
struct wl_buffer_listener {
/**
* compositor releases buffer
*
* Sent when this wl_buffer is no longer used by the compositor.
* The client is now free to reuse or destroy this buffer and its
* backing storage.
*
* If a client receives a release event before the frame callback
* requested in the same wl_surface.commit that attaches this
* wl_buffer to a surface, then the client is immediately free to
* reuse the buffer and its backing storage, and does not need a
* second buffer for the next surface content update. Typically
* this is possible, when the compositor maintains a copy of the
* wl_surface contents, e.g. as a GL texture. This is an important
* optimization for GL(ES) compositors with wl_shm clients.
*/
void (*release)(void *data,
struct wl_buffer *wl_buffer);
};
/**
* @ingroup iface_wl_buffer
*/
static inline int
wl_buffer_add_listener(struct wl_buffer *wl_buffer,
const struct wl_buffer_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_buffer,
(void (**)(void)) listener, data);
}
#define WL_BUFFER_DESTROY 0
/**
* @ingroup iface_wl_buffer
*/
#define WL_BUFFER_RELEASE_SINCE_VERSION 1
/**
* @ingroup iface_wl_buffer
*/
#define WL_BUFFER_DESTROY_SINCE_VERSION 1
/** @ingroup iface_wl_buffer */
static inline void
wl_buffer_set_user_data(struct wl_buffer *wl_buffer, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_buffer, user_data);
}
/** @ingroup iface_wl_buffer */
static inline void *
wl_buffer_get_user_data(struct wl_buffer *wl_buffer)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_buffer);
}
static inline uint32_t
wl_buffer_get_version(struct wl_buffer *wl_buffer)
{
return wl_proxy_get_version((struct wl_proxy *) wl_buffer);
}
/**
* @ingroup iface_wl_buffer
*
* Destroy a buffer. If and how you need to release the backing
* storage is defined by the buffer factory interface.
*
* For possible side-effects to a surface, see wl_surface.attach.
*/
static inline void
wl_buffer_destroy(struct wl_buffer *wl_buffer)
{
wl_proxy_marshal((struct wl_proxy *) wl_buffer,
WL_BUFFER_DESTROY);
wl_proxy_destroy((struct wl_proxy *) wl_buffer);
}
#ifndef WL_DATA_OFFER_ERROR_ENUM
#define WL_DATA_OFFER_ERROR_ENUM
enum wl_data_offer_error {
/**
* finish request was called untimely
*/
WL_DATA_OFFER_ERROR_INVALID_FINISH = 0,
/**
* action mask contains invalid values
*/
WL_DATA_OFFER_ERROR_INVALID_ACTION_MASK = 1,
/**
* action argument has an invalid value
*/
WL_DATA_OFFER_ERROR_INVALID_ACTION = 2,
/**
* offer doesn't accept this request
*/
WL_DATA_OFFER_ERROR_INVALID_OFFER = 3,
};
#endif /* WL_DATA_OFFER_ERROR_ENUM */
/**
* @ingroup iface_wl_data_offer
* @struct wl_data_offer_listener
*/
struct wl_data_offer_listener {
/**
* advertise offered mime type
*
* Sent immediately after creating the wl_data_offer object. One
* event per offered mime type.
* @param mime_type offered mime type
*/
void (*offer)(void *data,
struct wl_data_offer *wl_data_offer,
const char *mime_type);
/**
* notify the source-side available actions
*
* This event indicates the actions offered by the data source.
* It will be sent right after wl_data_device.enter, or anytime the
* source side changes its offered actions through
* wl_data_source.set_actions.
* @param source_actions actions offered by the data source
* @since 3
*/
void (*source_actions)(void *data,
struct wl_data_offer *wl_data_offer,
uint32_t source_actions);
/**
* notify the selected action
*
* This event indicates the action selected by the compositor
* after matching the source/destination side actions. Only one
* action (or none) will be offered here.
*
* This event can be emitted multiple times during the
* drag-and-drop operation in response to destination side action
* changes through wl_data_offer.set_actions.
*
* This event will no longer be emitted after wl_data_device.drop
* happened on the drag-and-drop destination, the client must honor
* the last action received, or the last preferred one set through
* wl_data_offer.set_actions when handling an "ask" action.
*
* Compositors may also change the selected action on the fly,
* mainly in response to keyboard modifier changes during the
* drag-and-drop operation.
*
* The most recent action received is always the valid one. Prior
* to receiving wl_data_device.drop, the chosen action may change
* (e.g. due to keyboard modifiers being pressed). At the time of
* receiving wl_data_device.drop the drag-and-drop destination must
* honor the last action received.
*
* Action changes may still happen after wl_data_device.drop,
* especially on "ask" actions, where the drag-and-drop destination
* may choose another action afterwards. Action changes happening
* at this stage are always the result of inter-client negotiation,
* the compositor shall no longer be able to induce a different
* action.
*
* Upon "ask" actions, it is expected that the drag-and-drop
* destination may potentially choose a different action and/or
* mime type, based on wl_data_offer.source_actions and finally
* chosen by the user (e.g. popping up a menu with the available
* options). The final wl_data_offer.set_actions and
* wl_data_offer.accept requests must happen before the call to
* wl_data_offer.finish.
* @param dnd_action action selected by the compositor
* @since 3
*/
void (*action)(void *data,
struct wl_data_offer *wl_data_offer,
uint32_t dnd_action);
};
/**
* @ingroup iface_wl_data_offer
*/
static inline int
wl_data_offer_add_listener(struct wl_data_offer *wl_data_offer,
const struct wl_data_offer_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_data_offer,
(void (**)(void)) listener, data);
}
#define WL_DATA_OFFER_ACCEPT 0
#define WL_DATA_OFFER_RECEIVE 1
#define WL_DATA_OFFER_DESTROY 2
#define WL_DATA_OFFER_FINISH 3
#define WL_DATA_OFFER_SET_ACTIONS 4
/**
* @ingroup iface_wl_data_offer
*/
#define WL_DATA_OFFER_OFFER_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_offer
*/
#define WL_DATA_OFFER_SOURCE_ACTIONS_SINCE_VERSION 3
/**
* @ingroup iface_wl_data_offer
*/
#define WL_DATA_OFFER_ACTION_SINCE_VERSION 3
/**
* @ingroup iface_wl_data_offer
*/
#define WL_DATA_OFFER_ACCEPT_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_offer
*/
#define WL_DATA_OFFER_RECEIVE_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_offer
*/
#define WL_DATA_OFFER_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_offer
*/
#define WL_DATA_OFFER_FINISH_SINCE_VERSION 3
/**
* @ingroup iface_wl_data_offer
*/
#define WL_DATA_OFFER_SET_ACTIONS_SINCE_VERSION 3
/** @ingroup iface_wl_data_offer */
static inline void
wl_data_offer_set_user_data(struct wl_data_offer *wl_data_offer, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_data_offer, user_data);
}
/** @ingroup iface_wl_data_offer */
static inline void *
wl_data_offer_get_user_data(struct wl_data_offer *wl_data_offer)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_data_offer);
}
static inline uint32_t
wl_data_offer_get_version(struct wl_data_offer *wl_data_offer)
{
return wl_proxy_get_version((struct wl_proxy *) wl_data_offer);
}
/**
* @ingroup iface_wl_data_offer
*
* Indicate that the client can accept the given mime type, or
* NULL for not accepted.
*
* For objects of version 2 or older, this request is used by the
* client to give feedback whether the client can receive the given
* mime type, or NULL if none is accepted; the feedback does not
* determine whether the drag-and-drop operation succeeds or not.
*
* For objects of version 3 or newer, this request determines the
* final result of the drag-and-drop operation. If the end result
* is that no mime types were accepted, the drag-and-drop operation
* will be cancelled and the corresponding drag source will receive
* wl_data_source.cancelled. Clients may still use this event in
* conjunction with wl_data_source.action for feedback.
*/
static inline void
wl_data_offer_accept(struct wl_data_offer *wl_data_offer, uint32_t serial, const char *mime_type)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
WL_DATA_OFFER_ACCEPT, serial, mime_type);
}
/**
* @ingroup iface_wl_data_offer
*
* To transfer the offered data, the client issues this request
* and indicates the mime type it wants to receive. The transfer
* happens through the passed file descriptor (typically created
* with the pipe system call). The source client writes the data
* in the mime type representation requested and then closes the
* file descriptor.
*
* The receiving client reads from the read end of the pipe until
* EOF and then closes its end, at which point the transfer is
* complete.
*
* This request may happen multiple times for different mime types,
* both before and after wl_data_device.drop. Drag-and-drop destination
* clients may preemptively fetch data or examine it more closely to
* determine acceptance.
*/
static inline void
wl_data_offer_receive(struct wl_data_offer *wl_data_offer, const char *mime_type, int32_t fd)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
WL_DATA_OFFER_RECEIVE, mime_type, fd);
}
/**
* @ingroup iface_wl_data_offer
*
* Destroy the data offer.
*/
static inline void
wl_data_offer_destroy(struct wl_data_offer *wl_data_offer)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
WL_DATA_OFFER_DESTROY);
wl_proxy_destroy((struct wl_proxy *) wl_data_offer);
}
/**
* @ingroup iface_wl_data_offer
*
* Notifies the compositor that the drag destination successfully
* finished the drag-and-drop operation.
*
* Upon receiving this request, the compositor will emit
* wl_data_source.dnd_finished on the drag source client.
*
* It is a client error to perform other requests than
* wl_data_offer.destroy after this one. It is also an error to perform
* this request after a NULL mime type has been set in
* wl_data_offer.accept or no action was received through
* wl_data_offer.action.
*/
static inline void
wl_data_offer_finish(struct wl_data_offer *wl_data_offer)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
WL_DATA_OFFER_FINISH);
}
/**
* @ingroup iface_wl_data_offer
*
* Sets the actions that the destination side client supports for
* this operation. This request may trigger the emission of
* wl_data_source.action and wl_data_offer.action events if the compositor
* needs to change the selected action.
*
* This request can be called multiple times throughout the
* drag-and-drop operation, typically in response to wl_data_device.enter
* or wl_data_device.motion events.
*
* This request determines the final result of the drag-and-drop
* operation. If the end result is that no action is accepted,
* the drag source will receive wl_drag_source.cancelled.
*
* The dnd_actions argument must contain only values expressed in the
* wl_data_device_manager.dnd_actions enum, and the preferred_action
* argument must only contain one of those values set, otherwise it
* will result in a protocol error.
*
* While managing an "ask" action, the destination drag-and-drop client
* may perform further wl_data_offer.receive requests, and is expected
* to perform one last wl_data_offer.set_actions request with a preferred
* action other than "ask" (and optionally wl_data_offer.accept) before
* requesting wl_data_offer.finish, in order to convey the action selected
* by the user. If the preferred action is not in the
* wl_data_offer.source_actions mask, an error will be raised.
*
* If the "ask" action is dismissed (e.g. user cancellation), the client
* is expected to perform wl_data_offer.destroy right away.
*
* This request can only be made on drag-and-drop offers, a protocol error
* will be raised otherwise.
*/
static inline void
wl_data_offer_set_actions(struct wl_data_offer *wl_data_offer, uint32_t dnd_actions, uint32_t preferred_action)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
WL_DATA_OFFER_SET_ACTIONS, dnd_actions, preferred_action);
}
#ifndef WL_DATA_SOURCE_ERROR_ENUM
#define WL_DATA_SOURCE_ERROR_ENUM
enum wl_data_source_error {
/**
* action mask contains invalid values
*/
WL_DATA_SOURCE_ERROR_INVALID_ACTION_MASK = 0,
/**
* source doesn't accept this request
*/
WL_DATA_SOURCE_ERROR_INVALID_SOURCE = 1,
};
#endif /* WL_DATA_SOURCE_ERROR_ENUM */
/**
* @ingroup iface_wl_data_source
* @struct wl_data_source_listener
*/
struct wl_data_source_listener {
/**
* a target accepts an offered mime type
*
* Sent when a target accepts pointer_focus or motion events. If
* a target does not accept any of the offered types, type is NULL.
*
* Used for feedback during drag-and-drop.
* @param mime_type mime type accepted by the target
*/
void (*target)(void *data,
struct wl_data_source *wl_data_source,
const char *mime_type);
/**
* send the data
*
* Request for data from the client. Send the data as the
* specified mime type over the passed file descriptor, then close
* it.
* @param mime_type mime type for the data
* @param fd file descriptor for the data
*/
void (*send)(void *data,
struct wl_data_source *wl_data_source,
const char *mime_type,
int32_t fd);
/**
* selection was cancelled
*
* This data source is no longer valid. There are several reasons
* why this could happen:
*
* - The data source has been replaced by another data source. -
* The drag-and-drop operation was performed, but the drop
* destination did not accept any of the mime types offered through
* wl_data_source.target. - The drag-and-drop operation was
* performed, but the drop destination did not select any of the
* actions present in the mask offered through
* wl_data_source.action. - The drag-and-drop operation was
* performed but didn't happen over a surface. - The compositor
* cancelled the drag-and-drop operation (e.g. compositor dependent
* timeouts to avoid stale drag-and-drop transfers).
*
* The client should clean up and destroy this data source.
*
* For objects of version 2 or older, wl_data_source.cancelled will
* only be emitted if the data source was replaced by another data
* source.
*/
void (*cancelled)(void *data,
struct wl_data_source *wl_data_source);
/**
* the drag-and-drop operation physically finished
*
* The user performed the drop action. This event does not
* indicate acceptance, wl_data_source.cancelled may still be
* emitted afterwards if the drop destination does not accept any
* mime type.
*
* However, this event might however not be received if the
* compositor cancelled the drag-and-drop operation before this
* event could happen.
*
* Note that the data_source may still be used in the future and
* should not be destroyed here.
* @since 3
*/
void (*dnd_drop_performed)(void *data,
struct wl_data_source *wl_data_source);
/**
* the drag-and-drop operation concluded
*
* The drop destination finished interoperating with this data
* source, so the client is now free to destroy this data source
* and free all associated data.
*
* If the action used to perform the operation was "move", the
* source can now delete the transferred data.
* @since 3
*/
void (*dnd_finished)(void *data,
struct wl_data_source *wl_data_source);
/**
* notify the selected action
*
* This event indicates the action selected by the compositor
* after matching the source/destination side actions. Only one
* action (or none) will be offered here.
*
* This event can be emitted multiple times during the
* drag-and-drop operation, mainly in response to destination side
* changes through wl_data_offer.set_actions, and as the data
* device enters/leaves surfaces.
*
* It is only possible to receive this event after
* wl_data_source.dnd_drop_performed if the drag-and-drop operation
* ended in an "ask" action, in which case the final
* wl_data_source.action event will happen immediately before
* wl_data_source.dnd_finished.
*
* Compositors may also change the selected action on the fly,
* mainly in response to keyboard modifier changes during the
* drag-and-drop operation.
*
* The most recent action received is always the valid one. The
* chosen action may change alongside negotiation (e.g. an "ask"
* action can turn into a "move" operation), so the effects of the
* final action must always be applied in
* wl_data_offer.dnd_finished.
*
* Clients can trigger cursor surface changes from this point, so
* they reflect the current action.
* @param dnd_action action selected by the compositor
* @since 3
*/
void (*action)(void *data,
struct wl_data_source *wl_data_source,
uint32_t dnd_action);
};
/**
* @ingroup iface_wl_data_source
*/
static inline int
wl_data_source_add_listener(struct wl_data_source *wl_data_source,
const struct wl_data_source_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_data_source,
(void (**)(void)) listener, data);
}
#define WL_DATA_SOURCE_OFFER 0
#define WL_DATA_SOURCE_DESTROY 1
#define WL_DATA_SOURCE_SET_ACTIONS 2
/**
* @ingroup iface_wl_data_source
*/
#define WL_DATA_SOURCE_TARGET_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_source
*/
#define WL_DATA_SOURCE_SEND_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_source
*/
#define WL_DATA_SOURCE_CANCELLED_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_source
*/
#define WL_DATA_SOURCE_DND_DROP_PERFORMED_SINCE_VERSION 3
/**
* @ingroup iface_wl_data_source
*/
#define WL_DATA_SOURCE_DND_FINISHED_SINCE_VERSION 3
/**
* @ingroup iface_wl_data_source
*/
#define WL_DATA_SOURCE_ACTION_SINCE_VERSION 3
/**
* @ingroup iface_wl_data_source
*/
#define WL_DATA_SOURCE_OFFER_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_source
*/
#define WL_DATA_SOURCE_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_source
*/
#define WL_DATA_SOURCE_SET_ACTIONS_SINCE_VERSION 3
/** @ingroup iface_wl_data_source */
static inline void
wl_data_source_set_user_data(struct wl_data_source *wl_data_source, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_data_source, user_data);
}
/** @ingroup iface_wl_data_source */
static inline void *
wl_data_source_get_user_data(struct wl_data_source *wl_data_source)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_data_source);
}
static inline uint32_t
wl_data_source_get_version(struct wl_data_source *wl_data_source)
{
return wl_proxy_get_version((struct wl_proxy *) wl_data_source);
}
/**
* @ingroup iface_wl_data_source
*
* This request adds a mime type to the set of mime types
* advertised to targets. Can be called several times to offer
* multiple types.
*/
static inline void
wl_data_source_offer(struct wl_data_source *wl_data_source, const char *mime_type)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_source,
WL_DATA_SOURCE_OFFER, mime_type);
}
/**
* @ingroup iface_wl_data_source
*
* Destroy the data source.
*/
static inline void
wl_data_source_destroy(struct wl_data_source *wl_data_source)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_source,
WL_DATA_SOURCE_DESTROY);
wl_proxy_destroy((struct wl_proxy *) wl_data_source);
}
/**
* @ingroup iface_wl_data_source
*
* Sets the actions that the source side client supports for this
* operation. This request may trigger wl_data_source.action and
* wl_data_offer.action events if the compositor needs to change the
* selected action.
*
* The dnd_actions argument must contain only values expressed in the
* wl_data_device_manager.dnd_actions enum, otherwise it will result
* in a protocol error.
*
* This request must be made once only, and can only be made on sources
* used in drag-and-drop, so it must be performed before
* wl_data_device.start_drag. Attempting to use the source other than
* for drag-and-drop will raise a protocol error.
*/
static inline void
wl_data_source_set_actions(struct wl_data_source *wl_data_source, uint32_t dnd_actions)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_source,
WL_DATA_SOURCE_SET_ACTIONS, dnd_actions);
}
#ifndef WL_DATA_DEVICE_ERROR_ENUM
#define WL_DATA_DEVICE_ERROR_ENUM
enum wl_data_device_error {
/**
* given wl_surface has another role
*/
WL_DATA_DEVICE_ERROR_ROLE = 0,
};
#endif /* WL_DATA_DEVICE_ERROR_ENUM */
/**
* @ingroup iface_wl_data_device
* @struct wl_data_device_listener
*/
struct wl_data_device_listener {
/**
* introduce a new wl_data_offer
*
* The data_offer event introduces a new wl_data_offer object,
* which will subsequently be used in either the data_device.enter
* event (for drag-and-drop) or the data_device.selection event
* (for selections). Immediately following the
* data_device_data_offer event, the new data_offer object will
* send out data_offer.offer events to describe the mime types it
* offers.
* @param id the new data_offer object
*/
void (*data_offer)(void *data,
struct wl_data_device *wl_data_device,
struct wl_data_offer *id);
/**
* initiate drag-and-drop session
*
* This event is sent when an active drag-and-drop pointer enters
* a surface owned by the client. The position of the pointer at
* enter time is provided by the x and y arguments, in
* surface-local coordinates.
* @param serial serial number of the enter event
* @param surface client surface entered
* @param x surface-local x coordinate
* @param y surface-local y coordinate
* @param id source data_offer object
*/
void (*enter)(void *data,
struct wl_data_device *wl_data_device,
uint32_t serial,
struct wl_surface *surface,
wl_fixed_t x,
wl_fixed_t y,
struct wl_data_offer *id);
/**
* end drag-and-drop session
*
* This event is sent when the drag-and-drop pointer leaves the
* surface and the session ends. The client must destroy the
* wl_data_offer introduced at enter time at this point.
*/
void (*leave)(void *data,
struct wl_data_device *wl_data_device);
/**
* drag-and-drop session motion
*
* This event is sent when the drag-and-drop pointer moves within
* the currently focused surface. The new position of the pointer
* is provided by the x and y arguments, in surface-local
* coordinates.
* @param time timestamp with millisecond granularity
* @param x surface-local x coordinate
* @param y surface-local y coordinate
*/
void (*motion)(void *data,
struct wl_data_device *wl_data_device,
uint32_t time,
wl_fixed_t x,
wl_fixed_t y);
/**
* end drag-and-drop session successfully
*
* The event is sent when a drag-and-drop operation is ended
* because the implicit grab is removed.
*
* The drag-and-drop destination is expected to honor the last
* action received through wl_data_offer.action, if the resulting
* action is "copy" or "move", the destination can still perform
* wl_data_offer.receive requests, and is expected to end all
* transfers with a wl_data_offer.finish request.
*
* If the resulting action is "ask", the action will not be
* considered final. The drag-and-drop destination is expected to
* perform one last wl_data_offer.set_actions request, or
* wl_data_offer.destroy in order to cancel the operation.
*/
void (*drop)(void *data,
struct wl_data_device *wl_data_device);
/**
* advertise new selection
*
* The selection event is sent out to notify the client of a new
* wl_data_offer for the selection for this device. The
* data_device.data_offer and the data_offer.offer events are sent
* out immediately before this event to introduce the data offer
* object. The selection event is sent to a client immediately
* before receiving keyboard focus and when a new selection is set
* while the client has keyboard focus. The data_offer is valid
* until a new data_offer or NULL is received or until the client
* loses keyboard focus. The client must destroy the previous
* selection data_offer, if any, upon receiving this event.
* @param id selection data_offer object
*/
void (*selection)(void *data,
struct wl_data_device *wl_data_device,
struct wl_data_offer *id);
};
/**
* @ingroup iface_wl_data_device
*/
static inline int
wl_data_device_add_listener(struct wl_data_device *wl_data_device,
const struct wl_data_device_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_data_device,
(void (**)(void)) listener, data);
}
#define WL_DATA_DEVICE_START_DRAG 0
#define WL_DATA_DEVICE_SET_SELECTION 1
#define WL_DATA_DEVICE_RELEASE 2
/**
* @ingroup iface_wl_data_device
*/
#define WL_DATA_DEVICE_DATA_OFFER_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_device
*/
#define WL_DATA_DEVICE_ENTER_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_device
*/
#define WL_DATA_DEVICE_LEAVE_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_device
*/
#define WL_DATA_DEVICE_MOTION_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_device
*/
#define WL_DATA_DEVICE_DROP_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_device
*/
#define WL_DATA_DEVICE_SELECTION_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_device
*/
#define WL_DATA_DEVICE_START_DRAG_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_device
*/
#define WL_DATA_DEVICE_SET_SELECTION_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_device
*/
#define WL_DATA_DEVICE_RELEASE_SINCE_VERSION 2
/** @ingroup iface_wl_data_device */
static inline void
wl_data_device_set_user_data(struct wl_data_device *wl_data_device, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_data_device, user_data);
}
/** @ingroup iface_wl_data_device */
static inline void *
wl_data_device_get_user_data(struct wl_data_device *wl_data_device)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_data_device);
}
static inline uint32_t
wl_data_device_get_version(struct wl_data_device *wl_data_device)
{
return wl_proxy_get_version((struct wl_proxy *) wl_data_device);
}
/** @ingroup iface_wl_data_device */
static inline void
wl_data_device_destroy(struct wl_data_device *wl_data_device)
{
wl_proxy_destroy((struct wl_proxy *) wl_data_device);
}
/**
* @ingroup iface_wl_data_device
*
* This request asks the compositor to start a drag-and-drop
* operation on behalf of the client.
*
* The source argument is the data source that provides the data
* for the eventual data transfer. If source is NULL, enter, leave
* and motion events are sent only to the client that initiated the
* drag and the client is expected to handle the data passing
* internally.
*
* The origin surface is the surface where the drag originates and
* the client must have an active implicit grab that matches the
* serial.
*
* The icon surface is an optional (can be NULL) surface that
* provides an icon to be moved around with the cursor. Initially,
* the top-left corner of the icon surface is placed at the cursor
* hotspot, but subsequent wl_surface.attach request can move the
* relative position. Attach requests must be confirmed with
* wl_surface.commit as usual. The icon surface is given the role of
* a drag-and-drop icon. If the icon surface already has another role,
* it raises a protocol error.
*
* The current and pending input regions of the icon wl_surface are
* cleared, and wl_surface.set_input_region is ignored until the
* wl_surface is no longer used as the icon surface. When the use
* as an icon ends, the current and pending input regions become
* undefined, and the wl_surface is unmapped.
*/
static inline void
wl_data_device_start_drag(struct wl_data_device *wl_data_device, struct wl_data_source *source, struct wl_surface *origin, struct wl_surface *icon, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_device,
WL_DATA_DEVICE_START_DRAG, source, origin, icon, serial);
}
/**
* @ingroup iface_wl_data_device
*
* This request asks the compositor to set the selection
* to the data from the source on behalf of the client.
*
* To unset the selection, set the source to NULL.
*/
static inline void
wl_data_device_set_selection(struct wl_data_device *wl_data_device, struct wl_data_source *source, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_device,
WL_DATA_DEVICE_SET_SELECTION, source, serial);
}
/**
* @ingroup iface_wl_data_device
*
* This request destroys the data device.
*/
static inline void
wl_data_device_release(struct wl_data_device *wl_data_device)
{
wl_proxy_marshal((struct wl_proxy *) wl_data_device,
WL_DATA_DEVICE_RELEASE);
wl_proxy_destroy((struct wl_proxy *) wl_data_device);
}
#ifndef WL_DATA_DEVICE_MANAGER_DND_ACTION_ENUM
#define WL_DATA_DEVICE_MANAGER_DND_ACTION_ENUM
/**
* @ingroup iface_wl_data_device_manager
* drag and drop actions
*
* This is a bitmask of the available/preferred actions in a
* drag-and-drop operation.
*
* In the compositor, the selected action is a result of matching the
* actions offered by the source and destination sides. "action" events
* with a "none" action will be sent to both source and destination if
* there is no match. All further checks will effectively happen on
* (source actions ∩ destination actions).
*
* In addition, compositors may also pick different actions in
* reaction to key modifiers being pressed. One common design that
* is used in major toolkits (and the behavior recommended for
* compositors) is:
*
* - If no modifiers are pressed, the first match (in bit order)
* will be used.
* - Pressing Shift selects "move", if enabled in the mask.
* - Pressing Control selects "copy", if enabled in the mask.
*
* Behavior beyond that is considered implementation-dependent.
* Compositors may for example bind other modifiers (like Alt/Meta)
* or drags initiated with other buttons than BTN_LEFT to specific
* actions (e.g. "ask").
*/
enum wl_data_device_manager_dnd_action {
/**
* no action
*/
WL_DATA_DEVICE_MANAGER_DND_ACTION_NONE = 0,
/**
* copy action
*/
WL_DATA_DEVICE_MANAGER_DND_ACTION_COPY = 1,
/**
* move action
*/
WL_DATA_DEVICE_MANAGER_DND_ACTION_MOVE = 2,
/**
* ask action
*/
WL_DATA_DEVICE_MANAGER_DND_ACTION_ASK = 4,
};
#endif /* WL_DATA_DEVICE_MANAGER_DND_ACTION_ENUM */
#define WL_DATA_DEVICE_MANAGER_CREATE_DATA_SOURCE 0
#define WL_DATA_DEVICE_MANAGER_GET_DATA_DEVICE 1
/**
* @ingroup iface_wl_data_device_manager
*/
#define WL_DATA_DEVICE_MANAGER_CREATE_DATA_SOURCE_SINCE_VERSION 1
/**
* @ingroup iface_wl_data_device_manager
*/
#define WL_DATA_DEVICE_MANAGER_GET_DATA_DEVICE_SINCE_VERSION 1
/** @ingroup iface_wl_data_device_manager */
static inline void
wl_data_device_manager_set_user_data(struct wl_data_device_manager *wl_data_device_manager, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_data_device_manager, user_data);
}
/** @ingroup iface_wl_data_device_manager */
static inline void *
wl_data_device_manager_get_user_data(struct wl_data_device_manager *wl_data_device_manager)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_data_device_manager);
}
static inline uint32_t
wl_data_device_manager_get_version(struct wl_data_device_manager *wl_data_device_manager)
{
return wl_proxy_get_version((struct wl_proxy *) wl_data_device_manager);
}
/** @ingroup iface_wl_data_device_manager */
static inline void
wl_data_device_manager_destroy(struct wl_data_device_manager *wl_data_device_manager)
{
wl_proxy_destroy((struct wl_proxy *) wl_data_device_manager);
}
/**
* @ingroup iface_wl_data_device_manager
*
* Create a new data source.
*/
static inline struct wl_data_source *
wl_data_device_manager_create_data_source(struct wl_data_device_manager *wl_data_device_manager)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_data_device_manager,
WL_DATA_DEVICE_MANAGER_CREATE_DATA_SOURCE, &wl_data_source_interface, NULL);
return (struct wl_data_source *) id;
}
/**
* @ingroup iface_wl_data_device_manager
*
* Create a new data device for a given seat.
*/
static inline struct wl_data_device *
wl_data_device_manager_get_data_device(struct wl_data_device_manager *wl_data_device_manager, struct wl_seat *seat)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_data_device_manager,
WL_DATA_DEVICE_MANAGER_GET_DATA_DEVICE, &wl_data_device_interface, NULL, seat);
return (struct wl_data_device *) id;
}
#ifndef WL_SHELL_ERROR_ENUM
#define WL_SHELL_ERROR_ENUM
enum wl_shell_error {
/**
* given wl_surface has another role
*/
WL_SHELL_ERROR_ROLE = 0,
};
#endif /* WL_SHELL_ERROR_ENUM */
#define WL_SHELL_GET_SHELL_SURFACE 0
/**
* @ingroup iface_wl_shell
*/
#define WL_SHELL_GET_SHELL_SURFACE_SINCE_VERSION 1
/** @ingroup iface_wl_shell */
static inline void
wl_shell_set_user_data(struct wl_shell *wl_shell, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_shell, user_data);
}
/** @ingroup iface_wl_shell */
static inline void *
wl_shell_get_user_data(struct wl_shell *wl_shell)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_shell);
}
static inline uint32_t
wl_shell_get_version(struct wl_shell *wl_shell)
{
return wl_proxy_get_version((struct wl_proxy *) wl_shell);
}
/** @ingroup iface_wl_shell */
static inline void
wl_shell_destroy(struct wl_shell *wl_shell)
{
wl_proxy_destroy((struct wl_proxy *) wl_shell);
}
/**
* @ingroup iface_wl_shell
*
* Create a shell surface for an existing surface. This gives
* the wl_surface the role of a shell surface. If the wl_surface
* already has another role, it raises a protocol error.
*
* Only one shell surface can be associated with a given surface.
*/
static inline struct wl_shell_surface *
wl_shell_get_shell_surface(struct wl_shell *wl_shell, struct wl_surface *surface)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_shell,
WL_SHELL_GET_SHELL_SURFACE, &wl_shell_surface_interface, NULL, surface);
return (struct wl_shell_surface *) id;
}
#ifndef WL_SHELL_SURFACE_RESIZE_ENUM
#define WL_SHELL_SURFACE_RESIZE_ENUM
/**
* @ingroup iface_wl_shell_surface
* edge values for resizing
*
* These values are used to indicate which edge of a surface
* is being dragged in a resize operation. The server may
* use this information to adapt its behavior, e.g. choose
* an appropriate cursor image.
*/
enum wl_shell_surface_resize {
/**
* no edge
*/
WL_SHELL_SURFACE_RESIZE_NONE = 0,
/**
* top edge
*/
WL_SHELL_SURFACE_RESIZE_TOP = 1,
/**
* bottom edge
*/
WL_SHELL_SURFACE_RESIZE_BOTTOM = 2,
/**
* left edge
*/
WL_SHELL_SURFACE_RESIZE_LEFT = 4,
/**
* top and left edges
*/
WL_SHELL_SURFACE_RESIZE_TOP_LEFT = 5,
/**
* bottom and left edges
*/
WL_SHELL_SURFACE_RESIZE_BOTTOM_LEFT = 6,
/**
* right edge
*/
WL_SHELL_SURFACE_RESIZE_RIGHT = 8,
/**
* top and right edges
*/
WL_SHELL_SURFACE_RESIZE_TOP_RIGHT = 9,
/**
* bottom and right edges
*/
WL_SHELL_SURFACE_RESIZE_BOTTOM_RIGHT = 10,
};
#endif /* WL_SHELL_SURFACE_RESIZE_ENUM */
#ifndef WL_SHELL_SURFACE_TRANSIENT_ENUM
#define WL_SHELL_SURFACE_TRANSIENT_ENUM
/**
* @ingroup iface_wl_shell_surface
* details of transient behaviour
*
* These flags specify details of the expected behaviour
* of transient surfaces. Used in the set_transient request.
*/
enum wl_shell_surface_transient {
/**
* do not set keyboard focus
*/
WL_SHELL_SURFACE_TRANSIENT_INACTIVE = 0x1,
};
#endif /* WL_SHELL_SURFACE_TRANSIENT_ENUM */
#ifndef WL_SHELL_SURFACE_FULLSCREEN_METHOD_ENUM
#define WL_SHELL_SURFACE_FULLSCREEN_METHOD_ENUM
/**
* @ingroup iface_wl_shell_surface
* different method to set the surface fullscreen
*
* Hints to indicate to the compositor how to deal with a conflict
* between the dimensions of the surface and the dimensions of the
* output. The compositor is free to ignore this parameter.
*/
enum wl_shell_surface_fullscreen_method {
/**
* no preference, apply default policy
*/
WL_SHELL_SURFACE_FULLSCREEN_METHOD_DEFAULT = 0,
/**
* scale, preserve the surface's aspect ratio and center on output
*/
WL_SHELL_SURFACE_FULLSCREEN_METHOD_SCALE = 1,
/**
* switch output mode to the smallest mode that can fit the surface, add black borders to compensate size mismatch
*/
WL_SHELL_SURFACE_FULLSCREEN_METHOD_DRIVER = 2,
/**
* no upscaling, center on output and add black borders to compensate size mismatch
*/
WL_SHELL_SURFACE_FULLSCREEN_METHOD_FILL = 3,
};
#endif /* WL_SHELL_SURFACE_FULLSCREEN_METHOD_ENUM */
/**
* @ingroup iface_wl_shell_surface
* @struct wl_shell_surface_listener
*/
struct wl_shell_surface_listener {
/**
* ping client
*
* Ping a client to check if it is receiving events and sending
* requests. A client is expected to reply with a pong request.
* @param serial serial number of the ping
*/
void (*ping)(void *data,
struct wl_shell_surface *wl_shell_surface,
uint32_t serial);
/**
* suggest resize
*
* The configure event asks the client to resize its surface.
*
* The size is a hint, in the sense that the client is free to
* ignore it if it doesn't resize, pick a smaller size (to satisfy
* aspect ratio or resize in steps of NxM pixels).
*
* The edges parameter provides a hint about how the surface was
* resized. The client may use this information to decide how to
* adjust its content to the new size (e.g. a scrolling area might
* adjust its content position to leave the viewable content
* unmoved).
*
* The client is free to dismiss all but the last configure event
* it received.
*
* The width and height arguments specify the size of the window in
* surface-local coordinates.
* @param edges how the surface was resized
* @param width new width of the surface
* @param height new height of the surface
*/
void (*configure)(void *data,
struct wl_shell_surface *wl_shell_surface,
uint32_t edges,
int32_t width,
int32_t height);
/**
* popup interaction is done
*
* The popup_done event is sent out when a popup grab is broken,
* that is, when the user clicks a surface that doesn't belong to
* the client owning the popup surface.
*/
void (*popup_done)(void *data,
struct wl_shell_surface *wl_shell_surface);
};
/**
* @ingroup iface_wl_shell_surface
*/
static inline int
wl_shell_surface_add_listener(struct wl_shell_surface *wl_shell_surface,
const struct wl_shell_surface_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_shell_surface,
(void (**)(void)) listener, data);
}
#define WL_SHELL_SURFACE_PONG 0
#define WL_SHELL_SURFACE_MOVE 1
#define WL_SHELL_SURFACE_RESIZE 2
#define WL_SHELL_SURFACE_SET_TOPLEVEL 3
#define WL_SHELL_SURFACE_SET_TRANSIENT 4
#define WL_SHELL_SURFACE_SET_FULLSCREEN 5
#define WL_SHELL_SURFACE_SET_POPUP 6
#define WL_SHELL_SURFACE_SET_MAXIMIZED 7
#define WL_SHELL_SURFACE_SET_TITLE 8
#define WL_SHELL_SURFACE_SET_CLASS 9
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_PING_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_CONFIGURE_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_POPUP_DONE_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_PONG_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_MOVE_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_RESIZE_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_SET_TOPLEVEL_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_SET_TRANSIENT_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_SET_FULLSCREEN_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_SET_POPUP_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_SET_MAXIMIZED_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_SET_TITLE_SINCE_VERSION 1
/**
* @ingroup iface_wl_shell_surface
*/
#define WL_SHELL_SURFACE_SET_CLASS_SINCE_VERSION 1
/** @ingroup iface_wl_shell_surface */
static inline void
wl_shell_surface_set_user_data(struct wl_shell_surface *wl_shell_surface, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_shell_surface, user_data);
}
/** @ingroup iface_wl_shell_surface */
static inline void *
wl_shell_surface_get_user_data(struct wl_shell_surface *wl_shell_surface)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_shell_surface);
}
static inline uint32_t
wl_shell_surface_get_version(struct wl_shell_surface *wl_shell_surface)
{
return wl_proxy_get_version((struct wl_proxy *) wl_shell_surface);
}
/** @ingroup iface_wl_shell_surface */
static inline void
wl_shell_surface_destroy(struct wl_shell_surface *wl_shell_surface)
{
wl_proxy_destroy((struct wl_proxy *) wl_shell_surface);
}
/**
* @ingroup iface_wl_shell_surface
*
* A client must respond to a ping event with a pong request or
* the client may be deemed unresponsive.
*/
static inline void
wl_shell_surface_pong(struct wl_shell_surface *wl_shell_surface, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_PONG, serial);
}
/**
* @ingroup iface_wl_shell_surface
*
* Start a pointer-driven move of the surface.
*
* This request must be used in response to a button press event.
* The server may ignore move requests depending on the state of
* the surface (e.g. fullscreen or maximized).
*/
static inline void
wl_shell_surface_move(struct wl_shell_surface *wl_shell_surface, struct wl_seat *seat, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_MOVE, seat, serial);
}
/**
* @ingroup iface_wl_shell_surface
*
* Start a pointer-driven resizing of the surface.
*
* This request must be used in response to a button press event.
* The server may ignore resize requests depending on the state of
* the surface (e.g. fullscreen or maximized).
*/
static inline void
wl_shell_surface_resize(struct wl_shell_surface *wl_shell_surface, struct wl_seat *seat, uint32_t serial, uint32_t edges)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_RESIZE, seat, serial, edges);
}
/**
* @ingroup iface_wl_shell_surface
*
* Map the surface as a toplevel surface.
*
* A toplevel surface is not fullscreen, maximized or transient.
*/
static inline void
wl_shell_surface_set_toplevel(struct wl_shell_surface *wl_shell_surface)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_SET_TOPLEVEL);
}
/**
* @ingroup iface_wl_shell_surface
*
* Map the surface relative to an existing surface.
*
* The x and y arguments specify the location of the upper left
* corner of the surface relative to the upper left corner of the
* parent surface, in surface-local coordinates.
*
* The flags argument controls details of the transient behaviour.
*/
static inline void
wl_shell_surface_set_transient(struct wl_shell_surface *wl_shell_surface, struct wl_surface *parent, int32_t x, int32_t y, uint32_t flags)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_SET_TRANSIENT, parent, x, y, flags);
}
/**
* @ingroup iface_wl_shell_surface
*
* Map the surface as a fullscreen surface.
*
* If an output parameter is given then the surface will be made
* fullscreen on that output. If the client does not specify the
* output then the compositor will apply its policy - usually
* choosing the output on which the surface has the biggest surface
* area.
*
* The client may specify a method to resolve a size conflict
* between the output size and the surface size - this is provided
* through the method parameter.
*
* The framerate parameter is used only when the method is set
* to "driver", to indicate the preferred framerate. A value of 0
* indicates that the client does not care about framerate. The
* framerate is specified in mHz, that is framerate of 60000 is 60Hz.
*
* A method of "scale" or "driver" implies a scaling operation of
* the surface, either via a direct scaling operation or a change of
* the output mode. This will override any kind of output scaling, so
* that mapping a surface with a buffer size equal to the mode can
* fill the screen independent of buffer_scale.
*
* A method of "fill" means we don't scale up the buffer, however
* any output scale is applied. This means that you may run into
* an edge case where the application maps a buffer with the same
* size of the output mode but buffer_scale 1 (thus making a
* surface larger than the output). In this case it is allowed to
* downscale the results to fit the screen.
*
* The compositor must reply to this request with a configure event
* with the dimensions for the output on which the surface will
* be made fullscreen.
*/
static inline void
wl_shell_surface_set_fullscreen(struct wl_shell_surface *wl_shell_surface, uint32_t method, uint32_t framerate, struct wl_output *output)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_SET_FULLSCREEN, method, framerate, output);
}
/**
* @ingroup iface_wl_shell_surface
*
* Map the surface as a popup.
*
* A popup surface is a transient surface with an added pointer
* grab.
*
* An existing implicit grab will be changed to owner-events mode,
* and the popup grab will continue after the implicit grab ends
* (i.e. releasing the mouse button does not cause the popup to
* be unmapped).
*
* The popup grab continues until the window is destroyed or a
* mouse button is pressed in any other client's window. A click
* in any of the client's surfaces is reported as normal, however,
* clicks in other clients' surfaces will be discarded and trigger
* the callback.
*
* The x and y arguments specify the location of the upper left
* corner of the surface relative to the upper left corner of the
* parent surface, in surface-local coordinates.
*/
static inline void
wl_shell_surface_set_popup(struct wl_shell_surface *wl_shell_surface, struct wl_seat *seat, uint32_t serial, struct wl_surface *parent, int32_t x, int32_t y, uint32_t flags)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_SET_POPUP, seat, serial, parent, x, y, flags);
}
/**
* @ingroup iface_wl_shell_surface
*
* Map the surface as a maximized surface.
*
* If an output parameter is given then the surface will be
* maximized on that output. If the client does not specify the
* output then the compositor will apply its policy - usually
* choosing the output on which the surface has the biggest surface
* area.
*
* The compositor will reply with a configure event telling
* the expected new surface size. The operation is completed
* on the next buffer attach to this surface.
*
* A maximized surface typically fills the entire output it is
* bound to, except for desktop elements such as panels. This is
* the main difference between a maximized shell surface and a
* fullscreen shell surface.
*
* The details depend on the compositor implementation.
*/
static inline void
wl_shell_surface_set_maximized(struct wl_shell_surface *wl_shell_surface, struct wl_output *output)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_SET_MAXIMIZED, output);
}
/**
* @ingroup iface_wl_shell_surface
*
* Set a short title for the surface.
*
* This string may be used to identify the surface in a task bar,
* window list, or other user interface elements provided by the
* compositor.
*
* The string must be encoded in UTF-8.
*/
static inline void
wl_shell_surface_set_title(struct wl_shell_surface *wl_shell_surface, const char *title)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_SET_TITLE, title);
}
/**
* @ingroup iface_wl_shell_surface
*
* Set a class for the surface.
*
* The surface class identifies the general class of applications
* to which the surface belongs. A common convention is to use the
* file name (or the full path if it is a non-standard location) of
* the application's .desktop file as the class.
*/
static inline void
wl_shell_surface_set_class(struct wl_shell_surface *wl_shell_surface, const char *class_)
{
wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
WL_SHELL_SURFACE_SET_CLASS, class_);
}
#ifndef WL_SURFACE_ERROR_ENUM
#define WL_SURFACE_ERROR_ENUM
/**
* @ingroup iface_wl_surface
* wl_surface error values
*
* These errors can be emitted in response to wl_surface requests.
*/
enum wl_surface_error {
/**
* buffer scale value is invalid
*/
WL_SURFACE_ERROR_INVALID_SCALE = 0,
/**
* buffer transform value is invalid
*/
WL_SURFACE_ERROR_INVALID_TRANSFORM = 1,
};
#endif /* WL_SURFACE_ERROR_ENUM */
/**
* @ingroup iface_wl_surface
* @struct wl_surface_listener
*/
struct wl_surface_listener {
/**
* surface enters an output
*
* This is emitted whenever a surface's creation, movement, or
* resizing results in some part of it being within the scanout
* region of an output.
*
* Note that a surface may be overlapping with zero or more
* outputs.
* @param output output entered by the surface
*/
void (*enter)(void *data,
struct wl_surface *wl_surface,
struct wl_output *output);
/**
* surface leaves an output
*
* This is emitted whenever a surface's creation, movement, or
* resizing results in it no longer having any part of it within
* the scanout region of an output.
* @param output output left by the surface
*/
void (*leave)(void *data,
struct wl_surface *wl_surface,
struct wl_output *output);
};
/**
* @ingroup iface_wl_surface
*/
static inline int
wl_surface_add_listener(struct wl_surface *wl_surface,
const struct wl_surface_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_surface,
(void (**)(void)) listener, data);
}
#define WL_SURFACE_DESTROY 0
#define WL_SURFACE_ATTACH 1
#define WL_SURFACE_DAMAGE 2
#define WL_SURFACE_FRAME 3
#define WL_SURFACE_SET_OPAQUE_REGION 4
#define WL_SURFACE_SET_INPUT_REGION 5
#define WL_SURFACE_COMMIT 6
#define WL_SURFACE_SET_BUFFER_TRANSFORM 7
#define WL_SURFACE_SET_BUFFER_SCALE 8
#define WL_SURFACE_DAMAGE_BUFFER 9
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_ENTER_SINCE_VERSION 1
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_LEAVE_SINCE_VERSION 1
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_ATTACH_SINCE_VERSION 1
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_DAMAGE_SINCE_VERSION 1
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_FRAME_SINCE_VERSION 1
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_SET_OPAQUE_REGION_SINCE_VERSION 1
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_SET_INPUT_REGION_SINCE_VERSION 1
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_COMMIT_SINCE_VERSION 1
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_SET_BUFFER_TRANSFORM_SINCE_VERSION 2
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_SET_BUFFER_SCALE_SINCE_VERSION 3
/**
* @ingroup iface_wl_surface
*/
#define WL_SURFACE_DAMAGE_BUFFER_SINCE_VERSION 4
/** @ingroup iface_wl_surface */
static inline void
wl_surface_set_user_data(struct wl_surface *wl_surface, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_surface, user_data);
}
/** @ingroup iface_wl_surface */
static inline void *
wl_surface_get_user_data(struct wl_surface *wl_surface)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_surface);
}
static inline uint32_t
wl_surface_get_version(struct wl_surface *wl_surface)
{
return wl_proxy_get_version((struct wl_proxy *) wl_surface);
}
/**
* @ingroup iface_wl_surface
*
* Deletes the surface and invalidates its object ID.
*/
static inline void
wl_surface_destroy(struct wl_surface *wl_surface)
{
wl_proxy_marshal((struct wl_proxy *) wl_surface,
WL_SURFACE_DESTROY);
wl_proxy_destroy((struct wl_proxy *) wl_surface);
}
/**
* @ingroup iface_wl_surface
*
* Set a buffer as the content of this surface.
*
* The new size of the surface is calculated based on the buffer
* size transformed by the inverse buffer_transform and the
* inverse buffer_scale. This means that the supplied buffer
* must be an integer multiple of the buffer_scale.
*
* The x and y arguments specify the location of the new pending
* buffer's upper left corner, relative to the current buffer's upper
* left corner, in surface-local coordinates. In other words, the
* x and y, combined with the new surface size define in which
* directions the surface's size changes.
*
* Surface contents are double-buffered state, see wl_surface.commit.
*
* The initial surface contents are void; there is no content.
* wl_surface.attach assigns the given wl_buffer as the pending
* wl_buffer. wl_surface.commit makes the pending wl_buffer the new
* surface contents, and the size of the surface becomes the size
* calculated from the wl_buffer, as described above. After commit,
* there is no pending buffer until the next attach.
*
* Committing a pending wl_buffer allows the compositor to read the
* pixels in the wl_buffer. The compositor may access the pixels at
* any time after the wl_surface.commit request. When the compositor
* will not access the pixels anymore, it will send the
* wl_buffer.release event. Only after receiving wl_buffer.release,
* the client may reuse the wl_buffer. A wl_buffer that has been
* attached and then replaced by another attach instead of committed
* will not receive a release event, and is not used by the
* compositor.
*
* Destroying the wl_buffer after wl_buffer.release does not change
* the surface contents. However, if the client destroys the
* wl_buffer before receiving the wl_buffer.release event, the surface
* contents become undefined immediately.
*
* If wl_surface.attach is sent with a NULL wl_buffer, the
* following wl_surface.commit will remove the surface content.
*/
static inline void
wl_surface_attach(struct wl_surface *wl_surface, struct wl_buffer *buffer, int32_t x, int32_t y)
{
wl_proxy_marshal((struct wl_proxy *) wl_surface,
WL_SURFACE_ATTACH, buffer, x, y);
}
/**
* @ingroup iface_wl_surface
*
* This request is used to describe the regions where the pending
* buffer is different from the current surface contents, and where
* the surface therefore needs to be repainted. The compositor
* ignores the parts of the damage that fall outside of the surface.
*
* Damage is double-buffered state, see wl_surface.commit.
*
* The damage rectangle is specified in surface-local coordinates,
* where x and y specify the upper left corner of the damage rectangle.
*
* The initial value for pending damage is empty: no damage.
* wl_surface.damage adds pending damage: the new pending damage
* is the union of old pending damage and the given rectangle.
*
* wl_surface.commit assigns pending damage as the current damage,
* and clears pending damage. The server will clear the current
* damage as it repaints the surface.
*
* Alternatively, damage can be posted with wl_surface.damage_buffer
* which uses buffer coordinates instead of surface coordinates,
* and is probably the preferred and intuitive way of doing this.
*/
static inline void
wl_surface_damage(struct wl_surface *wl_surface, int32_t x, int32_t y, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) wl_surface,
WL_SURFACE_DAMAGE, x, y, width, height);
}
/**
* @ingroup iface_wl_surface
*
* Request a notification when it is a good time to start drawing a new
* frame, by creating a frame callback. This is useful for throttling
* redrawing operations, and driving animations.
*
* When a client is animating on a wl_surface, it can use the 'frame'
* request to get notified when it is a good time to draw and commit the
* next frame of animation. If the client commits an update earlier than
* that, it is likely that some updates will not make it to the display,
* and the client is wasting resources by drawing too often.
*
* The frame request will take effect on the next wl_surface.commit.
* The notification will only be posted for one frame unless
* requested again. For a wl_surface, the notifications are posted in
* the order the frame requests were committed.
*
* The server must send the notifications so that a client
* will not send excessive updates, while still allowing
* the highest possible update rate for clients that wait for the reply
* before drawing again. The server should give some time for the client
* to draw and commit after sending the frame callback events to let it
* hit the next output refresh.
*
* A server should avoid signaling the frame callbacks if the
* surface is not visible in any way, e.g. the surface is off-screen,
* or completely obscured by other opaque surfaces.
*
* The object returned by this request will be destroyed by the
* compositor after the callback is fired and as such the client must not
* attempt to use it after that point.
*
* The callback_data passed in the callback is the current time, in
* milliseconds, with an undefined base.
*/
static inline struct wl_callback *
wl_surface_frame(struct wl_surface *wl_surface)
{
struct wl_proxy *callback;
callback = wl_proxy_marshal_constructor((struct wl_proxy *) wl_surface,
WL_SURFACE_FRAME, &wl_callback_interface, NULL);
return (struct wl_callback *) callback;
}
/**
* @ingroup iface_wl_surface
*
* This request sets the region of the surface that contains
* opaque content.
*
* The opaque region is an optimization hint for the compositor
* that lets it optimize the redrawing of content behind opaque
* regions. Setting an opaque region is not required for correct
* behaviour, but marking transparent content as opaque will result
* in repaint artifacts.
*
* The opaque region is specified in surface-local coordinates.
*
* The compositor ignores the parts of the opaque region that fall
* outside of the surface.
*
* Opaque region is double-buffered state, see wl_surface.commit.
*
* wl_surface.set_opaque_region changes the pending opaque region.
* wl_surface.commit copies the pending region to the current region.
* Otherwise, the pending and current regions are never changed.
*
* The initial value for an opaque region is empty. Setting the pending
* opaque region has copy semantics, and the wl_region object can be
* destroyed immediately. A NULL wl_region causes the pending opaque
* region to be set to empty.
*/
static inline void
wl_surface_set_opaque_region(struct wl_surface *wl_surface, struct wl_region *region)
{
wl_proxy_marshal((struct wl_proxy *) wl_surface,
WL_SURFACE_SET_OPAQUE_REGION, region);
}
/**
* @ingroup iface_wl_surface
*
* This request sets the region of the surface that can receive
* pointer and touch events.
*
* Input events happening outside of this region will try the next
* surface in the server surface stack. The compositor ignores the
* parts of the input region that fall outside of the surface.
*
* The input region is specified in surface-local coordinates.
*
* Input region is double-buffered state, see wl_surface.commit.
*
* wl_surface.set_input_region changes the pending input region.
* wl_surface.commit copies the pending region to the current region.
* Otherwise the pending and current regions are never changed,
* except cursor and icon surfaces are special cases, see
* wl_pointer.set_cursor and wl_data_device.start_drag.
*
* The initial value for an input region is infinite. That means the
* whole surface will accept input. Setting the pending input region
* has copy semantics, and the wl_region object can be destroyed
* immediately. A NULL wl_region causes the input region to be set
* to infinite.
*/
static inline void
wl_surface_set_input_region(struct wl_surface *wl_surface, struct wl_region *region)
{
wl_proxy_marshal((struct wl_proxy *) wl_surface,
WL_SURFACE_SET_INPUT_REGION, region);
}
/**
* @ingroup iface_wl_surface
*
* Surface state (input, opaque, and damage regions, attached buffers,
* etc.) is double-buffered. Protocol requests modify the pending state,
* as opposed to the current state in use by the compositor. A commit
* request atomically applies all pending state, replacing the current
* state. After commit, the new pending state is as documented for each
* related request.
*
* On commit, a pending wl_buffer is applied first, and all other state
* second. This means that all coordinates in double-buffered state are
* relative to the new wl_buffer coming into use, except for
* wl_surface.attach itself. If there is no pending wl_buffer, the
* coordinates are relative to the current surface contents.
*
* All requests that need a commit to become effective are documented
* to affect double-buffered state.
*
* Other interfaces may add further double-buffered surface state.
*/
static inline void
wl_surface_commit(struct wl_surface *wl_surface)
{
wl_proxy_marshal((struct wl_proxy *) wl_surface,
WL_SURFACE_COMMIT);
}
/**
* @ingroup iface_wl_surface
*
* This request sets an optional transformation on how the compositor
* interprets the contents of the buffer attached to the surface. The
* accepted values for the transform parameter are the values for
* wl_output.transform.
*
* Buffer transform is double-buffered state, see wl_surface.commit.
*
* A newly created surface has its buffer transformation set to normal.
*
* wl_surface.set_buffer_transform changes the pending buffer
* transformation. wl_surface.commit copies the pending buffer
* transformation to the current one. Otherwise, the pending and current
* values are never changed.
*
* The purpose of this request is to allow clients to render content
* according to the output transform, thus permitting the compositor to
* use certain optimizations even if the display is rotated. Using
* hardware overlays and scanning out a client buffer for fullscreen
* surfaces are examples of such optimizations. Those optimizations are
* highly dependent on the compositor implementation, so the use of this
* request should be considered on a case-by-case basis.
*
* Note that if the transform value includes 90 or 270 degree rotation,
* the width of the buffer will become the surface height and the height
* of the buffer will become the surface width.
*
* If transform is not one of the values from the
* wl_output.transform enum the invalid_transform protocol error
* is raised.
*/
static inline void
wl_surface_set_buffer_transform(struct wl_surface *wl_surface, int32_t transform)
{
wl_proxy_marshal((struct wl_proxy *) wl_surface,
WL_SURFACE_SET_BUFFER_TRANSFORM, transform);
}
/**
* @ingroup iface_wl_surface
*
* This request sets an optional scaling factor on how the compositor
* interprets the contents of the buffer attached to the window.
*
* Buffer scale is double-buffered state, see wl_surface.commit.
*
* A newly created surface has its buffer scale set to 1.
*
* wl_surface.set_buffer_scale changes the pending buffer scale.
* wl_surface.commit copies the pending buffer scale to the current one.
* Otherwise, the pending and current values are never changed.
*
* The purpose of this request is to allow clients to supply higher
* resolution buffer data for use on high resolution outputs. It is
* intended that you pick the same buffer scale as the scale of the
* output that the surface is displayed on. This means the compositor
* can avoid scaling when rendering the surface on that output.
*
* Note that if the scale is larger than 1, then you have to attach
* a buffer that is larger (by a factor of scale in each dimension)
* than the desired surface size.
*
* If scale is not positive the invalid_scale protocol error is
* raised.
*/
static inline void
wl_surface_set_buffer_scale(struct wl_surface *wl_surface, int32_t scale)
{
wl_proxy_marshal((struct wl_proxy *) wl_surface,
WL_SURFACE_SET_BUFFER_SCALE, scale);
}
/**
* @ingroup iface_wl_surface
*
* This request is used to describe the regions where the pending
* buffer is different from the current surface contents, and where
* the surface therefore needs to be repainted. The compositor
* ignores the parts of the damage that fall outside of the surface.
*
* Damage is double-buffered state, see wl_surface.commit.
*
* The damage rectangle is specified in buffer coordinates,
* where x and y specify the upper left corner of the damage rectangle.
*
* The initial value for pending damage is empty: no damage.
* wl_surface.damage_buffer adds pending damage: the new pending
* damage is the union of old pending damage and the given rectangle.
*
* wl_surface.commit assigns pending damage as the current damage,
* and clears pending damage. The server will clear the current
* damage as it repaints the surface.
*
* This request differs from wl_surface.damage in only one way - it
* takes damage in buffer coordinates instead of surface-local
* coordinates. While this generally is more intuitive than surface
* coordinates, it is especially desirable when using wp_viewport
* or when a drawing library (like EGL) is unaware of buffer scale
* and buffer transform.
*
* Note: Because buffer transformation changes and damage requests may
* be interleaved in the protocol stream, it is impossible to determine
* the actual mapping between surface and buffer damage until
* wl_surface.commit time. Therefore, compositors wishing to take both
* kinds of damage into account will have to accumulate damage from the
* two requests separately and only transform from one to the other
* after receiving the wl_surface.commit.
*/
static inline void
wl_surface_damage_buffer(struct wl_surface *wl_surface, int32_t x, int32_t y, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) wl_surface,
WL_SURFACE_DAMAGE_BUFFER, x, y, width, height);
}
#ifndef WL_SEAT_CAPABILITY_ENUM
#define WL_SEAT_CAPABILITY_ENUM
/**
* @ingroup iface_wl_seat
* seat capability bitmask
*
* This is a bitmask of capabilities this seat has; if a member is
* set, then it is present on the seat.
*/
enum wl_seat_capability {
/**
* the seat has pointer devices
*/
WL_SEAT_CAPABILITY_POINTER = 1,
/**
* the seat has one or more keyboards
*/
WL_SEAT_CAPABILITY_KEYBOARD = 2,
/**
* the seat has touch devices
*/
WL_SEAT_CAPABILITY_TOUCH = 4,
};
#endif /* WL_SEAT_CAPABILITY_ENUM */
/**
* @ingroup iface_wl_seat
* @struct wl_seat_listener
*/
struct wl_seat_listener {
/**
* seat capabilities changed
*
* This is emitted whenever a seat gains or loses the pointer,
* keyboard or touch capabilities. The argument is a capability
* enum containing the complete set of capabilities this seat has.
*
* When the pointer capability is added, a client may create a
* wl_pointer object using the wl_seat.get_pointer request. This
* object will receive pointer events until the capability is
* removed in the future.
*
* When the pointer capability is removed, a client should destroy
* the wl_pointer objects associated with the seat where the
* capability was removed, using the wl_pointer.release request. No
* further pointer events will be received on these objects.
*
* In some compositors, if a seat regains the pointer capability
* and a client has a previously obtained wl_pointer object of
* version 4 or less, that object may start sending pointer events
* again. This behavior is considered a misinterpretation of the
* intended behavior and must not be relied upon by the client.
* wl_pointer objects of version 5 or later must not send events if
* created before the most recent event notifying the client of an
* added pointer capability.
*
* The above behavior also applies to wl_keyboard and wl_touch with
* the keyboard and touch capabilities, respectively.
* @param capabilities capabilities of the seat
*/
void (*capabilities)(void *data,
struct wl_seat *wl_seat,
uint32_t capabilities);
/**
* unique identifier for this seat
*
* In a multiseat configuration this can be used by the client to
* help identify which physical devices the seat represents. Based
* on the seat configuration used by the compositor.
* @param name seat identifier
* @since 2
*/
void (*name)(void *data,
struct wl_seat *wl_seat,
const char *name);
};
/**
* @ingroup iface_wl_seat
*/
static inline int
wl_seat_add_listener(struct wl_seat *wl_seat,
const struct wl_seat_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_seat,
(void (**)(void)) listener, data);
}
#define WL_SEAT_GET_POINTER 0
#define WL_SEAT_GET_KEYBOARD 1
#define WL_SEAT_GET_TOUCH 2
#define WL_SEAT_RELEASE 3
/**
* @ingroup iface_wl_seat
*/
#define WL_SEAT_CAPABILITIES_SINCE_VERSION 1
/**
* @ingroup iface_wl_seat
*/
#define WL_SEAT_NAME_SINCE_VERSION 2
/**
* @ingroup iface_wl_seat
*/
#define WL_SEAT_GET_POINTER_SINCE_VERSION 1
/**
* @ingroup iface_wl_seat
*/
#define WL_SEAT_GET_KEYBOARD_SINCE_VERSION 1
/**
* @ingroup iface_wl_seat
*/
#define WL_SEAT_GET_TOUCH_SINCE_VERSION 1
/**
* @ingroup iface_wl_seat
*/
#define WL_SEAT_RELEASE_SINCE_VERSION 5
/** @ingroup iface_wl_seat */
static inline void
wl_seat_set_user_data(struct wl_seat *wl_seat, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_seat, user_data);
}
/** @ingroup iface_wl_seat */
static inline void *
wl_seat_get_user_data(struct wl_seat *wl_seat)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_seat);
}
static inline uint32_t
wl_seat_get_version(struct wl_seat *wl_seat)
{
return wl_proxy_get_version((struct wl_proxy *) wl_seat);
}
/** @ingroup iface_wl_seat */
static inline void
wl_seat_destroy(struct wl_seat *wl_seat)
{
wl_proxy_destroy((struct wl_proxy *) wl_seat);
}
/**
* @ingroup iface_wl_seat
*
* The ID provided will be initialized to the wl_pointer interface
* for this seat.
*
* This request only takes effect if the seat has the pointer
* capability, or has had the pointer capability in the past.
* It is a protocol violation to issue this request on a seat that has
* never had the pointer capability.
*/
static inline struct wl_pointer *
wl_seat_get_pointer(struct wl_seat *wl_seat)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_seat,
WL_SEAT_GET_POINTER, &wl_pointer_interface, NULL);
return (struct wl_pointer *) id;
}
/**
* @ingroup iface_wl_seat
*
* The ID provided will be initialized to the wl_keyboard interface
* for this seat.
*
* This request only takes effect if the seat has the keyboard
* capability, or has had the keyboard capability in the past.
* It is a protocol violation to issue this request on a seat that has
* never had the keyboard capability.
*/
static inline struct wl_keyboard *
wl_seat_get_keyboard(struct wl_seat *wl_seat)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_seat,
WL_SEAT_GET_KEYBOARD, &wl_keyboard_interface, NULL);
return (struct wl_keyboard *) id;
}
/**
* @ingroup iface_wl_seat
*
* The ID provided will be initialized to the wl_touch interface
* for this seat.
*
* This request only takes effect if the seat has the touch
* capability, or has had the touch capability in the past.
* It is a protocol violation to issue this request on a seat that has
* never had the touch capability.
*/
static inline struct wl_touch *
wl_seat_get_touch(struct wl_seat *wl_seat)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_seat,
WL_SEAT_GET_TOUCH, &wl_touch_interface, NULL);
return (struct wl_touch *) id;
}
/**
* @ingroup iface_wl_seat
*
* Using this request a client can tell the server that it is not going to
* use the seat object anymore.
*/
static inline void
wl_seat_release(struct wl_seat *wl_seat)
{
wl_proxy_marshal((struct wl_proxy *) wl_seat,
WL_SEAT_RELEASE);
wl_proxy_destroy((struct wl_proxy *) wl_seat);
}
#ifndef WL_POINTER_ERROR_ENUM
#define WL_POINTER_ERROR_ENUM
enum wl_pointer_error {
/**
* given wl_surface has another role
*/
WL_POINTER_ERROR_ROLE = 0,
};
#endif /* WL_POINTER_ERROR_ENUM */
#ifndef WL_POINTER_BUTTON_STATE_ENUM
#define WL_POINTER_BUTTON_STATE_ENUM
/**
* @ingroup iface_wl_pointer
* physical button state
*
* Describes the physical state of a button that produced the button
* event.
*/
enum wl_pointer_button_state {
/**
* the button is not pressed
*/
WL_POINTER_BUTTON_STATE_RELEASED = 0,
/**
* the button is pressed
*/
WL_POINTER_BUTTON_STATE_PRESSED = 1,
};
#endif /* WL_POINTER_BUTTON_STATE_ENUM */
#ifndef WL_POINTER_AXIS_ENUM
#define WL_POINTER_AXIS_ENUM
/**
* @ingroup iface_wl_pointer
* axis types
*
* Describes the axis types of scroll events.
*/
enum wl_pointer_axis {
/**
* vertical axis
*/
WL_POINTER_AXIS_VERTICAL_SCROLL = 0,
/**
* horizontal axis
*/
WL_POINTER_AXIS_HORIZONTAL_SCROLL = 1,
};
#endif /* WL_POINTER_AXIS_ENUM */
#ifndef WL_POINTER_AXIS_SOURCE_ENUM
#define WL_POINTER_AXIS_SOURCE_ENUM
/**
* @ingroup iface_wl_pointer
* axis source types
*
* Describes the source types for axis events. This indicates to the
* client how an axis event was physically generated; a client may
* adjust the user interface accordingly. For example, scroll events
* from a "finger" source may be in a smooth coordinate space with
* kinetic scrolling whereas a "wheel" source may be in discrete steps
* of a number of lines.
*
* The "continuous" axis source is a device generating events in a
* continuous coordinate space, but using something other than a
* finger. One example for this source is button-based scrolling where
* the vertical motion of a device is converted to scroll events while
* a button is held down.
*/
enum wl_pointer_axis_source {
/**
* a physical wheel rotation
*/
WL_POINTER_AXIS_SOURCE_WHEEL = 0,
/**
* finger on a touch surface
*/
WL_POINTER_AXIS_SOURCE_FINGER = 1,
/**
* continuous coordinate space
*/
WL_POINTER_AXIS_SOURCE_CONTINUOUS = 2,
};
#endif /* WL_POINTER_AXIS_SOURCE_ENUM */
/**
* @ingroup iface_wl_pointer
* @struct wl_pointer_listener
*/
struct wl_pointer_listener {
/**
* enter event
*
* Notification that this seat's pointer is focused on a certain
* surface.
*
* When a seat's focus enters a surface, the pointer image is
* undefined and a client should respond to this event by setting
* an appropriate pointer image with the set_cursor request.
* @param serial serial number of the enter event
* @param surface surface entered by the pointer
* @param surface_x surface-local x coordinate
* @param surface_y surface-local y coordinate
*/
void (*enter)(void *data,
struct wl_pointer *wl_pointer,
uint32_t serial,
struct wl_surface *surface,
wl_fixed_t surface_x,
wl_fixed_t surface_y);
/**
* leave event
*
* Notification that this seat's pointer is no longer focused on
* a certain surface.
*
* The leave notification is sent before the enter notification for
* the new focus.
* @param serial serial number of the leave event
* @param surface surface left by the pointer
*/
void (*leave)(void *data,
struct wl_pointer *wl_pointer,
uint32_t serial,
struct wl_surface *surface);
/**
* pointer motion event
*
* Notification of pointer location change. The arguments
* surface_x and surface_y are the location relative to the focused
* surface.
* @param time timestamp with millisecond granularity
* @param surface_x surface-local x coordinate
* @param surface_y surface-local y coordinate
*/
void (*motion)(void *data,
struct wl_pointer *wl_pointer,
uint32_t time,
wl_fixed_t surface_x,
wl_fixed_t surface_y);
/**
* pointer button event
*
* Mouse button click and release notifications.
*
* The location of the click is given by the last motion or enter
* event. The time argument is a timestamp with millisecond
* granularity, with an undefined base.
*
* The button is a button code as defined in the Linux kernel's
* linux/input-event-codes.h header file, e.g. BTN_LEFT.
*
* Any 16-bit button code value is reserved for future additions to
* the kernel's event code list. All other button codes above
* 0xFFFF are currently undefined but may be used in future
* versions of this protocol.
* @param serial serial number of the button event
* @param time timestamp with millisecond granularity
* @param button button that produced the event
* @param state physical state of the button
*/
void (*button)(void *data,
struct wl_pointer *wl_pointer,
uint32_t serial,
uint32_t time,
uint32_t button,
uint32_t state);
/**
* axis event
*
* Scroll and other axis notifications.
*
* For scroll events (vertical and horizontal scroll axes), the
* value parameter is the length of a vector along the specified
* axis in a coordinate space identical to those of motion events,
* representing a relative movement along the specified axis.
*
* For devices that support movements non-parallel to axes multiple
* axis events will be emitted.
*
* When applicable, for example for touch pads, the server can
* choose to emit scroll events where the motion vector is
* equivalent to a motion event vector.
*
* When applicable, a client can transform its content relative to
* the scroll distance.
* @param time timestamp with millisecond granularity
* @param axis axis type
* @param value length of vector in surface-local coordinate space
*/
void (*axis)(void *data,
struct wl_pointer *wl_pointer,
uint32_t time,
uint32_t axis,
wl_fixed_t value);
/**
* end of a pointer event sequence
*
* Indicates the end of a set of events that logically belong
* together. A client is expected to accumulate the data in all
* events within the frame before proceeding.
*
* All wl_pointer events before a wl_pointer.frame event belong
* logically together. For example, in a diagonal scroll motion the
* compositor will send an optional wl_pointer.axis_source event,
* two wl_pointer.axis events (horizontal and vertical) and finally
* a wl_pointer.frame event. The client may use this information to
* calculate a diagonal vector for scrolling.
*
* When multiple wl_pointer.axis events occur within the same
* frame, the motion vector is the combined motion of all events.
* When a wl_pointer.axis and a wl_pointer.axis_stop event occur
* within the same frame, this indicates that axis movement in one
* axis has stopped but continues in the other axis. When multiple
* wl_pointer.axis_stop events occur within the same frame, this
* indicates that these axes stopped in the same instance.
*
* A wl_pointer.frame event is sent for every logical event group,
* even if the group only contains a single wl_pointer event.
* Specifically, a client may get a sequence: motion, frame,
* button, frame, axis, frame, axis_stop, frame.
*
* The wl_pointer.enter and wl_pointer.leave events are logical
* events generated by the compositor and not the hardware. These
* events are also grouped by a wl_pointer.frame. When a pointer
* moves from one surface to another, a compositor should group the
* wl_pointer.leave event within the same wl_pointer.frame.
* However, a client must not rely on wl_pointer.leave and
* wl_pointer.enter being in the same wl_pointer.frame.
* Compositor-specific policies may require the wl_pointer.leave
* and wl_pointer.enter event being split across multiple
* wl_pointer.frame groups.
* @since 5
*/
void (*frame)(void *data,
struct wl_pointer *wl_pointer);
/**
* axis source event
*
* Source information for scroll and other axes.
*
* This event does not occur on its own. It is sent before a
* wl_pointer.frame event and carries the source information for
* all events within that frame.
*
* The source specifies how this event was generated. If the source
* is wl_pointer.axis_source.finger, a wl_pointer.axis_stop event
* will be sent when the user lifts the finger off the device.
*
* If the source is wl_pointer axis_source.wheel or
* wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event
* may or may not be sent. Whether a compositor sends an axis_stop
* event for these sources is hardware-specific and
* implementation-dependent; clients must not rely on receiving an
* axis_stop event for these scroll sources and should treat scroll
* sequences from these scroll sources as unterminated by default.
*
* This event is optional. If the source is unknown for a
* particular axis event sequence, no event is sent. Only one
* wl_pointer.axis_source event is permitted per frame.
*
* The order of wl_pointer.axis_discrete and wl_pointer.axis_source
* is not guaranteed.
* @param axis_source source of the axis event
* @since 5
*/
void (*axis_source)(void *data,
struct wl_pointer *wl_pointer,
uint32_t axis_source);
/**
* axis stop event
*
* Stop notification for scroll and other axes.
*
* For some wl_pointer.axis_source types, a wl_pointer.axis_stop
* event is sent to notify a client that the axis sequence has
* terminated. This enables the client to implement kinetic
* scrolling. See the wl_pointer.axis_source documentation for
* information on when this event may be generated.
*
* Any wl_pointer.axis events with the same axis_source after this
* event should be considered as the start of a new axis motion.
*
* The timestamp is to be interpreted identical to the timestamp in
* the wl_pointer.axis event. The timestamp value may be the same
* as a preceding wl_pointer.axis event.
* @param time timestamp with millisecond granularity
* @param axis the axis stopped with this event
* @since 5
*/
void (*axis_stop)(void *data,
struct wl_pointer *wl_pointer,
uint32_t time,
uint32_t axis);
/**
* axis click event
*
* Discrete step information for scroll and other axes.
*
* This event carries the axis value of the wl_pointer.axis event
* in discrete steps (e.g. mouse wheel clicks).
*
* This event does not occur on its own, it is coupled with a
* wl_pointer.axis event that represents this axis value on a
* continuous scale. The protocol guarantees that each
* axis_discrete event is always followed by exactly one axis event
* with the same axis number within the same wl_pointer.frame. Note
* that the protocol allows for other events to occur between the
* axis_discrete and its coupled axis event, including other
* axis_discrete or axis events.
*
* This event is optional; continuous scrolling devices like
* two-finger scrolling on touchpads do not have discrete steps and
* do not generate this event.
*
* The discrete value carries the directional information. e.g. a
* value of -2 is two steps towards the negative direction of this
* axis.
*
* The axis number is identical to the axis number in the
* associated axis event.
*
* The order of wl_pointer.axis_discrete and wl_pointer.axis_source
* is not guaranteed.
* @param axis axis type
* @param discrete number of steps
* @since 5
*/
void (*axis_discrete)(void *data,
struct wl_pointer *wl_pointer,
uint32_t axis,
int32_t discrete);
};
/**
* @ingroup iface_wl_pointer
*/
static inline int
wl_pointer_add_listener(struct wl_pointer *wl_pointer,
const struct wl_pointer_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_pointer,
(void (**)(void)) listener, data);
}
#define WL_POINTER_SET_CURSOR 0
#define WL_POINTER_RELEASE 1
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_ENTER_SINCE_VERSION 1
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_LEAVE_SINCE_VERSION 1
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_MOTION_SINCE_VERSION 1
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_BUTTON_SINCE_VERSION 1
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_AXIS_SINCE_VERSION 1
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_FRAME_SINCE_VERSION 5
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_AXIS_SOURCE_SINCE_VERSION 5
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_AXIS_STOP_SINCE_VERSION 5
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_AXIS_DISCRETE_SINCE_VERSION 5
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_SET_CURSOR_SINCE_VERSION 1
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_RELEASE_SINCE_VERSION 3
/** @ingroup iface_wl_pointer */
static inline void
wl_pointer_set_user_data(struct wl_pointer *wl_pointer, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_pointer, user_data);
}
/** @ingroup iface_wl_pointer */
static inline void *
wl_pointer_get_user_data(struct wl_pointer *wl_pointer)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_pointer);
}
static inline uint32_t
wl_pointer_get_version(struct wl_pointer *wl_pointer)
{
return wl_proxy_get_version((struct wl_proxy *) wl_pointer);
}
/** @ingroup iface_wl_pointer */
static inline void
wl_pointer_destroy(struct wl_pointer *wl_pointer)
{
wl_proxy_destroy((struct wl_proxy *) wl_pointer);
}
/**
* @ingroup iface_wl_pointer
*
* Set the pointer surface, i.e., the surface that contains the
* pointer image (cursor). This request gives the surface the role
* of a cursor. If the surface already has another role, it raises
* a protocol error.
*
* The cursor actually changes only if the pointer
* focus for this device is one of the requesting client's surfaces
* or the surface parameter is the current pointer surface. If
* there was a previous surface set with this request it is
* replaced. If surface is NULL, the pointer image is hidden.
*
* The parameters hotspot_x and hotspot_y define the position of
* the pointer surface relative to the pointer location. Its
* top-left corner is always at (x, y) - (hotspot_x, hotspot_y),
* where (x, y) are the coordinates of the pointer location, in
* surface-local coordinates.
*
* On surface.attach requests to the pointer surface, hotspot_x
* and hotspot_y are decremented by the x and y parameters
* passed to the request. Attach must be confirmed by
* wl_surface.commit as usual.
*
* The hotspot can also be updated by passing the currently set
* pointer surface to this request with new values for hotspot_x
* and hotspot_y.
*
* The current and pending input regions of the wl_surface are
* cleared, and wl_surface.set_input_region is ignored until the
* wl_surface is no longer used as the cursor. When the use as a
* cursor ends, the current and pending input regions become
* undefined, and the wl_surface is unmapped.
*/
static inline void
wl_pointer_set_cursor(struct wl_pointer *wl_pointer, uint32_t serial, struct wl_surface *surface, int32_t hotspot_x, int32_t hotspot_y)
{
wl_proxy_marshal((struct wl_proxy *) wl_pointer,
WL_POINTER_SET_CURSOR, serial, surface, hotspot_x, hotspot_y);
}
/**
* @ingroup iface_wl_pointer
*
* Using this request a client can tell the server that it is not going to
* use the pointer object anymore.
*
* This request destroys the pointer proxy object, so clients must not call
* wl_pointer_destroy() after using this request.
*/
static inline void
wl_pointer_release(struct wl_pointer *wl_pointer)
{
wl_proxy_marshal((struct wl_proxy *) wl_pointer,
WL_POINTER_RELEASE);
wl_proxy_destroy((struct wl_proxy *) wl_pointer);
}
#ifndef WL_KEYBOARD_KEYMAP_FORMAT_ENUM
#define WL_KEYBOARD_KEYMAP_FORMAT_ENUM
/**
* @ingroup iface_wl_keyboard
* keyboard mapping format
*
* This specifies the format of the keymap provided to the
* client with the wl_keyboard.keymap event.
*/
enum wl_keyboard_keymap_format {
/**
* no keymap; client must understand how to interpret the raw keycode
*/
WL_KEYBOARD_KEYMAP_FORMAT_NO_KEYMAP = 0,
/**
* libxkbcommon compatible; to determine the xkb keycode, clients must add 8 to the key event keycode
*/
WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1 = 1,
};
#endif /* WL_KEYBOARD_KEYMAP_FORMAT_ENUM */
#ifndef WL_KEYBOARD_KEY_STATE_ENUM
#define WL_KEYBOARD_KEY_STATE_ENUM
/**
* @ingroup iface_wl_keyboard
* physical key state
*
* Describes the physical state of a key that produced the key event.
*/
enum wl_keyboard_key_state {
/**
* key is not pressed
*/
WL_KEYBOARD_KEY_STATE_RELEASED = 0,
/**
* key is pressed
*/
WL_KEYBOARD_KEY_STATE_PRESSED = 1,
};
#endif /* WL_KEYBOARD_KEY_STATE_ENUM */
/**
* @ingroup iface_wl_keyboard
* @struct wl_keyboard_listener
*/
struct wl_keyboard_listener {
/**
* keyboard mapping
*
* This event provides a file descriptor to the client which can
* be memory-mapped to provide a keyboard mapping description.
* @param format keymap format
* @param fd keymap file descriptor
* @param size keymap size, in bytes
*/
void (*keymap)(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t format,
int32_t fd,
uint32_t size);
/**
* enter event
*
* Notification that this seat's keyboard focus is on a certain
* surface.
* @param serial serial number of the enter event
* @param surface surface gaining keyboard focus
* @param keys the currently pressed keys
*/
void (*enter)(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t serial,
struct wl_surface *surface,
struct wl_array *keys);
/**
* leave event
*
* Notification that this seat's keyboard focus is no longer on a
* certain surface.
*
* The leave notification is sent before the enter notification for
* the new focus.
* @param serial serial number of the leave event
* @param surface surface that lost keyboard focus
*/
void (*leave)(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t serial,
struct wl_surface *surface);
/**
* key event
*
* A key was pressed or released. The time argument is a
* timestamp with millisecond granularity, with an undefined base.
* @param serial serial number of the key event
* @param time timestamp with millisecond granularity
* @param key key that produced the event
* @param state physical state of the key
*/
void (*key)(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t serial,
uint32_t time,
uint32_t key,
uint32_t state);
/**
* modifier and group state
*
* Notifies clients that the modifier and/or group state has
* changed, and it should update its local state.
* @param serial serial number of the modifiers event
* @param mods_depressed depressed modifiers
* @param mods_latched latched modifiers
* @param mods_locked locked modifiers
* @param group keyboard layout
*/
void (*modifiers)(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t serial,
uint32_t mods_depressed,
uint32_t mods_latched,
uint32_t mods_locked,
uint32_t group);
/**
* repeat rate and delay
*
* Informs the client about the keyboard's repeat rate and delay.
*
* This event is sent as soon as the wl_keyboard object has been
* created, and is guaranteed to be received by the client before
* any key press event.
*
* Negative values for either rate or delay are illegal. A rate of
* zero will disable any repeating (regardless of the value of
* delay).
*
* This event can be sent later on as well with a new value if
* necessary, so clients should continue listening for the event
* past the creation of wl_keyboard.
* @param rate the rate of repeating keys in characters per second
* @param delay delay in milliseconds since key down until repeating starts
* @since 4
*/
void (*repeat_info)(void *data,
struct wl_keyboard *wl_keyboard,
int32_t rate,
int32_t delay);
};
/**
* @ingroup iface_wl_keyboard
*/
static inline int
wl_keyboard_add_listener(struct wl_keyboard *wl_keyboard,
const struct wl_keyboard_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_keyboard,
(void (**)(void)) listener, data);
}
#define WL_KEYBOARD_RELEASE 0
/**
* @ingroup iface_wl_keyboard
*/
#define WL_KEYBOARD_KEYMAP_SINCE_VERSION 1
/**
* @ingroup iface_wl_keyboard
*/
#define WL_KEYBOARD_ENTER_SINCE_VERSION 1
/**
* @ingroup iface_wl_keyboard
*/
#define WL_KEYBOARD_LEAVE_SINCE_VERSION 1
/**
* @ingroup iface_wl_keyboard
*/
#define WL_KEYBOARD_KEY_SINCE_VERSION 1
/**
* @ingroup iface_wl_keyboard
*/
#define WL_KEYBOARD_MODIFIERS_SINCE_VERSION 1
/**
* @ingroup iface_wl_keyboard
*/
#define WL_KEYBOARD_REPEAT_INFO_SINCE_VERSION 4
/**
* @ingroup iface_wl_keyboard
*/
#define WL_KEYBOARD_RELEASE_SINCE_VERSION 3
/** @ingroup iface_wl_keyboard */
static inline void
wl_keyboard_set_user_data(struct wl_keyboard *wl_keyboard, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_keyboard, user_data);
}
/** @ingroup iface_wl_keyboard */
static inline void *
wl_keyboard_get_user_data(struct wl_keyboard *wl_keyboard)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_keyboard);
}
static inline uint32_t
wl_keyboard_get_version(struct wl_keyboard *wl_keyboard)
{
return wl_proxy_get_version((struct wl_proxy *) wl_keyboard);
}
/** @ingroup iface_wl_keyboard */
static inline void
wl_keyboard_destroy(struct wl_keyboard *wl_keyboard)
{
wl_proxy_destroy((struct wl_proxy *) wl_keyboard);
}
/**
* @ingroup iface_wl_keyboard
*/
static inline void
wl_keyboard_release(struct wl_keyboard *wl_keyboard)
{
wl_proxy_marshal((struct wl_proxy *) wl_keyboard,
WL_KEYBOARD_RELEASE);
wl_proxy_destroy((struct wl_proxy *) wl_keyboard);
}
/**
* @ingroup iface_wl_touch
* @struct wl_touch_listener
*/
struct wl_touch_listener {
/**
* touch down event and beginning of a touch sequence
*
* A new touch point has appeared on the surface. This touch
* point is assigned a unique ID. Future events from this touch
* point reference this ID. The ID ceases to be valid after a touch
* up event and may be reused in the future.
* @param serial serial number of the touch down event
* @param time timestamp with millisecond granularity
* @param surface surface touched
* @param id the unique ID of this touch point
* @param x surface-local x coordinate
* @param y surface-local y coordinate
*/
void (*down)(void *data,
struct wl_touch *wl_touch,
uint32_t serial,
uint32_t time,
struct wl_surface *surface,
int32_t id,
wl_fixed_t x,
wl_fixed_t y);
/**
* end of a touch event sequence
*
* The touch point has disappeared. No further events will be
* sent for this touch point and the touch point's ID is released
* and may be reused in a future touch down event.
* @param serial serial number of the touch up event
* @param time timestamp with millisecond granularity
* @param id the unique ID of this touch point
*/
void (*up)(void *data,
struct wl_touch *wl_touch,
uint32_t serial,
uint32_t time,
int32_t id);
/**
* update of touch point coordinates
*
* A touch point has changed coordinates.
* @param time timestamp with millisecond granularity
* @param id the unique ID of this touch point
* @param x surface-local x coordinate
* @param y surface-local y coordinate
*/
void (*motion)(void *data,
struct wl_touch *wl_touch,
uint32_t time,
int32_t id,
wl_fixed_t x,
wl_fixed_t y);
/**
* end of touch frame event
*
* Indicates the end of a set of events that logically belong
* together. A client is expected to accumulate the data in all
* events within the frame before proceeding.
*
* A wl_touch.frame terminates at least one event but otherwise no
* guarantee is provided about the set of events within a frame. A
* client must assume that any state not updated in a frame is
* unchanged from the previously known state.
*/
void (*frame)(void *data,
struct wl_touch *wl_touch);
/**
* touch session cancelled
*
* Sent if the compositor decides the touch stream is a global
* gesture. No further events are sent to the clients from that
* particular gesture. Touch cancellation applies to all touch
* points currently active on this client's surface. The client is
* responsible for finalizing the touch points, future touch points
* on this surface may reuse the touch point ID.
*/
void (*cancel)(void *data,
struct wl_touch *wl_touch);
/**
* update shape of touch point
*
* Sent when a touchpoint has changed its shape.
*
* This event does not occur on its own. It is sent before a
* wl_touch.frame event and carries the new shape information for
* any previously reported, or new touch points of that frame.
*
* Other events describing the touch point such as wl_touch.down,
* wl_touch.motion or wl_touch.orientation may be sent within the
* same wl_touch.frame. A client should treat these events as a
* single logical touch point update. The order of wl_touch.shape,
* wl_touch.orientation and wl_touch.motion is not guaranteed. A
* wl_touch.down event is guaranteed to occur before the first
* wl_touch.shape event for this touch ID but both events may occur
* within the same wl_touch.frame.
*
* A touchpoint shape is approximated by an ellipse through the
* major and minor axis length. The major axis length describes the
* longer diameter of the ellipse, while the minor axis length
* describes the shorter diameter. Major and minor are orthogonal
* and both are specified in surface-local coordinates. The center
* of the ellipse is always at the touchpoint location as reported
* by wl_touch.down or wl_touch.move.
*
* This event is only sent by the compositor if the touch device
* supports shape reports. The client has to make reasonable
* assumptions about the shape if it did not receive this event.
* @param id the unique ID of this touch point
* @param major length of the major axis in surface-local coordinates
* @param minor length of the minor axis in surface-local coordinates
* @since 6
*/
void (*shape)(void *data,
struct wl_touch *wl_touch,
int32_t id,
wl_fixed_t major,
wl_fixed_t minor);
/**
* update orientation of touch point
*
* Sent when a touchpoint has changed its orientation.
*
* This event does not occur on its own. It is sent before a
* wl_touch.frame event and carries the new shape information for
* any previously reported, or new touch points of that frame.
*
* Other events describing the touch point such as wl_touch.down,
* wl_touch.motion or wl_touch.shape may be sent within the same
* wl_touch.frame. A client should treat these events as a single
* logical touch point update. The order of wl_touch.shape,
* wl_touch.orientation and wl_touch.motion is not guaranteed. A
* wl_touch.down event is guaranteed to occur before the first
* wl_touch.orientation event for this touch ID but both events may
* occur within the same wl_touch.frame.
*
* The orientation describes the clockwise angle of a touchpoint's
* major axis to the positive surface y-axis and is normalized to
* the -180 to +180 degree range. The granularity of orientation
* depends on the touch device, some devices only support binary
* rotation values between 0 and 90 degrees.
*
* This event is only sent by the compositor if the touch device
* supports orientation reports.
* @param id the unique ID of this touch point
* @param orientation angle between major axis and positive surface y-axis in degrees
* @since 6
*/
void (*orientation)(void *data,
struct wl_touch *wl_touch,
int32_t id,
wl_fixed_t orientation);
};
/**
* @ingroup iface_wl_touch
*/
static inline int
wl_touch_add_listener(struct wl_touch *wl_touch,
const struct wl_touch_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_touch,
(void (**)(void)) listener, data);
}
#define WL_TOUCH_RELEASE 0
/**
* @ingroup iface_wl_touch
*/
#define WL_TOUCH_DOWN_SINCE_VERSION 1
/**
* @ingroup iface_wl_touch
*/
#define WL_TOUCH_UP_SINCE_VERSION 1
/**
* @ingroup iface_wl_touch
*/
#define WL_TOUCH_MOTION_SINCE_VERSION 1
/**
* @ingroup iface_wl_touch
*/
#define WL_TOUCH_FRAME_SINCE_VERSION 1
/**
* @ingroup iface_wl_touch
*/
#define WL_TOUCH_CANCEL_SINCE_VERSION 1
/**
* @ingroup iface_wl_touch
*/
#define WL_TOUCH_SHAPE_SINCE_VERSION 6
/**
* @ingroup iface_wl_touch
*/
#define WL_TOUCH_ORIENTATION_SINCE_VERSION 6
/**
* @ingroup iface_wl_touch
*/
#define WL_TOUCH_RELEASE_SINCE_VERSION 3
/** @ingroup iface_wl_touch */
static inline void
wl_touch_set_user_data(struct wl_touch *wl_touch, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_touch, user_data);
}
/** @ingroup iface_wl_touch */
static inline void *
wl_touch_get_user_data(struct wl_touch *wl_touch)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_touch);
}
static inline uint32_t
wl_touch_get_version(struct wl_touch *wl_touch)
{
return wl_proxy_get_version((struct wl_proxy *) wl_touch);
}
/** @ingroup iface_wl_touch */
static inline void
wl_touch_destroy(struct wl_touch *wl_touch)
{
wl_proxy_destroy((struct wl_proxy *) wl_touch);
}
/**
* @ingroup iface_wl_touch
*/
static inline void
wl_touch_release(struct wl_touch *wl_touch)
{
wl_proxy_marshal((struct wl_proxy *) wl_touch,
WL_TOUCH_RELEASE);
wl_proxy_destroy((struct wl_proxy *) wl_touch);
}
#ifndef WL_OUTPUT_SUBPIXEL_ENUM
#define WL_OUTPUT_SUBPIXEL_ENUM
/**
* @ingroup iface_wl_output
* subpixel geometry information
*
* This enumeration describes how the physical
* pixels on an output are laid out.
*/
enum wl_output_subpixel {
/**
* unknown geometry
*/
WL_OUTPUT_SUBPIXEL_UNKNOWN = 0,
/**
* no geometry
*/
WL_OUTPUT_SUBPIXEL_NONE = 1,
/**
* horizontal RGB
*/
WL_OUTPUT_SUBPIXEL_HORIZONTAL_RGB = 2,
/**
* horizontal BGR
*/
WL_OUTPUT_SUBPIXEL_HORIZONTAL_BGR = 3,
/**
* vertical RGB
*/
WL_OUTPUT_SUBPIXEL_VERTICAL_RGB = 4,
/**
* vertical BGR
*/
WL_OUTPUT_SUBPIXEL_VERTICAL_BGR = 5,
};
#endif /* WL_OUTPUT_SUBPIXEL_ENUM */
#ifndef WL_OUTPUT_TRANSFORM_ENUM
#define WL_OUTPUT_TRANSFORM_ENUM
/**
* @ingroup iface_wl_output
* transform from framebuffer to output
*
* This describes the transform that a compositor will apply to a
* surface to compensate for the rotation or mirroring of an
* output device.
*
* The flipped values correspond to an initial flip around a
* vertical axis followed by rotation.
*
* The purpose is mainly to allow clients to render accordingly and
* tell the compositor, so that for fullscreen surfaces, the
* compositor will still be able to scan out directly from client
* surfaces.
*/
enum wl_output_transform {
/**
* no transform
*/
WL_OUTPUT_TRANSFORM_NORMAL = 0,
/**
* 90 degrees counter-clockwise
*/
WL_OUTPUT_TRANSFORM_90 = 1,
/**
* 180 degrees counter-clockwise
*/
WL_OUTPUT_TRANSFORM_180 = 2,
/**
* 270 degrees counter-clockwise
*/
WL_OUTPUT_TRANSFORM_270 = 3,
/**
* 180 degree flip around a vertical axis
*/
WL_OUTPUT_TRANSFORM_FLIPPED = 4,
/**
* flip and rotate 90 degrees counter-clockwise
*/
WL_OUTPUT_TRANSFORM_FLIPPED_90 = 5,
/**
* flip and rotate 180 degrees counter-clockwise
*/
WL_OUTPUT_TRANSFORM_FLIPPED_180 = 6,
/**
* flip and rotate 270 degrees counter-clockwise
*/
WL_OUTPUT_TRANSFORM_FLIPPED_270 = 7,
};
#endif /* WL_OUTPUT_TRANSFORM_ENUM */
#ifndef WL_OUTPUT_MODE_ENUM
#define WL_OUTPUT_MODE_ENUM
/**
* @ingroup iface_wl_output
* mode information
*
* These flags describe properties of an output mode.
* They are used in the flags bitfield of the mode event.
*/
enum wl_output_mode {
/**
* indicates this is the current mode
*/
WL_OUTPUT_MODE_CURRENT = 0x1,
/**
* indicates this is the preferred mode
*/
WL_OUTPUT_MODE_PREFERRED = 0x2,
};
#endif /* WL_OUTPUT_MODE_ENUM */
/**
* @ingroup iface_wl_output
* @struct wl_output_listener
*/
struct wl_output_listener {
/**
* properties of the output
*
* The geometry event describes geometric properties of the
* output. The event is sent when binding to the output object and
* whenever any of the properties change.
* @param x x position within the global compositor space
* @param y y position within the global compositor space
* @param physical_width width in millimeters of the output
* @param physical_height height in millimeters of the output
* @param subpixel subpixel orientation of the output
* @param make textual description of the manufacturer
* @param model textual description of the model
* @param transform transform that maps framebuffer to output
*/
void (*geometry)(void *data,
struct wl_output *wl_output,
int32_t x,
int32_t y,
int32_t physical_width,
int32_t physical_height,
int32_t subpixel,
const char *make,
const char *model,
int32_t transform);
/**
* advertise available modes for the output
*
* The mode event describes an available mode for the output.
*
* The event is sent when binding to the output object and there
* will always be one mode, the current mode. The event is sent
* again if an output changes mode, for the mode that is now
* current. In other words, the current mode is always the last
* mode that was received with the current flag set.
*
* The size of a mode is given in physical hardware units of the
* output device. This is not necessarily the same as the output
* size in the global compositor space. For instance, the output
* may be scaled, as described in wl_output.scale, or transformed,
* as described in wl_output.transform.
* @param flags bitfield of mode flags
* @param width width of the mode in hardware units
* @param height height of the mode in hardware units
* @param refresh vertical refresh rate in mHz
*/
void (*mode)(void *data,
struct wl_output *wl_output,
uint32_t flags,
int32_t width,
int32_t height,
int32_t refresh);
/**
* sent all information about output
*
* This event is sent after all other properties have been sent
* after binding to the output object and after any other property
* changes done after that. This allows changes to the output
* properties to be seen as atomic, even if they happen via
* multiple events.
* @since 2
*/
void (*done)(void *data,
struct wl_output *wl_output);
/**
* output scaling properties
*
* This event contains scaling geometry information that is not
* in the geometry event. It may be sent after binding the output
* object or if the output scale changes later. If it is not sent,
* the client should assume a scale of 1.
*
* A scale larger than 1 means that the compositor will
* automatically scale surface buffers by this amount when
* rendering. This is used for very high resolution displays where
* applications rendering at the native resolution would be too
* small to be legible.
*
* It is intended that scaling aware clients track the current
* output of a surface, and if it is on a scaled output it should
* use wl_surface.set_buffer_scale with the scale of the output.
* That way the compositor can avoid scaling the surface, and the
* client can supply a higher detail image.
* @param factor scaling factor of output
* @since 2
*/
void (*scale)(void *data,
struct wl_output *wl_output,
int32_t factor);
};
/**
* @ingroup iface_wl_output
*/
static inline int
wl_output_add_listener(struct wl_output *wl_output,
const struct wl_output_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) wl_output,
(void (**)(void)) listener, data);
}
#define WL_OUTPUT_RELEASE 0
/**
* @ingroup iface_wl_output
*/
#define WL_OUTPUT_GEOMETRY_SINCE_VERSION 1
/**
* @ingroup iface_wl_output
*/
#define WL_OUTPUT_MODE_SINCE_VERSION 1
/**
* @ingroup iface_wl_output
*/
#define WL_OUTPUT_DONE_SINCE_VERSION 2
/**
* @ingroup iface_wl_output
*/
#define WL_OUTPUT_SCALE_SINCE_VERSION 2
/**
* @ingroup iface_wl_output
*/
#define WL_OUTPUT_RELEASE_SINCE_VERSION 3
/** @ingroup iface_wl_output */
static inline void
wl_output_set_user_data(struct wl_output *wl_output, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_output, user_data);
}
/** @ingroup iface_wl_output */
static inline void *
wl_output_get_user_data(struct wl_output *wl_output)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_output);
}
static inline uint32_t
wl_output_get_version(struct wl_output *wl_output)
{
return wl_proxy_get_version((struct wl_proxy *) wl_output);
}
/** @ingroup iface_wl_output */
static inline void
wl_output_destroy(struct wl_output *wl_output)
{
wl_proxy_destroy((struct wl_proxy *) wl_output);
}
/**
* @ingroup iface_wl_output
*
* Using this request a client can tell the server that it is not going to
* use the output object anymore.
*/
static inline void
wl_output_release(struct wl_output *wl_output)
{
wl_proxy_marshal((struct wl_proxy *) wl_output,
WL_OUTPUT_RELEASE);
wl_proxy_destroy((struct wl_proxy *) wl_output);
}
#define WL_REGION_DESTROY 0
#define WL_REGION_ADD 1
#define WL_REGION_SUBTRACT 2
/**
* @ingroup iface_wl_region
*/
#define WL_REGION_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_wl_region
*/
#define WL_REGION_ADD_SINCE_VERSION 1
/**
* @ingroup iface_wl_region
*/
#define WL_REGION_SUBTRACT_SINCE_VERSION 1
/** @ingroup iface_wl_region */
static inline void
wl_region_set_user_data(struct wl_region *wl_region, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_region, user_data);
}
/** @ingroup iface_wl_region */
static inline void *
wl_region_get_user_data(struct wl_region *wl_region)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_region);
}
static inline uint32_t
wl_region_get_version(struct wl_region *wl_region)
{
return wl_proxy_get_version((struct wl_proxy *) wl_region);
}
/**
* @ingroup iface_wl_region
*
* Destroy the region. This will invalidate the object ID.
*/
static inline void
wl_region_destroy(struct wl_region *wl_region)
{
wl_proxy_marshal((struct wl_proxy *) wl_region,
WL_REGION_DESTROY);
wl_proxy_destroy((struct wl_proxy *) wl_region);
}
/**
* @ingroup iface_wl_region
*
* Add the specified rectangle to the region.
*/
static inline void
wl_region_add(struct wl_region *wl_region, int32_t x, int32_t y, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) wl_region,
WL_REGION_ADD, x, y, width, height);
}
/**
* @ingroup iface_wl_region
*
* Subtract the specified rectangle from the region.
*/
static inline void
wl_region_subtract(struct wl_region *wl_region, int32_t x, int32_t y, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) wl_region,
WL_REGION_SUBTRACT, x, y, width, height);
}
#ifndef WL_SUBCOMPOSITOR_ERROR_ENUM
#define WL_SUBCOMPOSITOR_ERROR_ENUM
enum wl_subcompositor_error {
/**
* the to-be sub-surface is invalid
*/
WL_SUBCOMPOSITOR_ERROR_BAD_SURFACE = 0,
};
#endif /* WL_SUBCOMPOSITOR_ERROR_ENUM */
#define WL_SUBCOMPOSITOR_DESTROY 0
#define WL_SUBCOMPOSITOR_GET_SUBSURFACE 1
/**
* @ingroup iface_wl_subcompositor
*/
#define WL_SUBCOMPOSITOR_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_wl_subcompositor
*/
#define WL_SUBCOMPOSITOR_GET_SUBSURFACE_SINCE_VERSION 1
/** @ingroup iface_wl_subcompositor */
static inline void
wl_subcompositor_set_user_data(struct wl_subcompositor *wl_subcompositor, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_subcompositor, user_data);
}
/** @ingroup iface_wl_subcompositor */
static inline void *
wl_subcompositor_get_user_data(struct wl_subcompositor *wl_subcompositor)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_subcompositor);
}
static inline uint32_t
wl_subcompositor_get_version(struct wl_subcompositor *wl_subcompositor)
{
return wl_proxy_get_version((struct wl_proxy *) wl_subcompositor);
}
/**
* @ingroup iface_wl_subcompositor
*
* Informs the server that the client will not be using this
* protocol object anymore. This does not affect any other
* objects, wl_subsurface objects included.
*/
static inline void
wl_subcompositor_destroy(struct wl_subcompositor *wl_subcompositor)
{
wl_proxy_marshal((struct wl_proxy *) wl_subcompositor,
WL_SUBCOMPOSITOR_DESTROY);
wl_proxy_destroy((struct wl_proxy *) wl_subcompositor);
}
/**
* @ingroup iface_wl_subcompositor
*
* Create a sub-surface interface for the given surface, and
* associate it with the given parent surface. This turns a
* plain wl_surface into a sub-surface.
*
* The to-be sub-surface must not already have another role, and it
* must not have an existing wl_subsurface object. Otherwise a protocol
* error is raised.
*/
static inline struct wl_subsurface *
wl_subcompositor_get_subsurface(struct wl_subcompositor *wl_subcompositor, struct wl_surface *surface, struct wl_surface *parent)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_subcompositor,
WL_SUBCOMPOSITOR_GET_SUBSURFACE, &wl_subsurface_interface, NULL, surface, parent);
return (struct wl_subsurface *) id;
}
#ifndef WL_SUBSURFACE_ERROR_ENUM
#define WL_SUBSURFACE_ERROR_ENUM
enum wl_subsurface_error {
/**
* wl_surface is not a sibling or the parent
*/
WL_SUBSURFACE_ERROR_BAD_SURFACE = 0,
};
#endif /* WL_SUBSURFACE_ERROR_ENUM */
#define WL_SUBSURFACE_DESTROY 0
#define WL_SUBSURFACE_SET_POSITION 1
#define WL_SUBSURFACE_PLACE_ABOVE 2
#define WL_SUBSURFACE_PLACE_BELOW 3
#define WL_SUBSURFACE_SET_SYNC 4
#define WL_SUBSURFACE_SET_DESYNC 5
/**
* @ingroup iface_wl_subsurface
*/
#define WL_SUBSURFACE_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_wl_subsurface
*/
#define WL_SUBSURFACE_SET_POSITION_SINCE_VERSION 1
/**
* @ingroup iface_wl_subsurface
*/
#define WL_SUBSURFACE_PLACE_ABOVE_SINCE_VERSION 1
/**
* @ingroup iface_wl_subsurface
*/
#define WL_SUBSURFACE_PLACE_BELOW_SINCE_VERSION 1
/**
* @ingroup iface_wl_subsurface
*/
#define WL_SUBSURFACE_SET_SYNC_SINCE_VERSION 1
/**
* @ingroup iface_wl_subsurface
*/
#define WL_SUBSURFACE_SET_DESYNC_SINCE_VERSION 1
/** @ingroup iface_wl_subsurface */
static inline void
wl_subsurface_set_user_data(struct wl_subsurface *wl_subsurface, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) wl_subsurface, user_data);
}
/** @ingroup iface_wl_subsurface */
static inline void *
wl_subsurface_get_user_data(struct wl_subsurface *wl_subsurface)
{
return wl_proxy_get_user_data((struct wl_proxy *) wl_subsurface);
}
static inline uint32_t
wl_subsurface_get_version(struct wl_subsurface *wl_subsurface)
{
return wl_proxy_get_version((struct wl_proxy *) wl_subsurface);
}
/**
* @ingroup iface_wl_subsurface
*
* The sub-surface interface is removed from the wl_surface object
* that was turned into a sub-surface with a
* wl_subcompositor.get_subsurface request. The wl_surface's association
* to the parent is deleted, and the wl_surface loses its role as
* a sub-surface. The wl_surface is unmapped.
*/
static inline void
wl_subsurface_destroy(struct wl_subsurface *wl_subsurface)
{
wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
WL_SUBSURFACE_DESTROY);
wl_proxy_destroy((struct wl_proxy *) wl_subsurface);
}
/**
* @ingroup iface_wl_subsurface
*
* This schedules a sub-surface position change.
* The sub-surface will be moved so that its origin (top left
* corner pixel) will be at the location x, y of the parent surface
* coordinate system. The coordinates are not restricted to the parent
* surface area. Negative values are allowed.
*
* The scheduled coordinates will take effect whenever the state of the
* parent surface is applied. When this happens depends on whether the
* parent surface is in synchronized mode or not. See
* wl_subsurface.set_sync and wl_subsurface.set_desync for details.
*
* If more than one set_position request is invoked by the client before
* the commit of the parent surface, the position of a new request always
* replaces the scheduled position from any previous request.
*
* The initial position is 0, 0.
*/
static inline void
wl_subsurface_set_position(struct wl_subsurface *wl_subsurface, int32_t x, int32_t y)
{
wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
WL_SUBSURFACE_SET_POSITION, x, y);
}
/**
* @ingroup iface_wl_subsurface
*
* This sub-surface is taken from the stack, and put back just
* above the reference surface, changing the z-order of the sub-surfaces.
* The reference surface must be one of the sibling surfaces, or the
* parent surface. Using any other surface, including this sub-surface,
* will cause a protocol error.
*
* The z-order is double-buffered. Requests are handled in order and
* applied immediately to a pending state. The final pending state is
* copied to the active state the next time the state of the parent
* surface is applied. When this happens depends on whether the parent
* surface is in synchronized mode or not. See wl_subsurface.set_sync and
* wl_subsurface.set_desync for details.
*
* A new sub-surface is initially added as the top-most in the stack
* of its siblings and parent.
*/
static inline void
wl_subsurface_place_above(struct wl_subsurface *wl_subsurface, struct wl_surface *sibling)
{
wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
WL_SUBSURFACE_PLACE_ABOVE, sibling);
}
/**
* @ingroup iface_wl_subsurface
*
* The sub-surface is placed just below the reference surface.
* See wl_subsurface.place_above.
*/
static inline void
wl_subsurface_place_below(struct wl_subsurface *wl_subsurface, struct wl_surface *sibling)
{
wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
WL_SUBSURFACE_PLACE_BELOW, sibling);
}
/**
* @ingroup iface_wl_subsurface
*
* Change the commit behaviour of the sub-surface to synchronized
* mode, also described as the parent dependent mode.
*
* In synchronized mode, wl_surface.commit on a sub-surface will
* accumulate the committed state in a cache, but the state will
* not be applied and hence will not change the compositor output.
* The cached state is applied to the sub-surface immediately after
* the parent surface's state is applied. This ensures atomic
* updates of the parent and all its synchronized sub-surfaces.
* Applying the cached state will invalidate the cache, so further
* parent surface commits do not (re-)apply old state.
*
* See wl_subsurface for the recursive effect of this mode.
*/
static inline void
wl_subsurface_set_sync(struct wl_subsurface *wl_subsurface)
{
wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
WL_SUBSURFACE_SET_SYNC);
}
/**
* @ingroup iface_wl_subsurface
*
* Change the commit behaviour of the sub-surface to desynchronized
* mode, also described as independent or freely running mode.
*
* In desynchronized mode, wl_surface.commit on a sub-surface will
* apply the pending state directly, without caching, as happens
* normally with a wl_surface. Calling wl_surface.commit on the
* parent surface has no effect on the sub-surface's wl_surface
* state. This mode allows a sub-surface to be updated on its own.
*
* If cached state exists when wl_surface.commit is called in
* desynchronized mode, the pending state is added to the cached
* state, and applied as a whole. This invalidates the cache.
*
* Note: even if a sub-surface is set to desynchronized, a parent
* sub-surface may override it to behave as synchronized. For details,
* see wl_subsurface.
*
* If a surface's parent surface behaves as desynchronized, then
* the cached state is applied on set_desync.
*/
static inline void
wl_subsurface_set_desync(struct wl_subsurface *wl_subsurface)
{
wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
WL_SUBSURFACE_SET_DESYNC);
}
#ifdef __cplusplus
}
#endif
#endif
|