buninu-browser 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (239) hide show
  1. package/LICENSES/jsmdcui.txt +22 -0
  2. package/README.md +19 -4
  3. package/frontends/wayland/LICENSE-land +21 -0
  4. package/frontends/wayland/README.md +123 -0
  5. package/frontends/wayland/casty/LICENSE +21 -0
  6. package/frontends/wayland/casty/bookmarks.js +32 -0
  7. package/frontends/wayland/casty/click.js +96 -0
  8. package/frontends/wayland/casty/commands.js +61 -0
  9. package/frontends/wayland/casty/config.js +45 -0
  10. package/frontends/wayland/casty/download-directory.js +28 -0
  11. package/frontends/wayland/casty/download.js +49 -0
  12. package/frontends/wayland/casty/hints.js +334 -0
  13. package/frontends/wayland/casty/keys.js +56 -0
  14. package/frontends/wayland/casty/page-commands.js +80 -0
  15. package/frontends/wayland/casty/prompt-width.js +148 -0
  16. package/frontends/wayland/casty/urlbar.js +606 -0
  17. package/frontends/wayland/client.js +88 -0
  18. package/frontends/wayland/clipboard.js +80 -0
  19. package/frontends/wayland/index.js +116 -0
  20. package/frontends/wayland/input.js +56 -0
  21. package/frontends/wayland/protocol.js +55 -0
  22. package/frontends/wayland/protocols/wayland.xml +3248 -0
  23. package/frontends/wayland/protocols/xdg-shell.xml +1415 -0
  24. package/frontends/wayland/transport.js +120 -0
  25. package/frontends/wayland/urlbar.js +158 -0
  26. package/index.js +28 -1
  27. package/lib/clipboard-command.js +10 -0
  28. package/lib/clipboard-powershell.js +22 -0
  29. package/lib/clipboard.js +37 -2
  30. package/lib/document-types.js +11 -0
  31. package/lib/headless-shell.js +47 -8
  32. package/lib/layout/text-layout.js +17 -9
  33. package/lib/paint/display-list.js +5 -1
  34. package/lib/qml/README.md +971 -0
  35. package/lib/qml/builtins.js +700 -0
  36. package/lib/qml/canvas-dom.js +115 -0
  37. package/lib/qml/document.js +1176 -0
  38. package/lib/qml/format.js +9 -0
  39. package/lib/qml/host.js +324 -0
  40. package/lib/qml/images.js +199 -0
  41. package/lib/qml/launcher.js +132 -0
  42. package/lib/qml/loader.js +517 -0
  43. package/lib/qml/media-renderer.js +49 -0
  44. package/lib/qml/media.js +86 -0
  45. package/lib/qml/models.js +622 -0
  46. package/lib/qml/parser.js +381 -0
  47. package/lib/qml/qs +5 -0
  48. package/lib/qml/qscasty +3 -0
  49. package/lib/qml/qsheadless +3 -0
  50. package/lib/qml/qswayland +3 -0
  51. package/lib/qml/reactive.js +159 -0
  52. package/lib/qml/runtime.js +3381 -0
  53. package/lib/qml/shapes.js +243 -0
  54. package/lib/qml/text.js +109 -0
  55. package/lib/qml/textures.js +123 -0
  56. package/lib/qml/wayland-clipboard.js +32 -0
  57. package/lib/qml/worker-thread.js +70 -0
  58. package/lib/render-tree/index.js +16 -1
  59. package/lib/renderer/bindings.js +11 -0
  60. package/lib/renderer/canvas-2d.js +13 -0
  61. package/lib/renderer/host.js +31 -6
  62. package/lib/renderer/main.js +19 -6
  63. package/lib/renderer/page-realm.js +16 -1
  64. package/lib/renderer/page-renderer.js +230 -13
  65. package/lib/renderer/text-input-paint.js +54 -0
  66. package/lib/renderer/text-input.js +57 -0
  67. package/lib/style/computed-style.js +2 -2
  68. package/package.json +1 -1
  69. package/test/clipboard.test.js +19 -0
  70. package/test/fixtures/flea-helpers/Dockerfile +36 -0
  71. package/test/fixtures/flea-helpers/bat.mjs +43 -0
  72. package/test/fixtures/flea-helpers/bin/bat +3 -0
  73. package/test/fixtures/flea-helpers/bin/bwrap +10 -0
  74. package/test/fixtures/flea-helpers/bin/bwrap-real-filter +9 -0
  75. package/test/fixtures/flea-helpers/bin/glow +3 -0
  76. package/test/fixtures/flea-helpers/bin/qs +3 -0
  77. package/test/fixtures/flea-helpers/bin/unsupported +3 -0
  78. package/test/fixtures/flea-helpers/check-highlighting.mjs +47 -0
  79. package/test/fixtures/flea-helpers/check-media.mjs +29 -0
  80. package/test/fixtures/flea-helpers/check-preview.mjs +27 -0
  81. package/test/fixtures/flea-helpers/check.mjs +36 -0
  82. package/test/fixtures/flea-helpers/highlight-cases.json +227 -0
  83. package/test/fixtures/flea-helpers/source-mime.xml +28 -0
  84. package/test/fixtures/flea-helpers/syntax-compat.mjs +23 -0
  85. package/test/fixtures/flea-thumbnail-stub/flea-placeholder.thumbnailer +4 -0
  86. package/test/fixtures/flea-thumbnail-stub/flea-thumbnail-stub +3 -0
  87. package/test/fixtures/qml/flea/EscapeHint.qml +11 -0
  88. package/test/fixtures/qml/flea/LICENSE +21 -0
  89. package/test/fixtures/qml/flea/README.md +25 -0
  90. package/test/fixtures/qml/flea/Theme.qml +8 -0
  91. package/test/fixtures/qml/flea/demo.qml +24 -0
  92. package/test/fixtures/qml/flea/qmldir +3 -0
  93. package/test/fixtures/qml/flea-theme/LICENSE-Flea +21 -0
  94. package/test/fixtures/qml/flea-theme/LICENSE-Omarchy +20 -0
  95. package/test/fixtures/qml/flea-theme/README.md +70 -0
  96. package/test/fixtures/qml/flea-theme/button.qml +17 -0
  97. package/test/fixtures/qml/flea-theme/demo.qml +27 -0
  98. package/test/fixtures/qml/flea-theme/field.qml +21 -0
  99. package/test/fixtures/qml/flea-theme/imports/qs/Commons/BorderGeometry.js +373 -0
  100. package/test/fixtures/qml/flea-theme/imports/qs/Commons/Color.qml +258 -0
  101. package/test/fixtures/qml/flea-theme/imports/qs/Commons/I18n.qml +118 -0
  102. package/test/fixtures/qml/flea-theme/imports/qs/Commons/Numbers.js +19 -0
  103. package/test/fixtures/qml/flea-theme/imports/qs/Commons/Plural.js +91 -0
  104. package/test/fixtures/qml/flea-theme/imports/qs/Commons/Style.qml +561 -0
  105. package/test/fixtures/qml/flea-theme/imports/qs/Commons/Util.qml +188 -0
  106. package/test/fixtures/qml/flea-theme/imports/qs/Commons/qmldir +13 -0
  107. package/test/fixtures/qml/flea-theme/segment.qml +17 -0
  108. package/test/fixtures/qml/flea-theme/settings.qml +58 -0
  109. package/test/fixtures/qml/flea-theme/text-metrics.qml +10 -0
  110. package/test/fixtures/qml/flea-theme/ui/DialogButton.qml +150 -0
  111. package/test/fixtures/qml/flea-theme/ui/DialogField.qml +147 -0
  112. package/test/fixtures/qml/flea-theme/ui/EscapeHint.qml +11 -0
  113. package/test/fixtures/qml/flea-theme/ui/Glass.qml +114 -0
  114. package/test/fixtures/qml/flea-theme/ui/Glyph.qml +54 -0
  115. package/test/fixtures/qml/flea-theme/ui/GlyphSolid.qml +22 -0
  116. package/test/fixtures/qml/flea-theme/ui/Reveal.qml +54 -0
  117. package/test/fixtures/qml/flea-theme/ui/SettingsRuler.qml +85 -0
  118. package/test/fixtures/qml/flea-theme/ui/SettingsSegment.qml +85 -0
  119. package/test/fixtures/qml/flea-theme/ui/StableModel.qml +89 -0
  120. package/test/fixtures/qml/flea-theme/ui/Theme.qml +460 -0
  121. package/test/fixtures/qml/flea-theme/ui/ThemeColors.qml +43 -0
  122. package/test/fixtures/qml/flea-theme/ui/ViewState.qml +565 -0
  123. package/test/fixtures/qml/flea-theme/ui/js/Anchor.js +379 -0
  124. package/test/fixtures/qml/flea-theme/ui/js/AnchorHold.js +162 -0
  125. package/test/fixtures/qml/flea-theme/ui/js/Archive.js +157 -0
  126. package/test/fixtures/qml/flea-theme/ui/js/BackReturn.js +110 -0
  127. package/test/fixtures/qml/flea-theme/ui/js/Buttons.js +54 -0
  128. package/test/fixtures/qml/flea-theme/ui/js/ColumnMenu.js +111 -0
  129. package/test/fixtures/qml/flea-theme/ui/js/Columns.js +298 -0
  130. package/test/fixtures/qml/flea-theme/ui/js/Contrast.js +157 -0
  131. package/test/fixtures/qml/flea-theme/ui/js/Density.js +44 -0
  132. package/test/fixtures/qml/flea-theme/ui/js/DirSizes.js +129 -0
  133. package/test/fixtures/qml/flea-theme/ui/js/ExtThumbs.js +115 -0
  134. package/test/fixtures/qml/flea-theme/ui/js/Filter.js +284 -0
  135. package/test/fixtures/qml/flea-theme/ui/js/FolderSorts.js +108 -0
  136. package/test/fixtures/qml/flea-theme/ui/js/Format.js +305 -0
  137. package/test/fixtures/qml/flea-theme/ui/js/Icons.js +206 -0
  138. package/test/fixtures/qml/flea-theme/ui/js/Input.js +39 -0
  139. package/test/fixtures/qml/flea-theme/ui/js/KeyName.js +64 -0
  140. package/test/fixtures/qml/flea-theme/ui/js/Keymap.js +370 -0
  141. package/test/fixtures/qml/flea-theme/ui/js/Kinds.js +145 -0
  142. package/test/fixtures/qml/flea-theme/ui/js/Lists.js +11 -0
  143. package/test/fixtures/qml/flea-theme/ui/js/MakeDefault.js +186 -0
  144. package/test/fixtures/qml/flea-theme/ui/js/Match.js +27 -0
  145. package/test/fixtures/qml/flea-theme/ui/js/Material.js +109 -0
  146. package/test/fixtures/qml/flea-theme/ui/js/Menu.js +513 -0
  147. package/test/fixtures/qml/flea-theme/ui/js/Motion.js +16 -0
  148. package/test/fixtures/qml/flea-theme/ui/js/Mounts.js +320 -0
  149. package/test/fixtures/qml/flea-theme/ui/js/MouseNav.js +13 -0
  150. package/test/fixtures/qml/flea-theme/ui/js/Nav.js +328 -0
  151. package/test/fixtures/qml/flea-theme/ui/js/Palette.js +33 -0
  152. package/test/fixtures/qml/flea-theme/ui/js/Places.js +236 -0
  153. package/test/fixtures/qml/flea-theme/ui/js/Protocols.js +296 -0
  154. package/test/fixtures/qml/flea-theme/ui/js/RecentMode.js +154 -0
  155. package/test/fixtures/qml/flea-theme/ui/js/Search.js +396 -0
  156. package/test/fixtures/qml/flea-theme/ui/js/Settings.js +476 -0
  157. package/test/fixtures/qml/flea-theme/ui/js/SettingsAbout.js +99 -0
  158. package/test/fixtures/qml/flea-theme/ui/js/SettingsShelf.js +52 -0
  159. package/test/fixtures/qml/flea-theme/ui/js/Sort.js +127 -0
  160. package/test/fixtures/qml/flea-theme/ui/js/StateWords.js +42 -0
  161. package/test/fixtures/qml/flea-theme/ui/js/Swap.js +166 -0
  162. package/test/fixtures/qml/flea-theme/ui/js/TextSize.js +107 -0
  163. package/test/fixtures/qml/flea-theme/ui/js/Thumbs.js +158 -0
  164. package/test/fixtures/qml/flea-theme/ui/js/UiState.js +438 -0
  165. package/test/fixtures/qml/flea-theme/ui/js/Update.js +132 -0
  166. package/test/fixtures/qml/flea-theme/ui/js/UserDirs.js +56 -0
  167. package/test/fixtures/qml/flea-theme/ui/qmldir +227 -0
  168. package/test/fixtures/qml/hello.qml +26 -0
  169. package/test/fixtures/qml/imports/Demo/Toolkit/VersionLabel.qml +2 -0
  170. package/test/fixtures/qml/imports/Demo/Toolkit/VersionLabelNew.qml +2 -0
  171. package/test/fixtures/qml/imports/Demo/Toolkit/qmldir +3 -0
  172. package/test/fixtures/qml/imports/components/Badge.qml +15 -0
  173. package/test/fixtures/qml/imports/logic/base.js +2 -0
  174. package/test/fixtures/qml/imports/logic/counter.js +4 -0
  175. package/test/fixtures/qml/imports/logic/math.js +3 -0
  176. package/test/fixtures/qml/imports/logic/shared.js +3 -0
  177. package/test/fixtures/qml/imports/main.qml +21 -0
  178. package/test/fixtures/qml/imports/theme/Theme.qml +8 -0
  179. package/test/fixtures/qml/imports/theme/qmldir +2 -0
  180. package/test/fixtures/qml/multiply.qml +61 -0
  181. package/test/fixtures/qml-canvas-dom.js +90 -0
  182. package/test/fixtures/qml-media-audio.js +39 -0
  183. package/test/helpers/flea-sandbox.js +48 -0
  184. package/test/helpers/quickshell-fixture.js +125 -0
  185. package/test/html-clipboard-wayland.test.js +47 -0
  186. package/test/index.test.js +13 -0
  187. package/test/manual-casty-without-qml.js +87 -0
  188. package/test/manual-flea-application.js +49 -0
  189. package/test/manual-flea-binary.js +62 -0
  190. package/test/manual-flea-qml.js +9 -0
  191. package/test/manual-flea-settings.js +40 -0
  192. package/test/manual-flea-theme.js +40 -0
  193. package/test/manual-qml-removal.js +46 -0
  194. package/test/manual-without-qml.js +45 -0
  195. package/test/qml-canvas-dom.test.js +37 -0
  196. package/test/qml-clipboard-bridge.test.js +25 -0
  197. package/test/qml-clipboard-wayland.test.js +40 -0
  198. package/test/qml-connections-timing.test.js +73 -0
  199. package/test/qml-dynamic.test.js +401 -0
  200. package/test/qml-flea-app.test.js +146 -0
  201. package/test/qml-flea-backend.test.js +78 -0
  202. package/test/qml-flea-columns-backend.test.js +38 -0
  203. package/test/qml-flea-compile.test.js +78 -0
  204. package/test/qml-flea-launcher.test.js +88 -0
  205. package/test/qml-flea-markdown-backend.test.js +31 -0
  206. package/test/qml-flea-media.test.js +28 -0
  207. package/test/qml-flea-navigation-backend.test.js +35 -0
  208. package/test/qml-flea-navigation-timing.test.js +147 -0
  209. package/test/qml-flea-preview-backend.test.js +53 -0
  210. package/test/qml-flea-previews.test.js +163 -0
  211. package/test/qml-flea-rows.test.js +101 -0
  212. package/test/qml-flea-textures.test.js +59 -0
  213. package/test/qml-flea-view-switch.test.js +33 -0
  214. package/test/qml-flea-wayland.test.js +68 -0
  215. package/test/qml-flea.test.js +34 -0
  216. package/test/qml-host.test.js +238 -0
  217. package/test/qml-imports.test.js +102 -0
  218. package/test/qml-inherited-handlers.test.js +51 -0
  219. package/test/qml-input-selection.test.js +66 -0
  220. package/test/qml-interactions.test.js +309 -0
  221. package/test/qml-language.test.js +167 -0
  222. package/test/qml-launcher.test.js +54 -0
  223. package/test/qml-layout-text.test.js +205 -0
  224. package/test/qml-media.test.js +63 -0
  225. package/test/qml-persisted-delegates.test.js +45 -0
  226. package/test/qml-quickshell-controls.test.js +65 -0
  227. package/test/qml-quickshell-settings.test.js +62 -0
  228. package/test/qml-repeater.test.js +72 -0
  229. package/test/qml-style-updates.test.js +124 -0
  230. package/test/qml-textures.test.js +66 -0
  231. package/test/qml-views.test.js +332 -0
  232. package/test/qml-worker.test.js +69 -0
  233. package/test/qml.test.js +83 -0
  234. package/test/renderer-host.test.js +11 -0
  235. package/test/text-input-pointer.test.js +31 -0
  236. package/test/text-input-scroll.test.js +29 -0
  237. package/test/text-input.test.js +47 -0
  238. package/test/wayland-frontend.test.js +83 -0
  239. package/test/wayland-urlbar.test.js +38 -0
@@ -0,0 +1,3248 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <protocol name="wayland">
3
+
4
+ <copyright>
5
+ Copyright © 2008-2011 Kristian Høgsberg
6
+ Copyright © 2010-2011 Intel Corporation
7
+ Copyright © 2012-2013 Collabora, Ltd.
8
+
9
+ Permission is hereby granted, free of charge, to any person
10
+ obtaining a copy of this software and associated documentation files
11
+ (the "Software"), to deal in the Software without restriction,
12
+ including without limitation the rights to use, copy, modify, merge,
13
+ publish, distribute, sublicense, and/or sell copies of the Software,
14
+ and to permit persons to whom the Software is furnished to do so,
15
+ subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice (including the
18
+ next paragraph) shall be included in all copies or substantial
19
+ portions of the Software.
20
+
21
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
25
+ BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
26
+ ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
27
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28
+ SOFTWARE.
29
+ </copyright>
30
+
31
+ <interface name="wl_display" version="1">
32
+ <description summary="core global object">
33
+ The core global object. This is a special singleton object. It
34
+ is used for internal Wayland protocol features.
35
+ </description>
36
+
37
+ <request name="sync">
38
+ <description summary="asynchronous roundtrip">
39
+ The sync request asks the server to emit the 'done' event
40
+ on the returned wl_callback object. Since requests are
41
+ handled in-order and events are delivered in-order, this can
42
+ be used as a barrier to ensure all previous requests and the
43
+ resulting events have been handled.
44
+
45
+ The object returned by this request will be destroyed by the
46
+ compositor after the callback is fired and as such the client must not
47
+ attempt to use it after that point.
48
+
49
+ The callback_data passed in the callback is undefined and should be ignored.
50
+ </description>
51
+ <arg name="callback" type="new_id" interface="wl_callback"
52
+ summary="callback object for the sync request"/>
53
+ </request>
54
+
55
+ <request name="get_registry">
56
+ <description summary="get global registry object">
57
+ This request creates a registry object that allows the client
58
+ to list and bind the global objects available from the
59
+ compositor.
60
+
61
+ It should be noted that the server side resources consumed in
62
+ response to a get_registry request can only be released when the
63
+ client disconnects, not when the client side proxy is destroyed.
64
+ Therefore, clients should invoke get_registry as infrequently as
65
+ possible to avoid wasting memory.
66
+ </description>
67
+ <arg name="registry" type="new_id" interface="wl_registry"
68
+ summary="global registry object"/>
69
+ </request>
70
+
71
+ <event name="error">
72
+ <description summary="fatal error event">
73
+ The error event is sent out when a fatal (non-recoverable)
74
+ error has occurred. The object_id argument is the object
75
+ where the error occurred, most often in response to a request
76
+ to that object. The code identifies the error and is defined
77
+ by the object interface. As such, each interface defines its
78
+ own set of error codes. The message is a brief description
79
+ of the error, for (debugging) convenience.
80
+ </description>
81
+ <arg name="object_id" type="object" summary="object where the error occurred"/>
82
+ <arg name="code" type="uint" summary="error code"/>
83
+ <arg name="message" type="string" summary="error description"/>
84
+ </event>
85
+
86
+ <enum name="error">
87
+ <description summary="global error values">
88
+ These errors are global and can be emitted in response to any
89
+ server request.
90
+ </description>
91
+ <entry name="invalid_object" value="0"
92
+ summary="server couldn't find object"/>
93
+ <entry name="invalid_method" value="1"
94
+ summary="method doesn't exist on the specified interface or malformed request"/>
95
+ <entry name="no_memory" value="2"
96
+ summary="server is out of memory"/>
97
+ <entry name="implementation" value="3"
98
+ summary="implementation error in compositor"/>
99
+ </enum>
100
+
101
+ <event name="delete_id">
102
+ <description summary="acknowledge object ID deletion">
103
+ This event is used internally by the object ID management
104
+ logic. When a client deletes an object that it had created,
105
+ the server will send this event to acknowledge that it has
106
+ seen the delete request. When the client receives this event,
107
+ it will know that it can safely reuse the object ID.
108
+ </description>
109
+ <arg name="id" type="uint" summary="deleted object ID"/>
110
+ </event>
111
+ </interface>
112
+
113
+ <interface name="wl_registry" version="1">
114
+ <description summary="global registry object">
115
+ The singleton global registry object. The server has a number of
116
+ global objects that are available to all clients. These objects
117
+ typically represent an actual object in the server (for example,
118
+ an input device) or they are singleton objects that provide
119
+ extension functionality.
120
+
121
+ When a client creates a registry object, the registry object
122
+ will emit a global event for each global currently in the
123
+ registry. Globals come and go as a result of device or
124
+ monitor hotplugs, reconfiguration or other events, and the
125
+ registry will send out global and global_remove events to
126
+ keep the client up to date with the changes. To mark the end
127
+ of the initial burst of events, the client can use the
128
+ wl_display.sync request immediately after calling
129
+ wl_display.get_registry.
130
+
131
+ A client can bind to a global object by using the bind
132
+ request. This creates a client-side handle that lets the object
133
+ emit events to the client and lets the client invoke requests on
134
+ the object.
135
+ </description>
136
+
137
+ <request name="bind">
138
+ <description summary="bind an object to the display">
139
+ Binds a new, client-created object to the server using the
140
+ specified name as the identifier.
141
+ </description>
142
+ <arg name="name" type="uint" summary="unique numeric name of the object"/>
143
+ <arg name="id" type="new_id" summary="bounded object"/>
144
+ </request>
145
+
146
+ <event name="global">
147
+ <description summary="announce global object">
148
+ Notify the client of global objects.
149
+
150
+ The event notifies the client that a global object with
151
+ the given name is now available, and it implements the
152
+ given version of the given interface.
153
+ </description>
154
+ <arg name="name" type="uint" summary="numeric name of the global object"/>
155
+ <arg name="interface" type="string" summary="interface implemented by the object"/>
156
+ <arg name="version" type="uint" summary="interface version"/>
157
+ </event>
158
+
159
+ <event name="global_remove">
160
+ <description summary="announce removal of global object">
161
+ Notify the client of removed global objects.
162
+
163
+ This event notifies the client that the global identified
164
+ by name is no longer available. If the client bound to
165
+ the global using the bind request, the client should now
166
+ destroy that object.
167
+
168
+ The object remains valid and requests to the object will be
169
+ ignored until the client destroys it, to avoid races between
170
+ the global going away and a client sending a request to it.
171
+ </description>
172
+ <arg name="name" type="uint" summary="numeric name of the global object"/>
173
+ </event>
174
+ </interface>
175
+
176
+ <interface name="wl_callback" version="1">
177
+ <description summary="callback object">
178
+ Clients can handle the 'done' event to get notified when
179
+ the related request is done.
180
+
181
+ Note, because wl_callback objects are created from multiple independent
182
+ factory interfaces, the wl_callback interface is frozen at version 1.
183
+ </description>
184
+
185
+ <event name="done" type="destructor">
186
+ <description summary="done event">
187
+ Notify the client when the related request is done.
188
+ </description>
189
+ <arg name="callback_data" type="uint" summary="request-specific data for the callback"/>
190
+ </event>
191
+ </interface>
192
+
193
+ <interface name="wl_compositor" version="6">
194
+ <description summary="the compositor singleton">
195
+ A compositor. This object is a singleton global. The
196
+ compositor is in charge of combining the contents of multiple
197
+ surfaces into one displayable output.
198
+ </description>
199
+
200
+ <request name="create_surface">
201
+ <description summary="create new surface">
202
+ Ask the compositor to create a new surface.
203
+ </description>
204
+ <arg name="id" type="new_id" interface="wl_surface" summary="the new surface"/>
205
+ </request>
206
+
207
+ <request name="create_region">
208
+ <description summary="create new region">
209
+ Ask the compositor to create a new region.
210
+ </description>
211
+ <arg name="id" type="new_id" interface="wl_region" summary="the new region"/>
212
+ </request>
213
+ </interface>
214
+
215
+ <interface name="wl_shm_pool" version="2">
216
+ <description summary="a shared memory pool">
217
+ The wl_shm_pool object encapsulates a piece of memory shared
218
+ between the compositor and client. Through the wl_shm_pool
219
+ object, the client can allocate shared memory wl_buffer objects.
220
+ All objects created through the same pool share the same
221
+ underlying mapped memory. Reusing the mapped memory avoids the
222
+ setup/teardown overhead and is useful when interactively resizing
223
+ a surface or for many small buffers.
224
+ </description>
225
+
226
+ <request name="create_buffer">
227
+ <description summary="create a buffer from the pool">
228
+ Create a wl_buffer object from the pool.
229
+
230
+ The buffer is created offset bytes into the pool and has
231
+ width and height as specified. The stride argument specifies
232
+ the number of bytes from the beginning of one row to the beginning
233
+ of the next. The format is the pixel format of the buffer and
234
+ must be one of those advertised through the wl_shm.format event.
235
+
236
+ A buffer will keep a reference to the pool it was created from
237
+ so it is valid to destroy the pool immediately after creating
238
+ a buffer from it.
239
+ </description>
240
+ <arg name="id" type="new_id" interface="wl_buffer" summary="buffer to create"/>
241
+ <arg name="offset" type="int" summary="buffer byte offset within the pool"/>
242
+ <arg name="width" type="int" summary="buffer width, in pixels"/>
243
+ <arg name="height" type="int" summary="buffer height, in pixels"/>
244
+ <arg name="stride" type="int" summary="number of bytes from the beginning of one row to the beginning of the next row"/>
245
+ <arg name="format" type="uint" enum="wl_shm.format" summary="buffer pixel format"/>
246
+ </request>
247
+
248
+ <request name="destroy" type="destructor">
249
+ <description summary="destroy the pool">
250
+ Destroy the shared memory pool.
251
+
252
+ The mmapped memory will be released when all
253
+ buffers that have been created from this pool
254
+ are gone.
255
+ </description>
256
+ </request>
257
+
258
+ <request name="resize">
259
+ <description summary="change the size of the pool mapping">
260
+ This request will cause the server to remap the backing memory
261
+ for the pool from the file descriptor passed when the pool was
262
+ created, but using the new size. This request can only be
263
+ used to make the pool bigger.
264
+
265
+ This request only changes the amount of bytes that are mmapped
266
+ by the server and does not touch the file corresponding to the
267
+ file descriptor passed at creation time. It is the client's
268
+ responsibility to ensure that the file is at least as big as
269
+ the new pool size.
270
+ </description>
271
+ <arg name="size" type="int" summary="new size of the pool, in bytes"/>
272
+ </request>
273
+ </interface>
274
+
275
+ <interface name="wl_shm" version="2">
276
+ <description summary="shared memory support">
277
+ A singleton global object that provides support for shared
278
+ memory.
279
+
280
+ Clients can create wl_shm_pool objects using the create_pool
281
+ request.
282
+
283
+ On binding the wl_shm object one or more format events
284
+ are emitted to inform clients about the valid pixel formats
285
+ that can be used for buffers.
286
+ </description>
287
+
288
+ <enum name="error">
289
+ <description summary="wl_shm error values">
290
+ These errors can be emitted in response to wl_shm requests.
291
+ </description>
292
+ <entry name="invalid_format" value="0" summary="buffer format is not known"/>
293
+ <entry name="invalid_stride" value="1" summary="invalid size or stride during pool or buffer creation"/>
294
+ <entry name="invalid_fd" value="2" summary="mmapping the file descriptor failed"/>
295
+ </enum>
296
+
297
+ <enum name="format">
298
+ <description summary="pixel formats">
299
+ This describes the memory layout of an individual pixel.
300
+
301
+ All renderers should support argb8888 and xrgb8888 but any other
302
+ formats are optional and may not be supported by the particular
303
+ renderer in use.
304
+
305
+ The drm format codes match the macros defined in drm_fourcc.h, except
306
+ argb8888 and xrgb8888. The formats actually supported by the compositor
307
+ will be reported by the format event.
308
+
309
+ For all wl_shm formats and unless specified in another protocol
310
+ extension, pre-multiplied alpha is used for pixel values.
311
+ </description>
312
+ <!-- Note to protocol writers: don't update this list manually, instead
313
+ run the automated script that keeps it in sync with drm_fourcc.h. -->
314
+ <entry name="argb8888" value="0" summary="32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian"/>
315
+ <entry name="xrgb8888" value="1" summary="32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian"/>
316
+ <entry name="c8" value="0x20203843" summary="8-bit color index format, [7:0] C"/>
317
+ <entry name="rgb332" value="0x38424752" summary="8-bit RGB format, [7:0] R:G:B 3:3:2"/>
318
+ <entry name="bgr233" value="0x38524742" summary="8-bit BGR format, [7:0] B:G:R 2:3:3"/>
319
+ <entry name="xrgb4444" value="0x32315258" summary="16-bit xRGB format, [15:0] x:R:G:B 4:4:4:4 little endian"/>
320
+ <entry name="xbgr4444" value="0x32314258" summary="16-bit xBGR format, [15:0] x:B:G:R 4:4:4:4 little endian"/>
321
+ <entry name="rgbx4444" value="0x32315852" summary="16-bit RGBx format, [15:0] R:G:B:x 4:4:4:4 little endian"/>
322
+ <entry name="bgrx4444" value="0x32315842" summary="16-bit BGRx format, [15:0] B:G:R:x 4:4:4:4 little endian"/>
323
+ <entry name="argb4444" value="0x32315241" summary="16-bit ARGB format, [15:0] A:R:G:B 4:4:4:4 little endian"/>
324
+ <entry name="abgr4444" value="0x32314241" summary="16-bit ABGR format, [15:0] A:B:G:R 4:4:4:4 little endian"/>
325
+ <entry name="rgba4444" value="0x32314152" summary="16-bit RBGA format, [15:0] R:G:B:A 4:4:4:4 little endian"/>
326
+ <entry name="bgra4444" value="0x32314142" summary="16-bit BGRA format, [15:0] B:G:R:A 4:4:4:4 little endian"/>
327
+ <entry name="xrgb1555" value="0x35315258" summary="16-bit xRGB format, [15:0] x:R:G:B 1:5:5:5 little endian"/>
328
+ <entry name="xbgr1555" value="0x35314258" summary="16-bit xBGR 1555 format, [15:0] x:B:G:R 1:5:5:5 little endian"/>
329
+ <entry name="rgbx5551" value="0x35315852" summary="16-bit RGBx 5551 format, [15:0] R:G:B:x 5:5:5:1 little endian"/>
330
+ <entry name="bgrx5551" value="0x35315842" summary="16-bit BGRx 5551 format, [15:0] B:G:R:x 5:5:5:1 little endian"/>
331
+ <entry name="argb1555" value="0x35315241" summary="16-bit ARGB 1555 format, [15:0] A:R:G:B 1:5:5:5 little endian"/>
332
+ <entry name="abgr1555" value="0x35314241" summary="16-bit ABGR 1555 format, [15:0] A:B:G:R 1:5:5:5 little endian"/>
333
+ <entry name="rgba5551" value="0x35314152" summary="16-bit RGBA 5551 format, [15:0] R:G:B:A 5:5:5:1 little endian"/>
334
+ <entry name="bgra5551" value="0x35314142" summary="16-bit BGRA 5551 format, [15:0] B:G:R:A 5:5:5:1 little endian"/>
335
+ <entry name="rgb565" value="0x36314752" summary="16-bit RGB 565 format, [15:0] R:G:B 5:6:5 little endian"/>
336
+ <entry name="bgr565" value="0x36314742" summary="16-bit BGR 565 format, [15:0] B:G:R 5:6:5 little endian"/>
337
+ <entry name="rgb888" value="0x34324752" summary="24-bit RGB format, [23:0] R:G:B little endian"/>
338
+ <entry name="bgr888" value="0x34324742" summary="24-bit BGR format, [23:0] B:G:R little endian"/>
339
+ <entry name="xbgr8888" value="0x34324258" summary="32-bit xBGR format, [31:0] x:B:G:R 8:8:8:8 little endian"/>
340
+ <entry name="rgbx8888" value="0x34325852" summary="32-bit RGBx format, [31:0] R:G:B:x 8:8:8:8 little endian"/>
341
+ <entry name="bgrx8888" value="0x34325842" summary="32-bit BGRx format, [31:0] B:G:R:x 8:8:8:8 little endian"/>
342
+ <entry name="abgr8888" value="0x34324241" summary="32-bit ABGR format, [31:0] A:B:G:R 8:8:8:8 little endian"/>
343
+ <entry name="rgba8888" value="0x34324152" summary="32-bit RGBA format, [31:0] R:G:B:A 8:8:8:8 little endian"/>
344
+ <entry name="bgra8888" value="0x34324142" summary="32-bit BGRA format, [31:0] B:G:R:A 8:8:8:8 little endian"/>
345
+ <entry name="xrgb2101010" value="0x30335258" summary="32-bit xRGB format, [31:0] x:R:G:B 2:10:10:10 little endian"/>
346
+ <entry name="xbgr2101010" value="0x30334258" summary="32-bit xBGR format, [31:0] x:B:G:R 2:10:10:10 little endian"/>
347
+ <entry name="rgbx1010102" value="0x30335852" summary="32-bit RGBx format, [31:0] R:G:B:x 10:10:10:2 little endian"/>
348
+ <entry name="bgrx1010102" value="0x30335842" summary="32-bit BGRx format, [31:0] B:G:R:x 10:10:10:2 little endian"/>
349
+ <entry name="argb2101010" value="0x30335241" summary="32-bit ARGB format, [31:0] A:R:G:B 2:10:10:10 little endian"/>
350
+ <entry name="abgr2101010" value="0x30334241" summary="32-bit ABGR format, [31:0] A:B:G:R 2:10:10:10 little endian"/>
351
+ <entry name="rgba1010102" value="0x30334152" summary="32-bit RGBA format, [31:0] R:G:B:A 10:10:10:2 little endian"/>
352
+ <entry name="bgra1010102" value="0x30334142" summary="32-bit BGRA format, [31:0] B:G:R:A 10:10:10:2 little endian"/>
353
+ <entry name="yuyv" value="0x56595559" summary="packed YCbCr format, [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian"/>
354
+ <entry name="yvyu" value="0x55595659" summary="packed YCbCr format, [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian"/>
355
+ <entry name="uyvy" value="0x59565955" summary="packed YCbCr format, [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian"/>
356
+ <entry name="vyuy" value="0x59555956" summary="packed YCbCr format, [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian"/>
357
+ <entry name="ayuv" value="0x56555941" summary="packed AYCbCr format, [31:0] A:Y:Cb:Cr 8:8:8:8 little endian"/>
358
+ <entry name="nv12" value="0x3231564e" summary="2 plane YCbCr Cr:Cb format, 2x2 subsampled Cr:Cb plane"/>
359
+ <entry name="nv21" value="0x3132564e" summary="2 plane YCbCr Cb:Cr format, 2x2 subsampled Cb:Cr plane"/>
360
+ <entry name="nv16" value="0x3631564e" summary="2 plane YCbCr Cr:Cb format, 2x1 subsampled Cr:Cb plane"/>
361
+ <entry name="nv61" value="0x3136564e" summary="2 plane YCbCr Cb:Cr format, 2x1 subsampled Cb:Cr plane"/>
362
+ <entry name="yuv410" value="0x39565559" summary="3 plane YCbCr format, 4x4 subsampled Cb (1) and Cr (2) planes"/>
363
+ <entry name="yvu410" value="0x39555659" summary="3 plane YCbCr format, 4x4 subsampled Cr (1) and Cb (2) planes"/>
364
+ <entry name="yuv411" value="0x31315559" summary="3 plane YCbCr format, 4x1 subsampled Cb (1) and Cr (2) planes"/>
365
+ <entry name="yvu411" value="0x31315659" summary="3 plane YCbCr format, 4x1 subsampled Cr (1) and Cb (2) planes"/>
366
+ <entry name="yuv420" value="0x32315559" summary="3 plane YCbCr format, 2x2 subsampled Cb (1) and Cr (2) planes"/>
367
+ <entry name="yvu420" value="0x32315659" summary="3 plane YCbCr format, 2x2 subsampled Cr (1) and Cb (2) planes"/>
368
+ <entry name="yuv422" value="0x36315559" summary="3 plane YCbCr format, 2x1 subsampled Cb (1) and Cr (2) planes"/>
369
+ <entry name="yvu422" value="0x36315659" summary="3 plane YCbCr format, 2x1 subsampled Cr (1) and Cb (2) planes"/>
370
+ <entry name="yuv444" value="0x34325559" summary="3 plane YCbCr format, non-subsampled Cb (1) and Cr (2) planes"/>
371
+ <entry name="yvu444" value="0x34325659" summary="3 plane YCbCr format, non-subsampled Cr (1) and Cb (2) planes"/>
372
+ <entry name="r8" value="0x20203852" summary="[7:0] R"/>
373
+ <entry name="r16" value="0x20363152" summary="[15:0] R little endian"/>
374
+ <entry name="rg88" value="0x38384752" summary="[15:0] R:G 8:8 little endian"/>
375
+ <entry name="gr88" value="0x38385247" summary="[15:0] G:R 8:8 little endian"/>
376
+ <entry name="rg1616" value="0x32334752" summary="[31:0] R:G 16:16 little endian"/>
377
+ <entry name="gr1616" value="0x32335247" summary="[31:0] G:R 16:16 little endian"/>
378
+ <entry name="xrgb16161616f" value="0x48345258" summary="[63:0] x:R:G:B 16:16:16:16 little endian"/>
379
+ <entry name="xbgr16161616f" value="0x48344258" summary="[63:0] x:B:G:R 16:16:16:16 little endian"/>
380
+ <entry name="argb16161616f" value="0x48345241" summary="[63:0] A:R:G:B 16:16:16:16 little endian"/>
381
+ <entry name="abgr16161616f" value="0x48344241" summary="[63:0] A:B:G:R 16:16:16:16 little endian"/>
382
+ <entry name="xyuv8888" value="0x56555958" summary="[31:0] X:Y:Cb:Cr 8:8:8:8 little endian"/>
383
+ <entry name="vuy888" value="0x34325556" summary="[23:0] Cr:Cb:Y 8:8:8 little endian"/>
384
+ <entry name="vuy101010" value="0x30335556" summary="Y followed by U then V, 10:10:10. Non-linear modifier only"/>
385
+ <entry name="y210" value="0x30313259" summary="[63:0] Cr0:0:Y1:0:Cb0:0:Y0:0 10:6:10:6:10:6:10:6 little endian per 2 Y pixels"/>
386
+ <entry name="y212" value="0x32313259" summary="[63:0] Cr0:0:Y1:0:Cb0:0:Y0:0 12:4:12:4:12:4:12:4 little endian per 2 Y pixels"/>
387
+ <entry name="y216" value="0x36313259" summary="[63:0] Cr0:Y1:Cb0:Y0 16:16:16:16 little endian per 2 Y pixels"/>
388
+ <entry name="y410" value="0x30313459" summary="[31:0] A:Cr:Y:Cb 2:10:10:10 little endian"/>
389
+ <entry name="y412" value="0x32313459" summary="[63:0] A:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian"/>
390
+ <entry name="y416" value="0x36313459" summary="[63:0] A:Cr:Y:Cb 16:16:16:16 little endian"/>
391
+ <entry name="xvyu2101010" value="0x30335658" summary="[31:0] X:Cr:Y:Cb 2:10:10:10 little endian"/>
392
+ <entry name="xvyu12_16161616" value="0x36335658" summary="[63:0] X:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian"/>
393
+ <entry name="xvyu16161616" value="0x38345658" summary="[63:0] X:Cr:Y:Cb 16:16:16:16 little endian"/>
394
+ <entry name="y0l0" value="0x304c3059" summary="[63:0] A3:A2:Y3:0:Cr0:0:Y2:0:A1:A0:Y1:0:Cb0:0:Y0:0 1:1:8:2:8:2:8:2:1:1:8:2:8:2:8:2 little endian"/>
395
+ <entry name="x0l0" value="0x304c3058" summary="[63:0] X3:X2:Y3:0:Cr0:0:Y2:0:X1:X0:Y1:0:Cb0:0:Y0:0 1:1:8:2:8:2:8:2:1:1:8:2:8:2:8:2 little endian"/>
396
+ <entry name="y0l2" value="0x324c3059" summary="[63:0] A3:A2:Y3:Cr0:Y2:A1:A0:Y1:Cb0:Y0 1:1:10:10:10:1:1:10:10:10 little endian"/>
397
+ <entry name="x0l2" value="0x324c3058" summary="[63:0] X3:X2:Y3:Cr0:Y2:X1:X0:Y1:Cb0:Y0 1:1:10:10:10:1:1:10:10:10 little endian"/>
398
+ <entry name="yuv420_8bit" value="0x38305559"/>
399
+ <entry name="yuv420_10bit" value="0x30315559"/>
400
+ <entry name="xrgb8888_a8" value="0x38415258"/>
401
+ <entry name="xbgr8888_a8" value="0x38414258"/>
402
+ <entry name="rgbx8888_a8" value="0x38415852"/>
403
+ <entry name="bgrx8888_a8" value="0x38415842"/>
404
+ <entry name="rgb888_a8" value="0x38413852"/>
405
+ <entry name="bgr888_a8" value="0x38413842"/>
406
+ <entry name="rgb565_a8" value="0x38413552"/>
407
+ <entry name="bgr565_a8" value="0x38413542"/>
408
+ <entry name="nv24" value="0x3432564e" summary="non-subsampled Cr:Cb plane"/>
409
+ <entry name="nv42" value="0x3234564e" summary="non-subsampled Cb:Cr plane"/>
410
+ <entry name="p210" value="0x30313250" summary="2x1 subsampled Cr:Cb plane, 10 bit per channel"/>
411
+ <entry name="p010" value="0x30313050" summary="2x2 subsampled Cr:Cb plane 10 bits per channel"/>
412
+ <entry name="p012" value="0x32313050" summary="2x2 subsampled Cr:Cb plane 12 bits per channel"/>
413
+ <entry name="p016" value="0x36313050" summary="2x2 subsampled Cr:Cb plane 16 bits per channel"/>
414
+ <entry name="axbxgxrx106106106106" value="0x30314241" summary="[63:0] A:x:B:x:G:x:R:x 10:6:10:6:10:6:10:6 little endian"/>
415
+ <entry name="nv15" value="0x3531564e" summary="2x2 subsampled Cr:Cb plane"/>
416
+ <entry name="q410" value="0x30313451"/>
417
+ <entry name="q401" value="0x31303451"/>
418
+ <entry name="xrgb16161616" value="0x38345258" summary="[63:0] x:R:G:B 16:16:16:16 little endian"/>
419
+ <entry name="xbgr16161616" value="0x38344258" summary="[63:0] x:B:G:R 16:16:16:16 little endian"/>
420
+ <entry name="argb16161616" value="0x38345241" summary="[63:0] A:R:G:B 16:16:16:16 little endian"/>
421
+ <entry name="abgr16161616" value="0x38344241" summary="[63:0] A:B:G:R 16:16:16:16 little endian"/>
422
+ <entry name="c1" value="0x20203143" summary="[7:0] C0:C1:C2:C3:C4:C5:C6:C7 1:1:1:1:1:1:1:1 eight pixels/byte"/>
423
+ <entry name="c2" value="0x20203243" summary="[7:0] C0:C1:C2:C3 2:2:2:2 four pixels/byte"/>
424
+ <entry name="c4" value="0x20203443" summary="[7:0] C0:C1 4:4 two pixels/byte"/>
425
+ <entry name="d1" value="0x20203144" summary="[7:0] D0:D1:D2:D3:D4:D5:D6:D7 1:1:1:1:1:1:1:1 eight pixels/byte"/>
426
+ <entry name="d2" value="0x20203244" summary="[7:0] D0:D1:D2:D3 2:2:2:2 four pixels/byte"/>
427
+ <entry name="d4" value="0x20203444" summary="[7:0] D0:D1 4:4 two pixels/byte"/>
428
+ <entry name="d8" value="0x20203844" summary="[7:0] D"/>
429
+ <entry name="r1" value="0x20203152" summary="[7:0] R0:R1:R2:R3:R4:R5:R6:R7 1:1:1:1:1:1:1:1 eight pixels/byte"/>
430
+ <entry name="r2" value="0x20203252" summary="[7:0] R0:R1:R2:R3 2:2:2:2 four pixels/byte"/>
431
+ <entry name="r4" value="0x20203452" summary="[7:0] R0:R1 4:4 two pixels/byte"/>
432
+ <entry name="r10" value="0x20303152" summary="[15:0] x:R 6:10 little endian"/>
433
+ <entry name="r12" value="0x20323152" summary="[15:0] x:R 4:12 little endian"/>
434
+ <entry name="avuy8888" value="0x59555641" summary="[31:0] A:Cr:Cb:Y 8:8:8:8 little endian"/>
435
+ <entry name="xvuy8888" value="0x59555658" summary="[31:0] X:Cr:Cb:Y 8:8:8:8 little endian"/>
436
+ <entry name="p030" value="0x30333050" summary="2x2 subsampled Cr:Cb plane 10 bits per channel packed"/>
437
+ </enum>
438
+
439
+ <request name="create_pool">
440
+ <description summary="create a shm pool">
441
+ Create a new wl_shm_pool object.
442
+
443
+ The pool can be used to create shared memory based buffer
444
+ objects. The server will mmap size bytes of the passed file
445
+ descriptor, to use as backing memory for the pool.
446
+ </description>
447
+ <arg name="id" type="new_id" interface="wl_shm_pool" summary="pool to create"/>
448
+ <arg name="fd" type="fd" summary="file descriptor for the pool"/>
449
+ <arg name="size" type="int" summary="pool size, in bytes"/>
450
+ </request>
451
+
452
+ <event name="format">
453
+ <description summary="pixel format description">
454
+ Informs the client about a valid pixel format that
455
+ can be used for buffers. Known formats include
456
+ argb8888 and xrgb8888.
457
+ </description>
458
+ <arg name="format" type="uint" enum="format" summary="buffer pixel format"/>
459
+ </event>
460
+
461
+ <!-- Version 2 additions -->
462
+
463
+ <request name="release" type="destructor" since="2">
464
+ <description summary="release the shm object">
465
+ Using this request a client can tell the server that it is not going to
466
+ use the shm object anymore.
467
+
468
+ Objects created via this interface remain unaffected.
469
+ </description>
470
+ </request>
471
+ </interface>
472
+
473
+ <interface name="wl_buffer" version="1">
474
+ <description summary="content for a wl_surface">
475
+ A buffer provides the content for a wl_surface. Buffers are
476
+ created through factory interfaces such as wl_shm, wp_linux_buffer_params
477
+ (from the linux-dmabuf protocol extension) or similar. It has a width and
478
+ a height and can be attached to a wl_surface, but the mechanism by which a
479
+ client provides and updates the contents is defined by the buffer factory
480
+ interface.
481
+
482
+ Color channels are assumed to be electrical rather than optical (in other
483
+ words, encoded with a transfer function) unless otherwise specified. If
484
+ the buffer uses a format that has an alpha channel, the alpha channel is
485
+ assumed to be premultiplied into the electrical color channel values
486
+ (after transfer function encoding) unless otherwise specified.
487
+
488
+ Note, because wl_buffer objects are created from multiple independent
489
+ factory interfaces, the wl_buffer interface is frozen at version 1.
490
+ </description>
491
+
492
+ <request name="destroy" type="destructor">
493
+ <description summary="destroy a buffer">
494
+ Destroy a buffer. If and how you need to release the backing
495
+ storage is defined by the buffer factory interface.
496
+
497
+ For possible side-effects to a surface, see wl_surface.attach.
498
+ </description>
499
+ </request>
500
+
501
+ <event name="release">
502
+ <description summary="compositor releases buffer">
503
+ Sent when this wl_buffer is no longer used by the compositor.
504
+ The client is now free to reuse or destroy this buffer and its
505
+ backing storage.
506
+
507
+ If a client receives a release event before the frame callback
508
+ requested in the same wl_surface.commit that attaches this
509
+ wl_buffer to a surface, then the client is immediately free to
510
+ reuse the buffer and its backing storage, and does not need a
511
+ second buffer for the next surface content update. Typically
512
+ this is possible, when the compositor maintains a copy of the
513
+ wl_surface contents, e.g. as a GL texture. This is an important
514
+ optimization for GL(ES) compositors with wl_shm clients.
515
+ </description>
516
+ </event>
517
+ </interface>
518
+
519
+ <interface name="wl_data_offer" version="3">
520
+ <description summary="offer to transfer data">
521
+ A wl_data_offer represents a piece of data offered for transfer
522
+ by another client (the source client). It is used by the
523
+ copy-and-paste and drag-and-drop mechanisms. The offer
524
+ describes the different mime types that the data can be
525
+ converted to and provides the mechanism for transferring the
526
+ data directly from the source client.
527
+ </description>
528
+
529
+ <enum name="error">
530
+ <entry name="invalid_finish" value="0"
531
+ summary="finish request was called untimely"/>
532
+ <entry name="invalid_action_mask" value="1"
533
+ summary="action mask contains invalid values"/>
534
+ <entry name="invalid_action" value="2"
535
+ summary="action argument has an invalid value"/>
536
+ <entry name="invalid_offer" value="3"
537
+ summary="offer doesn't accept this request"/>
538
+ </enum>
539
+
540
+ <request name="accept">
541
+ <description summary="accept one of the offered mime types">
542
+ Indicate that the client can accept the given mime type, or
543
+ NULL for not accepted.
544
+
545
+ For objects of version 2 or older, this request is used by the
546
+ client to give feedback whether the client can receive the given
547
+ mime type, or NULL if none is accepted; the feedback does not
548
+ determine whether the drag-and-drop operation succeeds or not.
549
+
550
+ For objects of version 3 or newer, this request determines the
551
+ final result of the drag-and-drop operation. If the end result
552
+ is that no mime types were accepted, the drag-and-drop operation
553
+ will be cancelled and the corresponding drag source will receive
554
+ wl_data_source.cancelled. Clients may still use this event in
555
+ conjunction with wl_data_source.action for feedback.
556
+ </description>
557
+ <arg name="serial" type="uint" summary="serial number of the accept request"/>
558
+ <arg name="mime_type" type="string" allow-null="true" summary="mime type accepted by the client"/>
559
+ </request>
560
+
561
+ <request name="receive">
562
+ <description summary="request that the data is transferred">
563
+ To transfer the offered data, the client issues this request
564
+ and indicates the mime type it wants to receive. The transfer
565
+ happens through the passed file descriptor (typically created
566
+ with the pipe system call). The source client writes the data
567
+ in the mime type representation requested and then closes the
568
+ file descriptor.
569
+
570
+ The receiving client reads from the read end of the pipe until
571
+ EOF and then closes its end, at which point the transfer is
572
+ complete.
573
+
574
+ This request may happen multiple times for different mime types,
575
+ both before and after wl_data_device.drop. Drag-and-drop destination
576
+ clients may preemptively fetch data or examine it more closely to
577
+ determine acceptance.
578
+ </description>
579
+ <arg name="mime_type" type="string" summary="mime type desired by receiver"/>
580
+ <arg name="fd" type="fd" summary="file descriptor for data transfer"/>
581
+ </request>
582
+
583
+ <request name="destroy" type="destructor">
584
+ <description summary="destroy data offer">
585
+ Destroy the data offer.
586
+ </description>
587
+ </request>
588
+
589
+ <event name="offer">
590
+ <description summary="advertise offered mime type">
591
+ Sent immediately after creating the wl_data_offer object. One
592
+ event per offered mime type.
593
+ </description>
594
+ <arg name="mime_type" type="string" summary="offered mime type"/>
595
+ </event>
596
+
597
+ <!-- Version 3 additions -->
598
+
599
+ <request name="finish" since="3">
600
+ <description summary="the offer will no longer be used">
601
+ Notifies the compositor that the drag destination successfully
602
+ finished the drag-and-drop operation.
603
+
604
+ Upon receiving this request, the compositor will emit
605
+ wl_data_source.dnd_finished on the drag source client.
606
+
607
+ It is a client error to perform other requests than
608
+ wl_data_offer.destroy after this one. It is also an error to perform
609
+ this request after a NULL mime type has been set in
610
+ wl_data_offer.accept or no action was received through
611
+ wl_data_offer.action.
612
+
613
+ If wl_data_offer.finish request is received for a non drag and drop
614
+ operation, the invalid_finish protocol error is raised.
615
+ </description>
616
+ </request>
617
+
618
+ <request name="set_actions" since="3">
619
+ <description summary="set the available/preferred drag-and-drop actions">
620
+ Sets the actions that the destination side client supports for
621
+ this operation. This request may trigger the emission of
622
+ wl_data_source.action and wl_data_offer.action events if the compositor
623
+ needs to change the selected action.
624
+
625
+ This request can be called multiple times throughout the
626
+ drag-and-drop operation, typically in response to wl_data_device.enter
627
+ or wl_data_device.motion events.
628
+
629
+ This request determines the final result of the drag-and-drop
630
+ operation. If the end result is that no action is accepted,
631
+ the drag source will receive wl_data_source.cancelled.
632
+
633
+ The dnd_actions argument must contain only values expressed in the
634
+ wl_data_device_manager.dnd_actions enum, and the preferred_action
635
+ argument must only contain one of those values set, otherwise it
636
+ will result in a protocol error.
637
+
638
+ While managing an "ask" action, the destination drag-and-drop client
639
+ may perform further wl_data_offer.receive requests, and is expected
640
+ to perform one last wl_data_offer.set_actions request with a preferred
641
+ action other than "ask" (and optionally wl_data_offer.accept) before
642
+ requesting wl_data_offer.finish, in order to convey the action selected
643
+ by the user. If the preferred action is not in the
644
+ wl_data_offer.source_actions mask, an error will be raised.
645
+
646
+ If the "ask" action is dismissed (e.g. user cancellation), the client
647
+ is expected to perform wl_data_offer.destroy right away.
648
+
649
+ This request can only be made on drag-and-drop offers, a protocol error
650
+ will be raised otherwise.
651
+ </description>
652
+ <arg name="dnd_actions" type="uint" summary="actions supported by the destination client"
653
+ enum="wl_data_device_manager.dnd_action"/>
654
+ <arg name="preferred_action" type="uint" summary="action preferred by the destination client"
655
+ enum="wl_data_device_manager.dnd_action"/>
656
+ </request>
657
+
658
+ <event name="source_actions" since="3">
659
+ <description summary="notify the source-side available actions">
660
+ This event indicates the actions offered by the data source. It
661
+ will be sent immediately after creating the wl_data_offer object,
662
+ or anytime the source side changes its offered actions through
663
+ wl_data_source.set_actions.
664
+ </description>
665
+ <arg name="source_actions" type="uint" summary="actions offered by the data source"
666
+ enum="wl_data_device_manager.dnd_action"/>
667
+ </event>
668
+
669
+ <event name="action" since="3">
670
+ <description summary="notify the selected action">
671
+ This event indicates the action selected by the compositor after
672
+ matching the source/destination side actions. Only one action (or
673
+ none) will be offered here.
674
+
675
+ This event can be emitted multiple times during the drag-and-drop
676
+ operation in response to destination side action changes through
677
+ wl_data_offer.set_actions.
678
+
679
+ This event will no longer be emitted after wl_data_device.drop
680
+ happened on the drag-and-drop destination, the client must
681
+ honor the last action received, or the last preferred one set
682
+ through wl_data_offer.set_actions when handling an "ask" action.
683
+
684
+ Compositors may also change the selected action on the fly, mainly
685
+ in response to keyboard modifier changes during the drag-and-drop
686
+ operation.
687
+
688
+ The most recent action received is always the valid one. Prior to
689
+ receiving wl_data_device.drop, the chosen action may change (e.g.
690
+ due to keyboard modifiers being pressed). At the time of receiving
691
+ wl_data_device.drop the drag-and-drop destination must honor the
692
+ last action received.
693
+
694
+ Action changes may still happen after wl_data_device.drop,
695
+ especially on "ask" actions, where the drag-and-drop destination
696
+ may choose another action afterwards. Action changes happening
697
+ at this stage are always the result of inter-client negotiation, the
698
+ compositor shall no longer be able to induce a different action.
699
+
700
+ Upon "ask" actions, it is expected that the drag-and-drop destination
701
+ may potentially choose a different action and/or mime type,
702
+ based on wl_data_offer.source_actions and finally chosen by the
703
+ user (e.g. popping up a menu with the available options). The
704
+ final wl_data_offer.set_actions and wl_data_offer.accept requests
705
+ must happen before the call to wl_data_offer.finish.
706
+ </description>
707
+ <arg name="dnd_action" type="uint" summary="action selected by the compositor"
708
+ enum="wl_data_device_manager.dnd_action"/>
709
+ </event>
710
+ </interface>
711
+
712
+ <interface name="wl_data_source" version="3">
713
+ <description summary="offer to transfer data">
714
+ The wl_data_source object is the source side of a wl_data_offer.
715
+ It is created by the source client in a data transfer and
716
+ provides a way to describe the offered data and a way to respond
717
+ to requests to transfer the data.
718
+ </description>
719
+
720
+ <enum name="error">
721
+ <entry name="invalid_action_mask" value="0"
722
+ summary="action mask contains invalid values"/>
723
+ <entry name="invalid_source" value="1"
724
+ summary="source doesn't accept this request"/>
725
+ </enum>
726
+
727
+ <request name="offer">
728
+ <description summary="add an offered mime type">
729
+ This request adds a mime type to the set of mime types
730
+ advertised to targets. Can be called several times to offer
731
+ multiple types.
732
+ </description>
733
+ <arg name="mime_type" type="string" summary="mime type offered by the data source"/>
734
+ </request>
735
+
736
+ <request name="destroy" type="destructor">
737
+ <description summary="destroy the data source">
738
+ Destroy the data source.
739
+ </description>
740
+ </request>
741
+
742
+ <event name="target">
743
+ <description summary="a target accepts an offered mime type">
744
+ Sent when a target accepts pointer_focus or motion events. If
745
+ a target does not accept any of the offered types, type is NULL.
746
+
747
+ Used for feedback during drag-and-drop.
748
+ </description>
749
+ <arg name="mime_type" type="string" allow-null="true" summary="mime type accepted by the target"/>
750
+ </event>
751
+
752
+ <event name="send">
753
+ <description summary="send the data">
754
+ Request for data from the client. Send the data as the
755
+ specified mime type over the passed file descriptor, then
756
+ close it.
757
+ </description>
758
+ <arg name="mime_type" type="string" summary="mime type for the data"/>
759
+ <arg name="fd" type="fd" summary="file descriptor for the data"/>
760
+ </event>
761
+
762
+ <event name="cancelled">
763
+ <description summary="selection was cancelled">
764
+ This data source is no longer valid. There are several reasons why
765
+ this could happen:
766
+
767
+ - The data source has been replaced by another data source.
768
+ - The drag-and-drop operation was performed, but the drop destination
769
+ did not accept any of the mime types offered through
770
+ wl_data_source.target.
771
+ - The drag-and-drop operation was performed, but the drop destination
772
+ did not select any of the actions present in the mask offered through
773
+ wl_data_source.action.
774
+ - The drag-and-drop operation was performed but didn't happen over a
775
+ surface.
776
+ - The compositor cancelled the drag-and-drop operation (e.g. compositor
777
+ dependent timeouts to avoid stale drag-and-drop transfers).
778
+
779
+ The client should clean up and destroy this data source.
780
+
781
+ For objects of version 2 or older, wl_data_source.cancelled will
782
+ only be emitted if the data source was replaced by another data
783
+ source.
784
+ </description>
785
+ </event>
786
+
787
+ <!-- Version 3 additions -->
788
+
789
+ <request name="set_actions" since="3">
790
+ <description summary="set the available drag-and-drop actions">
791
+ Sets the actions that the source side client supports for this
792
+ operation. This request may trigger wl_data_source.action and
793
+ wl_data_offer.action events if the compositor needs to change the
794
+ selected action.
795
+
796
+ The dnd_actions argument must contain only values expressed in the
797
+ wl_data_device_manager.dnd_actions enum, otherwise it will result
798
+ in a protocol error.
799
+
800
+ This request must be made once only, and can only be made on sources
801
+ used in drag-and-drop, so it must be performed before
802
+ wl_data_device.start_drag. Attempting to use the source other than
803
+ for drag-and-drop will raise a protocol error.
804
+ </description>
805
+ <arg name="dnd_actions" type="uint" summary="actions supported by the data source"
806
+ enum="wl_data_device_manager.dnd_action"/>
807
+ </request>
808
+
809
+ <event name="dnd_drop_performed" since="3">
810
+ <description summary="the drag-and-drop operation physically finished">
811
+ The user performed the drop action. This event does not indicate
812
+ acceptance, wl_data_source.cancelled may still be emitted afterwards
813
+ if the drop destination does not accept any mime type.
814
+
815
+ However, this event might however not be received if the compositor
816
+ cancelled the drag-and-drop operation before this event could happen.
817
+
818
+ Note that the data_source may still be used in the future and should
819
+ not be destroyed here.
820
+ </description>
821
+ </event>
822
+
823
+ <event name="dnd_finished" since="3">
824
+ <description summary="the drag-and-drop operation concluded">
825
+ The drop destination finished interoperating with this data
826
+ source, so the client is now free to destroy this data source and
827
+ free all associated data.
828
+
829
+ If the action used to perform the operation was "move", the
830
+ source can now delete the transferred data.
831
+ </description>
832
+ </event>
833
+
834
+ <event name="action" since="3">
835
+ <description summary="notify the selected action">
836
+ This event indicates the action selected by the compositor after
837
+ matching the source/destination side actions. Only one action (or
838
+ none) will be offered here.
839
+
840
+ This event can be emitted multiple times during the drag-and-drop
841
+ operation, mainly in response to destination side changes through
842
+ wl_data_offer.set_actions, and as the data device enters/leaves
843
+ surfaces.
844
+
845
+ It is only possible to receive this event after
846
+ wl_data_source.dnd_drop_performed if the drag-and-drop operation
847
+ ended in an "ask" action, in which case the final wl_data_source.action
848
+ event will happen immediately before wl_data_source.dnd_finished.
849
+
850
+ Compositors may also change the selected action on the fly, mainly
851
+ in response to keyboard modifier changes during the drag-and-drop
852
+ operation.
853
+
854
+ The most recent action received is always the valid one. The chosen
855
+ action may change alongside negotiation (e.g. an "ask" action can turn
856
+ into a "move" operation), so the effects of the final action must
857
+ always be applied in wl_data_offer.dnd_finished.
858
+
859
+ Clients can trigger cursor surface changes from this point, so
860
+ they reflect the current action.
861
+ </description>
862
+ <arg name="dnd_action" type="uint" summary="action selected by the compositor"
863
+ enum="wl_data_device_manager.dnd_action"/>
864
+ </event>
865
+ </interface>
866
+
867
+ <interface name="wl_data_device" version="3">
868
+ <description summary="data transfer device">
869
+ There is one wl_data_device per seat which can be obtained
870
+ from the global wl_data_device_manager singleton.
871
+
872
+ A wl_data_device provides access to inter-client data transfer
873
+ mechanisms such as copy-and-paste and drag-and-drop.
874
+ </description>
875
+
876
+ <enum name="error">
877
+ <entry name="role" value="0" summary="given wl_surface has another role"/>
878
+ <entry name="used_source" value="1" summary="source has already been used"/>
879
+ </enum>
880
+
881
+ <request name="start_drag">
882
+ <description summary="start drag-and-drop operation">
883
+ This request asks the compositor to start a drag-and-drop
884
+ operation on behalf of the client.
885
+
886
+ The source argument is the data source that provides the data
887
+ for the eventual data transfer. If source is NULL, enter, leave
888
+ and motion events are sent only to the client that initiated the
889
+ drag and the client is expected to handle the data passing
890
+ internally. If source is destroyed, the drag-and-drop session will be
891
+ cancelled.
892
+
893
+ The origin surface is the surface where the drag originates and
894
+ the client must have an active implicit grab that matches the
895
+ serial.
896
+
897
+ The icon surface is an optional (can be NULL) surface that
898
+ provides an icon to be moved around with the cursor. Initially,
899
+ the top-left corner of the icon surface is placed at the cursor
900
+ hotspot, but subsequent wl_surface.offset requests can move the
901
+ relative position. Attach requests must be confirmed with
902
+ wl_surface.commit as usual. The icon surface is given the role of
903
+ a drag-and-drop icon. If the icon surface already has another role,
904
+ it raises a protocol error.
905
+
906
+ The input region is ignored for wl_surfaces with the role of a
907
+ drag-and-drop icon.
908
+
909
+ The given source may not be used in any further set_selection or
910
+ start_drag requests. Attempting to reuse a previously-used source
911
+ may send a used_source error.
912
+ </description>
913
+ <arg name="source" type="object" interface="wl_data_source" allow-null="true" summary="data source for the eventual transfer"/>
914
+ <arg name="origin" type="object" interface="wl_surface" summary="surface where the drag originates"/>
915
+ <arg name="icon" type="object" interface="wl_surface" allow-null="true" summary="drag-and-drop icon surface"/>
916
+ <arg name="serial" type="uint" summary="serial number of the implicit grab on the origin"/>
917
+ </request>
918
+
919
+ <request name="set_selection">
920
+ <description summary="copy data to the selection">
921
+ This request asks the compositor to set the selection
922
+ to the data from the source on behalf of the client.
923
+
924
+ To unset the selection, set the source to NULL.
925
+
926
+ The given source may not be used in any further set_selection or
927
+ start_drag requests. Attempting to reuse a previously-used source
928
+ may send a used_source error.
929
+ </description>
930
+ <arg name="source" type="object" interface="wl_data_source" allow-null="true" summary="data source for the selection"/>
931
+ <arg name="serial" type="uint" summary="serial number of the event that triggered this request"/>
932
+ </request>
933
+
934
+ <event name="data_offer">
935
+ <description summary="introduce a new wl_data_offer">
936
+ The data_offer event introduces a new wl_data_offer object,
937
+ which will subsequently be used in either the
938
+ data_device.enter event (for drag-and-drop) or the
939
+ data_device.selection event (for selections). Immediately
940
+ following the data_device.data_offer event, the new data_offer
941
+ object will send out data_offer.offer events to describe the
942
+ mime types it offers.
943
+ </description>
944
+ <arg name="id" type="new_id" interface="wl_data_offer" summary="the new data_offer object"/>
945
+ </event>
946
+
947
+ <event name="enter">
948
+ <description summary="initiate drag-and-drop session">
949
+ This event is sent when an active drag-and-drop pointer enters
950
+ a surface owned by the client. The position of the pointer at
951
+ enter time is provided by the x and y arguments, in surface-local
952
+ coordinates.
953
+ </description>
954
+ <arg name="serial" type="uint" summary="serial number of the enter event"/>
955
+ <arg name="surface" type="object" interface="wl_surface" summary="client surface entered"/>
956
+ <arg name="x" type="fixed" summary="surface-local x coordinate"/>
957
+ <arg name="y" type="fixed" summary="surface-local y coordinate"/>
958
+ <arg name="id" type="object" interface="wl_data_offer" allow-null="true"
959
+ summary="source data_offer object"/>
960
+ </event>
961
+
962
+ <event name="leave">
963
+ <description summary="end drag-and-drop session">
964
+ This event is sent when the drag-and-drop pointer leaves the
965
+ surface and the session ends. The client must destroy the
966
+ wl_data_offer introduced at enter time at this point.
967
+ </description>
968
+ </event>
969
+
970
+ <event name="motion">
971
+ <description summary="drag-and-drop session motion">
972
+ This event is sent when the drag-and-drop pointer moves within
973
+ the currently focused surface. The new position of the pointer
974
+ is provided by the x and y arguments, in surface-local
975
+ coordinates.
976
+ </description>
977
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
978
+ <arg name="x" type="fixed" summary="surface-local x coordinate"/>
979
+ <arg name="y" type="fixed" summary="surface-local y coordinate"/>
980
+ </event>
981
+
982
+ <event name="drop">
983
+ <description summary="end drag-and-drop session successfully">
984
+ The event is sent when a drag-and-drop operation is ended
985
+ because the implicit grab is removed.
986
+
987
+ The drag-and-drop destination is expected to honor the last action
988
+ received through wl_data_offer.action, if the resulting action is
989
+ "copy" or "move", the destination can still perform
990
+ wl_data_offer.receive requests, and is expected to end all
991
+ transfers with a wl_data_offer.finish request.
992
+
993
+ If the resulting action is "ask", the action will not be considered
994
+ final. The drag-and-drop destination is expected to perform one last
995
+ wl_data_offer.set_actions request, or wl_data_offer.destroy in order
996
+ to cancel the operation.
997
+ </description>
998
+ </event>
999
+
1000
+ <event name="selection">
1001
+ <description summary="advertise new selection">
1002
+ The selection event is sent out to notify the client of a new
1003
+ wl_data_offer for the selection for this device. The
1004
+ data_device.data_offer and the data_offer.offer events are
1005
+ sent out immediately before this event to introduce the data
1006
+ offer object. The selection event is sent to a client
1007
+ immediately before receiving keyboard focus and when a new
1008
+ selection is set while the client has keyboard focus. The
1009
+ data_offer is valid until a new data_offer or NULL is received
1010
+ or until the client loses keyboard focus. Switching surface with
1011
+ keyboard focus within the same client doesn't mean a new selection
1012
+ will be sent. The client must destroy the previous selection
1013
+ data_offer, if any, upon receiving this event.
1014
+ </description>
1015
+ <arg name="id" type="object" interface="wl_data_offer" allow-null="true"
1016
+ summary="selection data_offer object"/>
1017
+ </event>
1018
+
1019
+ <!-- Version 2 additions -->
1020
+
1021
+ <request name="release" type="destructor" since="2">
1022
+ <description summary="destroy data device">
1023
+ This request destroys the data device.
1024
+ </description>
1025
+ </request>
1026
+ </interface>
1027
+
1028
+ <interface name="wl_data_device_manager" version="3">
1029
+ <description summary="data transfer interface">
1030
+ The wl_data_device_manager is a singleton global object that
1031
+ provides access to inter-client data transfer mechanisms such as
1032
+ copy-and-paste and drag-and-drop. These mechanisms are tied to
1033
+ a wl_seat and this interface lets a client get a wl_data_device
1034
+ corresponding to a wl_seat.
1035
+
1036
+ Depending on the version bound, the objects created from the bound
1037
+ wl_data_device_manager object will have different requirements for
1038
+ functioning properly. See wl_data_source.set_actions,
1039
+ wl_data_offer.accept and wl_data_offer.finish for details.
1040
+ </description>
1041
+
1042
+ <request name="create_data_source">
1043
+ <description summary="create a new data source">
1044
+ Create a new data source.
1045
+ </description>
1046
+ <arg name="id" type="new_id" interface="wl_data_source" summary="data source to create"/>
1047
+ </request>
1048
+
1049
+ <request name="get_data_device">
1050
+ <description summary="create a new data device">
1051
+ Create a new data device for a given seat.
1052
+ </description>
1053
+ <arg name="id" type="new_id" interface="wl_data_device" summary="data device to create"/>
1054
+ <arg name="seat" type="object" interface="wl_seat" summary="seat associated with the data device"/>
1055
+ </request>
1056
+
1057
+ <!-- Version 3 additions -->
1058
+
1059
+ <enum name="dnd_action" bitfield="true" since="3">
1060
+ <description summary="drag and drop actions">
1061
+ This is a bitmask of the available/preferred actions in a
1062
+ drag-and-drop operation.
1063
+
1064
+ In the compositor, the selected action is a result of matching the
1065
+ actions offered by the source and destination sides. "action" events
1066
+ with a "none" action will be sent to both source and destination if
1067
+ there is no match. All further checks will effectively happen on
1068
+ (source actions ∩ destination actions).
1069
+
1070
+ In addition, compositors may also pick different actions in
1071
+ reaction to key modifiers being pressed. One common design that
1072
+ is used in major toolkits (and the behavior recommended for
1073
+ compositors) is:
1074
+
1075
+ - If no modifiers are pressed, the first match (in bit order)
1076
+ will be used.
1077
+ - Pressing Shift selects "move", if enabled in the mask.
1078
+ - Pressing Control selects "copy", if enabled in the mask.
1079
+
1080
+ Behavior beyond that is considered implementation-dependent.
1081
+ Compositors may for example bind other modifiers (like Alt/Meta)
1082
+ or drags initiated with other buttons than BTN_LEFT to specific
1083
+ actions (e.g. "ask").
1084
+ </description>
1085
+ <entry name="none" value="0" summary="no action"/>
1086
+ <entry name="copy" value="1" summary="copy action"/>
1087
+ <entry name="move" value="2" summary="move action"/>
1088
+ <entry name="ask" value="4" summary="ask action"/>
1089
+ </enum>
1090
+ </interface>
1091
+
1092
+ <interface name="wl_shell" version="1">
1093
+ <description summary="create desktop-style surfaces">
1094
+ This interface is implemented by servers that provide
1095
+ desktop-style user interfaces.
1096
+
1097
+ It allows clients to associate a wl_shell_surface with
1098
+ a basic surface.
1099
+
1100
+ Note! This protocol is deprecated and not intended for production use.
1101
+ For desktop-style user interfaces, use xdg_shell. Compositors and clients
1102
+ should not implement this interface.
1103
+ </description>
1104
+
1105
+ <enum name="error">
1106
+ <entry name="role" value="0" summary="given wl_surface has another role"/>
1107
+ </enum>
1108
+
1109
+ <request name="get_shell_surface">
1110
+ <description summary="create a shell surface from a surface">
1111
+ Create a shell surface for an existing surface. This gives
1112
+ the wl_surface the role of a shell surface. If the wl_surface
1113
+ already has another role, it raises a protocol error.
1114
+
1115
+ Only one shell surface can be associated with a given surface.
1116
+ </description>
1117
+ <arg name="id" type="new_id" interface="wl_shell_surface" summary="shell surface to create"/>
1118
+ <arg name="surface" type="object" interface="wl_surface" summary="surface to be given the shell surface role"/>
1119
+ </request>
1120
+ </interface>
1121
+
1122
+ <interface name="wl_shell_surface" version="1">
1123
+ <description summary="desktop-style metadata interface">
1124
+ An interface that may be implemented by a wl_surface, for
1125
+ implementations that provide a desktop-style user interface.
1126
+
1127
+ It provides requests to treat surfaces like toplevel, fullscreen
1128
+ or popup windows, move, resize or maximize them, associate
1129
+ metadata like title and class, etc.
1130
+
1131
+ On the server side the object is automatically destroyed when
1132
+ the related wl_surface is destroyed. On the client side,
1133
+ wl_shell_surface_destroy() must be called before destroying
1134
+ the wl_surface object.
1135
+ </description>
1136
+
1137
+ <request name="pong">
1138
+ <description summary="respond to a ping event">
1139
+ A client must respond to a ping event with a pong request or
1140
+ the client may be deemed unresponsive.
1141
+ </description>
1142
+ <arg name="serial" type="uint" summary="serial number of the ping event"/>
1143
+ </request>
1144
+
1145
+ <request name="move">
1146
+ <description summary="start an interactive move">
1147
+ Start a pointer-driven move of the surface.
1148
+
1149
+ This request must be used in response to a button press event.
1150
+ The server may ignore move requests depending on the state of
1151
+ the surface (e.g. fullscreen or maximized).
1152
+ </description>
1153
+ <arg name="seat" type="object" interface="wl_seat" summary="seat whose pointer is used"/>
1154
+ <arg name="serial" type="uint" summary="serial number of the implicit grab on the pointer"/>
1155
+ </request>
1156
+
1157
+ <enum name="resize" bitfield="true">
1158
+ <description summary="edge values for resizing">
1159
+ These values are used to indicate which edge of a surface
1160
+ is being dragged in a resize operation. The server may
1161
+ use this information to adapt its behavior, e.g. choose
1162
+ an appropriate cursor image.
1163
+ </description>
1164
+ <entry name="none" value="0" summary="no edge"/>
1165
+ <entry name="top" value="1" summary="top edge"/>
1166
+ <entry name="bottom" value="2" summary="bottom edge"/>
1167
+ <entry name="left" value="4" summary="left edge"/>
1168
+ <entry name="top_left" value="5" summary="top and left edges"/>
1169
+ <entry name="bottom_left" value="6" summary="bottom and left edges"/>
1170
+ <entry name="right" value="8" summary="right edge"/>
1171
+ <entry name="top_right" value="9" summary="top and right edges"/>
1172
+ <entry name="bottom_right" value="10" summary="bottom and right edges"/>
1173
+ </enum>
1174
+
1175
+ <request name="resize">
1176
+ <description summary="start an interactive resize">
1177
+ Start a pointer-driven resizing of the surface.
1178
+
1179
+ This request must be used in response to a button press event.
1180
+ The server may ignore resize requests depending on the state of
1181
+ the surface (e.g. fullscreen or maximized).
1182
+ </description>
1183
+ <arg name="seat" type="object" interface="wl_seat" summary="seat whose pointer is used"/>
1184
+ <arg name="serial" type="uint" summary="serial number of the implicit grab on the pointer"/>
1185
+ <arg name="edges" type="uint" enum="resize" summary="which edge or corner is being dragged"/>
1186
+ </request>
1187
+
1188
+ <request name="set_toplevel">
1189
+ <description summary="make the surface a toplevel surface">
1190
+ Map the surface as a toplevel surface.
1191
+
1192
+ A toplevel surface is not fullscreen, maximized or transient.
1193
+ </description>
1194
+ </request>
1195
+
1196
+ <enum name="transient" bitfield="true">
1197
+ <description summary="details of transient behaviour">
1198
+ These flags specify details of the expected behaviour
1199
+ of transient surfaces. Used in the set_transient request.
1200
+ </description>
1201
+ <entry name="inactive" value="0x1" summary="do not set keyboard focus"/>
1202
+ </enum>
1203
+
1204
+ <request name="set_transient">
1205
+ <description summary="make the surface a transient surface">
1206
+ Map the surface relative to an existing surface.
1207
+
1208
+ The x and y arguments specify the location of the upper left
1209
+ corner of the surface relative to the upper left corner of the
1210
+ parent surface, in surface-local coordinates.
1211
+
1212
+ The flags argument controls details of the transient behaviour.
1213
+ </description>
1214
+ <arg name="parent" type="object" interface="wl_surface" summary="parent surface"/>
1215
+ <arg name="x" type="int" summary="surface-local x coordinate"/>
1216
+ <arg name="y" type="int" summary="surface-local y coordinate"/>
1217
+ <arg name="flags" type="uint" enum="transient" summary="transient surface behavior"/>
1218
+ </request>
1219
+
1220
+ <enum name="fullscreen_method">
1221
+ <description summary="different method to set the surface fullscreen">
1222
+ Hints to indicate to the compositor how to deal with a conflict
1223
+ between the dimensions of the surface and the dimensions of the
1224
+ output. The compositor is free to ignore this parameter.
1225
+ </description>
1226
+ <entry name="default" value="0" summary="no preference, apply default policy"/>
1227
+ <entry name="scale" value="1" summary="scale, preserve the surface's aspect ratio and center on output"/>
1228
+ <entry name="driver" value="2" summary="switch output mode to the smallest mode that can fit the surface, add black borders to compensate size mismatch"/>
1229
+ <entry name="fill" value="3" summary="no upscaling, center on output and add black borders to compensate size mismatch"/>
1230
+ </enum>
1231
+
1232
+ <request name="set_fullscreen">
1233
+ <description summary="make the surface a fullscreen surface">
1234
+ Map the surface as a fullscreen surface.
1235
+
1236
+ If an output parameter is given then the surface will be made
1237
+ fullscreen on that output. If the client does not specify the
1238
+ output then the compositor will apply its policy - usually
1239
+ choosing the output on which the surface has the biggest surface
1240
+ area.
1241
+
1242
+ The client may specify a method to resolve a size conflict
1243
+ between the output size and the surface size - this is provided
1244
+ through the method parameter.
1245
+
1246
+ The framerate parameter is used only when the method is set
1247
+ to "driver", to indicate the preferred framerate. A value of 0
1248
+ indicates that the client does not care about framerate. The
1249
+ framerate is specified in mHz, that is framerate of 60000 is 60Hz.
1250
+
1251
+ A method of "scale" or "driver" implies a scaling operation of
1252
+ the surface, either via a direct scaling operation or a change of
1253
+ the output mode. This will override any kind of output scaling, so
1254
+ that mapping a surface with a buffer size equal to the mode can
1255
+ fill the screen independent of buffer_scale.
1256
+
1257
+ A method of "fill" means we don't scale up the buffer, however
1258
+ any output scale is applied. This means that you may run into
1259
+ an edge case where the application maps a buffer with the same
1260
+ size of the output mode but buffer_scale 1 (thus making a
1261
+ surface larger than the output). In this case it is allowed to
1262
+ downscale the results to fit the screen.
1263
+
1264
+ The compositor must reply to this request with a configure event
1265
+ with the dimensions for the output on which the surface will
1266
+ be made fullscreen.
1267
+ </description>
1268
+ <arg name="method" type="uint" enum="fullscreen_method" summary="method for resolving size conflict"/>
1269
+ <arg name="framerate" type="uint" summary="framerate in mHz"/>
1270
+ <arg name="output" type="object" interface="wl_output" allow-null="true"
1271
+ summary="output on which the surface is to be fullscreen"/>
1272
+ </request>
1273
+
1274
+ <request name="set_popup">
1275
+ <description summary="make the surface a popup surface">
1276
+ Map the surface as a popup.
1277
+
1278
+ A popup surface is a transient surface with an added pointer
1279
+ grab.
1280
+
1281
+ An existing implicit grab will be changed to owner-events mode,
1282
+ and the popup grab will continue after the implicit grab ends
1283
+ (i.e. releasing the mouse button does not cause the popup to
1284
+ be unmapped).
1285
+
1286
+ The popup grab continues until the window is destroyed or a
1287
+ mouse button is pressed in any other client's window. A click
1288
+ in any of the client's surfaces is reported as normal, however,
1289
+ clicks in other clients' surfaces will be discarded and trigger
1290
+ the callback.
1291
+
1292
+ The x and y arguments specify the location of the upper left
1293
+ corner of the surface relative to the upper left corner of the
1294
+ parent surface, in surface-local coordinates.
1295
+ </description>
1296
+ <arg name="seat" type="object" interface="wl_seat" summary="seat whose pointer is used"/>
1297
+ <arg name="serial" type="uint" summary="serial number of the implicit grab on the pointer"/>
1298
+ <arg name="parent" type="object" interface="wl_surface" summary="parent surface"/>
1299
+ <arg name="x" type="int" summary="surface-local x coordinate"/>
1300
+ <arg name="y" type="int" summary="surface-local y coordinate"/>
1301
+ <arg name="flags" type="uint" enum="transient" summary="transient surface behavior"/>
1302
+ </request>
1303
+
1304
+ <request name="set_maximized">
1305
+ <description summary="make the surface a maximized surface">
1306
+ Map the surface as a maximized surface.
1307
+
1308
+ If an output parameter is given then the surface will be
1309
+ maximized on that output. If the client does not specify the
1310
+ output then the compositor will apply its policy - usually
1311
+ choosing the output on which the surface has the biggest surface
1312
+ area.
1313
+
1314
+ The compositor will reply with a configure event telling
1315
+ the expected new surface size. The operation is completed
1316
+ on the next buffer attach to this surface.
1317
+
1318
+ A maximized surface typically fills the entire output it is
1319
+ bound to, except for desktop elements such as panels. This is
1320
+ the main difference between a maximized shell surface and a
1321
+ fullscreen shell surface.
1322
+
1323
+ The details depend on the compositor implementation.
1324
+ </description>
1325
+ <arg name="output" type="object" interface="wl_output" allow-null="true"
1326
+ summary="output on which the surface is to be maximized"/>
1327
+ </request>
1328
+
1329
+ <request name="set_title">
1330
+ <description summary="set surface title">
1331
+ Set a short title for the surface.
1332
+
1333
+ This string may be used to identify the surface in a task bar,
1334
+ window list, or other user interface elements provided by the
1335
+ compositor.
1336
+
1337
+ The string must be encoded in UTF-8.
1338
+ </description>
1339
+ <arg name="title" type="string" summary="surface title"/>
1340
+ </request>
1341
+
1342
+ <request name="set_class">
1343
+ <description summary="set surface class">
1344
+ Set a class for the surface.
1345
+
1346
+ The surface class identifies the general class of applications
1347
+ to which the surface belongs. A common convention is to use the
1348
+ file name (or the full path if it is a non-standard location) of
1349
+ the application's .desktop file as the class.
1350
+ </description>
1351
+ <arg name="class_" type="string" summary="surface class"/>
1352
+ </request>
1353
+
1354
+ <event name="ping">
1355
+ <description summary="ping client">
1356
+ Ping a client to check if it is receiving events and sending
1357
+ requests. A client is expected to reply with a pong request.
1358
+ </description>
1359
+ <arg name="serial" type="uint" summary="serial number of the ping"/>
1360
+ </event>
1361
+
1362
+ <event name="configure">
1363
+ <description summary="suggest resize">
1364
+ The configure event asks the client to resize its surface.
1365
+
1366
+ The size is a hint, in the sense that the client is free to
1367
+ ignore it if it doesn't resize, pick a smaller size (to
1368
+ satisfy aspect ratio or resize in steps of NxM pixels).
1369
+
1370
+ The edges parameter provides a hint about how the surface
1371
+ was resized. The client may use this information to decide
1372
+ how to adjust its content to the new size (e.g. a scrolling
1373
+ area might adjust its content position to leave the viewable
1374
+ content unmoved).
1375
+
1376
+ The client is free to dismiss all but the last configure
1377
+ event it received.
1378
+
1379
+ The width and height arguments specify the size of the window
1380
+ in surface-local coordinates.
1381
+ </description>
1382
+ <arg name="edges" type="uint" enum="resize" summary="how the surface was resized"/>
1383
+ <arg name="width" type="int" summary="new width of the surface"/>
1384
+ <arg name="height" type="int" summary="new height of the surface"/>
1385
+ </event>
1386
+
1387
+ <event name="popup_done">
1388
+ <description summary="popup interaction is done">
1389
+ The popup_done event is sent out when a popup grab is broken,
1390
+ that is, when the user clicks a surface that doesn't belong
1391
+ to the client owning the popup surface.
1392
+ </description>
1393
+ </event>
1394
+ </interface>
1395
+
1396
+ <interface name="wl_surface" version="6">
1397
+ <description summary="an onscreen surface">
1398
+ A surface is a rectangular area that may be displayed on zero
1399
+ or more outputs, and shown any number of times at the compositor's
1400
+ discretion. They can present wl_buffers, receive user input, and
1401
+ define a local coordinate system.
1402
+
1403
+ The size of a surface (and relative positions on it) is described
1404
+ in surface-local coordinates, which may differ from the buffer
1405
+ coordinates of the pixel content, in case a buffer_transform
1406
+ or a buffer_scale is used.
1407
+
1408
+ A surface without a "role" is fairly useless: a compositor does
1409
+ not know where, when or how to present it. The role is the
1410
+ purpose of a wl_surface. Examples of roles are a cursor for a
1411
+ pointer (as set by wl_pointer.set_cursor), a drag icon
1412
+ (wl_data_device.start_drag), a sub-surface
1413
+ (wl_subcompositor.get_subsurface), and a window as defined by a
1414
+ shell protocol (e.g. wl_shell.get_shell_surface).
1415
+
1416
+ A surface can have only one role at a time. Initially a
1417
+ wl_surface does not have a role. Once a wl_surface is given a
1418
+ role, it is set permanently for the whole lifetime of the
1419
+ wl_surface object. Giving the current role again is allowed,
1420
+ unless explicitly forbidden by the relevant interface
1421
+ specification.
1422
+
1423
+ Surface roles are given by requests in other interfaces such as
1424
+ wl_pointer.set_cursor. The request should explicitly mention
1425
+ that this request gives a role to a wl_surface. Often, this
1426
+ request also creates a new protocol object that represents the
1427
+ role and adds additional functionality to wl_surface. When a
1428
+ client wants to destroy a wl_surface, they must destroy this role
1429
+ object before the wl_surface, otherwise a defunct_role_object error is
1430
+ sent.
1431
+
1432
+ Destroying the role object does not remove the role from the
1433
+ wl_surface, but it may stop the wl_surface from "playing the role".
1434
+ For instance, if a wl_subsurface object is destroyed, the wl_surface
1435
+ it was created for will be unmapped and forget its position and
1436
+ z-order. It is allowed to create a wl_subsurface for the same
1437
+ wl_surface again, but it is not allowed to use the wl_surface as
1438
+ a cursor (cursor is a different role than sub-surface, and role
1439
+ switching is not allowed).
1440
+ </description>
1441
+
1442
+ <enum name="error">
1443
+ <description summary="wl_surface error values">
1444
+ These errors can be emitted in response to wl_surface requests.
1445
+ </description>
1446
+ <entry name="invalid_scale" value="0" summary="buffer scale value is invalid"/>
1447
+ <entry name="invalid_transform" value="1" summary="buffer transform value is invalid"/>
1448
+ <entry name="invalid_size" value="2" summary="buffer size is invalid"/>
1449
+ <entry name="invalid_offset" value="3" summary="buffer offset is invalid"/>
1450
+ <entry name="defunct_role_object" value="4"
1451
+ summary="surface was destroyed before its role object"/>
1452
+ </enum>
1453
+
1454
+ <request name="destroy" type="destructor">
1455
+ <description summary="delete surface">
1456
+ Deletes the surface and invalidates its object ID.
1457
+ </description>
1458
+ </request>
1459
+
1460
+ <request name="attach">
1461
+ <description summary="set the surface contents">
1462
+ Set a buffer as the content of this surface.
1463
+
1464
+ The new size of the surface is calculated based on the buffer
1465
+ size transformed by the inverse buffer_transform and the
1466
+ inverse buffer_scale. This means that at commit time the supplied
1467
+ buffer size must be an integer multiple of the buffer_scale. If
1468
+ that's not the case, an invalid_size error is sent.
1469
+
1470
+ The x and y arguments specify the location of the new pending
1471
+ buffer's upper left corner, relative to the current buffer's upper
1472
+ left corner, in surface-local coordinates. In other words, the
1473
+ x and y, combined with the new surface size define in which
1474
+ directions the surface's size changes. Setting anything other than 0
1475
+ as x and y arguments is discouraged, and should instead be replaced
1476
+ with using the separate wl_surface.offset request.
1477
+
1478
+ When the bound wl_surface version is 5 or higher, passing any
1479
+ non-zero x or y is a protocol violation, and will result in an
1480
+ 'invalid_offset' error being raised. The x and y arguments are ignored
1481
+ and do not change the pending state. To achieve equivalent semantics,
1482
+ use wl_surface.offset.
1483
+
1484
+ Surface contents are double-buffered state, see wl_surface.commit.
1485
+
1486
+ The initial surface contents are void; there is no content.
1487
+ wl_surface.attach assigns the given wl_buffer as the pending
1488
+ wl_buffer. wl_surface.commit makes the pending wl_buffer the new
1489
+ surface contents, and the size of the surface becomes the size
1490
+ calculated from the wl_buffer, as described above. After commit,
1491
+ there is no pending buffer until the next attach.
1492
+
1493
+ Committing a pending wl_buffer allows the compositor to read the
1494
+ pixels in the wl_buffer. The compositor may access the pixels at
1495
+ any time after the wl_surface.commit request. When the compositor
1496
+ will not access the pixels anymore, it will send the
1497
+ wl_buffer.release event. Only after receiving wl_buffer.release,
1498
+ the client may reuse the wl_buffer. A wl_buffer that has been
1499
+ attached and then replaced by another attach instead of committed
1500
+ will not receive a release event, and is not used by the
1501
+ compositor.
1502
+
1503
+ If a pending wl_buffer has been committed to more than one wl_surface,
1504
+ the delivery of wl_buffer.release events becomes undefined. A well
1505
+ behaved client should not rely on wl_buffer.release events in this
1506
+ case. Alternatively, a client could create multiple wl_buffer objects
1507
+ from the same backing storage or use wp_linux_buffer_release.
1508
+
1509
+ Destroying the wl_buffer after wl_buffer.release does not change
1510
+ the surface contents. Destroying the wl_buffer before wl_buffer.release
1511
+ is allowed as long as the underlying buffer storage isn't re-used (this
1512
+ can happen e.g. on client process termination). However, if the client
1513
+ destroys the wl_buffer before receiving the wl_buffer.release event and
1514
+ mutates the underlying buffer storage, the surface contents become
1515
+ undefined immediately.
1516
+
1517
+ If wl_surface.attach is sent with a NULL wl_buffer, the
1518
+ following wl_surface.commit will remove the surface content.
1519
+
1520
+ If a pending wl_buffer has been destroyed, the result is not specified.
1521
+ Many compositors are known to remove the surface content on the following
1522
+ wl_surface.commit, but this behaviour is not universal. Clients seeking to
1523
+ maximise compatibility should not destroy pending buffers and should
1524
+ ensure that they explicitly remove content from surfaces, even after
1525
+ destroying buffers.
1526
+ </description>
1527
+ <arg name="buffer" type="object" interface="wl_buffer" allow-null="true"
1528
+ summary="buffer of surface contents"/>
1529
+ <arg name="x" type="int" summary="surface-local x coordinate"/>
1530
+ <arg name="y" type="int" summary="surface-local y coordinate"/>
1531
+ </request>
1532
+
1533
+ <request name="damage">
1534
+ <description summary="mark part of the surface damaged">
1535
+ This request is used to describe the regions where the pending
1536
+ buffer is different from the current surface contents, and where
1537
+ the surface therefore needs to be repainted. The compositor
1538
+ ignores the parts of the damage that fall outside of the surface.
1539
+
1540
+ Damage is double-buffered state, see wl_surface.commit.
1541
+
1542
+ The damage rectangle is specified in surface-local coordinates,
1543
+ where x and y specify the upper left corner of the damage rectangle.
1544
+
1545
+ The initial value for pending damage is empty: no damage.
1546
+ wl_surface.damage adds pending damage: the new pending damage
1547
+ is the union of old pending damage and the given rectangle.
1548
+
1549
+ wl_surface.commit assigns pending damage as the current damage,
1550
+ and clears pending damage. The server will clear the current
1551
+ damage as it repaints the surface.
1552
+
1553
+ Note! New clients should not use this request. Instead damage can be
1554
+ posted with wl_surface.damage_buffer which uses buffer coordinates
1555
+ instead of surface coordinates.
1556
+ </description>
1557
+ <arg name="x" type="int" summary="surface-local x coordinate"/>
1558
+ <arg name="y" type="int" summary="surface-local y coordinate"/>
1559
+ <arg name="width" type="int" summary="width of damage rectangle"/>
1560
+ <arg name="height" type="int" summary="height of damage rectangle"/>
1561
+ </request>
1562
+
1563
+ <request name="frame">
1564
+ <description summary="request a frame throttling hint">
1565
+ Request a notification when it is a good time to start drawing a new
1566
+ frame, by creating a frame callback. This is useful for throttling
1567
+ redrawing operations, and driving animations.
1568
+
1569
+ When a client is animating on a wl_surface, it can use the 'frame'
1570
+ request to get notified when it is a good time to draw and commit the
1571
+ next frame of animation. If the client commits an update earlier than
1572
+ that, it is likely that some updates will not make it to the display,
1573
+ and the client is wasting resources by drawing too often.
1574
+
1575
+ The frame request will take effect on the next wl_surface.commit.
1576
+ The notification will only be posted for one frame unless
1577
+ requested again. For a wl_surface, the notifications are posted in
1578
+ the order the frame requests were committed.
1579
+
1580
+ The server must send the notifications so that a client
1581
+ will not send excessive updates, while still allowing
1582
+ the highest possible update rate for clients that wait for the reply
1583
+ before drawing again. The server should give some time for the client
1584
+ to draw and commit after sending the frame callback events to let it
1585
+ hit the next output refresh.
1586
+
1587
+ A server should avoid signaling the frame callbacks if the
1588
+ surface is not visible in any way, e.g. the surface is off-screen,
1589
+ or completely obscured by other opaque surfaces.
1590
+
1591
+ The object returned by this request will be destroyed by the
1592
+ compositor after the callback is fired and as such the client must not
1593
+ attempt to use it after that point.
1594
+
1595
+ The callback_data passed in the callback is the current time, in
1596
+ milliseconds, with an undefined base.
1597
+ </description>
1598
+ <arg name="callback" type="new_id" interface="wl_callback" summary="callback object for the frame request"/>
1599
+ </request>
1600
+
1601
+ <request name="set_opaque_region">
1602
+ <description summary="set opaque region">
1603
+ This request sets the region of the surface that contains
1604
+ opaque content.
1605
+
1606
+ The opaque region is an optimization hint for the compositor
1607
+ that lets it optimize the redrawing of content behind opaque
1608
+ regions. Setting an opaque region is not required for correct
1609
+ behaviour, but marking transparent content as opaque will result
1610
+ in repaint artifacts.
1611
+
1612
+ The opaque region is specified in surface-local coordinates.
1613
+
1614
+ The compositor ignores the parts of the opaque region that fall
1615
+ outside of the surface.
1616
+
1617
+ Opaque region is double-buffered state, see wl_surface.commit.
1618
+
1619
+ wl_surface.set_opaque_region changes the pending opaque region.
1620
+ wl_surface.commit copies the pending region to the current region.
1621
+ Otherwise, the pending and current regions are never changed.
1622
+
1623
+ The initial value for an opaque region is empty. Setting the pending
1624
+ opaque region has copy semantics, and the wl_region object can be
1625
+ destroyed immediately. A NULL wl_region causes the pending opaque
1626
+ region to be set to empty.
1627
+ </description>
1628
+ <arg name="region" type="object" interface="wl_region" allow-null="true"
1629
+ summary="opaque region of the surface"/>
1630
+ </request>
1631
+
1632
+ <request name="set_input_region">
1633
+ <description summary="set input region">
1634
+ This request sets the region of the surface that can receive
1635
+ pointer and touch events.
1636
+
1637
+ Input events happening outside of this region will try the next
1638
+ surface in the server surface stack. The compositor ignores the
1639
+ parts of the input region that fall outside of the surface.
1640
+
1641
+ The input region is specified in surface-local coordinates.
1642
+
1643
+ Input region is double-buffered state, see wl_surface.commit.
1644
+
1645
+ wl_surface.set_input_region changes the pending input region.
1646
+ wl_surface.commit copies the pending region to the current region.
1647
+ Otherwise the pending and current regions are never changed,
1648
+ except cursor and icon surfaces are special cases, see
1649
+ wl_pointer.set_cursor and wl_data_device.start_drag.
1650
+
1651
+ The initial value for an input region is infinite. That means the
1652
+ whole surface will accept input. Setting the pending input region
1653
+ has copy semantics, and the wl_region object can be destroyed
1654
+ immediately. A NULL wl_region causes the input region to be set
1655
+ to infinite.
1656
+ </description>
1657
+ <arg name="region" type="object" interface="wl_region" allow-null="true"
1658
+ summary="input region of the surface"/>
1659
+ </request>
1660
+
1661
+ <request name="commit">
1662
+ <description summary="commit pending surface state">
1663
+ Surface state (input, opaque, and damage regions, attached buffers,
1664
+ etc.) is double-buffered. Protocol requests modify the pending state,
1665
+ as opposed to the active state in use by the compositor.
1666
+
1667
+ A commit request atomically creates a content update from the pending
1668
+ state, even if the pending state has not been touched. The content
1669
+ update is placed in a queue until it becomes active. After commit, the
1670
+ new pending state is as documented for each related request.
1671
+
1672
+ When the content update is applied, the wl_buffer is applied before all
1673
+ other state. This means that all coordinates in double-buffered state
1674
+ are relative to the newly attached wl_buffers, except for
1675
+ wl_surface.attach itself. If there is no newly attached wl_buffer, the
1676
+ coordinates are relative to the previous content update.
1677
+
1678
+ All requests that need a commit to become effective are documented
1679
+ to affect double-buffered state.
1680
+
1681
+ Other interfaces may add further double-buffered surface state.
1682
+ </description>
1683
+ </request>
1684
+
1685
+ <event name="enter">
1686
+ <description summary="surface enters an output">
1687
+ This is emitted whenever a surface's creation, movement, or resizing
1688
+ results in some part of it being within the scanout region of an
1689
+ output.
1690
+
1691
+ Note that a surface may be overlapping with zero or more outputs.
1692
+ </description>
1693
+ <arg name="output" type="object" interface="wl_output" summary="output entered by the surface"/>
1694
+ </event>
1695
+
1696
+ <event name="leave">
1697
+ <description summary="surface leaves an output">
1698
+ This is emitted whenever a surface's creation, movement, or resizing
1699
+ results in it no longer having any part of it within the scanout region
1700
+ of an output.
1701
+
1702
+ Clients should not use the number of outputs the surface is on for frame
1703
+ throttling purposes. The surface might be hidden even if no leave event
1704
+ has been sent, and the compositor might expect new surface content
1705
+ updates even if no enter event has been sent. The frame event should be
1706
+ used instead.
1707
+ </description>
1708
+ <arg name="output" type="object" interface="wl_output" summary="output left by the surface"/>
1709
+ </event>
1710
+
1711
+ <!-- Version 2 additions -->
1712
+
1713
+ <request name="set_buffer_transform" since="2">
1714
+ <description summary="sets the buffer transformation">
1715
+ This request sets the transformation that the client has already applied
1716
+ to the content of the buffer. The accepted values for the transform
1717
+ parameter are the values for wl_output.transform.
1718
+
1719
+ The compositor applies the inverse of this transformation whenever it
1720
+ uses the buffer contents.
1721
+
1722
+ Buffer transform is double-buffered state, see wl_surface.commit.
1723
+
1724
+ A newly created surface has its buffer transformation set to normal.
1725
+
1726
+ wl_surface.set_buffer_transform changes the pending buffer
1727
+ transformation. wl_surface.commit copies the pending buffer
1728
+ transformation to the current one. Otherwise, the pending and current
1729
+ values are never changed.
1730
+
1731
+ The purpose of this request is to allow clients to render content
1732
+ according to the output transform, thus permitting the compositor to
1733
+ use certain optimizations even if the display is rotated. Using
1734
+ hardware overlays and scanning out a client buffer for fullscreen
1735
+ surfaces are examples of such optimizations. Those optimizations are
1736
+ highly dependent on the compositor implementation, so the use of this
1737
+ request should be considered on a case-by-case basis.
1738
+
1739
+ Note that if the transform value includes 90 or 270 degree rotation,
1740
+ the width of the buffer will become the surface height and the height
1741
+ of the buffer will become the surface width.
1742
+
1743
+ If transform is not one of the values from the
1744
+ wl_output.transform enum the invalid_transform protocol error
1745
+ is raised.
1746
+ </description>
1747
+ <arg name="transform" type="int" enum="wl_output.transform"
1748
+ summary="transform for interpreting buffer contents"/>
1749
+ </request>
1750
+
1751
+ <!-- Version 3 additions -->
1752
+
1753
+ <request name="set_buffer_scale" since="3">
1754
+ <description summary="sets the buffer scaling factor">
1755
+ This request sets an optional scaling factor on how the compositor
1756
+ interprets the contents of the buffer attached to the window.
1757
+
1758
+ Buffer scale is double-buffered state, see wl_surface.commit.
1759
+
1760
+ A newly created surface has its buffer scale set to 1.
1761
+
1762
+ wl_surface.set_buffer_scale changes the pending buffer scale.
1763
+ wl_surface.commit copies the pending buffer scale to the current one.
1764
+ Otherwise, the pending and current values are never changed.
1765
+
1766
+ The purpose of this request is to allow clients to supply higher
1767
+ resolution buffer data for use on high resolution outputs. It is
1768
+ intended that you pick the same buffer scale as the scale of the
1769
+ output that the surface is displayed on. This means the compositor
1770
+ can avoid scaling when rendering the surface on that output.
1771
+
1772
+ Note that if the scale is larger than 1, then you have to attach
1773
+ a buffer that is larger (by a factor of scale in each dimension)
1774
+ than the desired surface size.
1775
+
1776
+ If scale is not greater than 0 the invalid_scale protocol error is
1777
+ raised.
1778
+ </description>
1779
+ <arg name="scale" type="int"
1780
+ summary="scale for interpreting buffer contents"/>
1781
+ </request>
1782
+
1783
+ <!-- Version 4 additions -->
1784
+ <request name="damage_buffer" since="4">
1785
+ <description summary="mark part of the surface damaged using buffer coordinates">
1786
+ This request is used to describe the regions where the pending
1787
+ buffer is different from the current surface contents, and where
1788
+ the surface therefore needs to be repainted. The compositor
1789
+ ignores the parts of the damage that fall outside of the surface.
1790
+
1791
+ Damage is double-buffered state, see wl_surface.commit.
1792
+
1793
+ The damage rectangle is specified in buffer coordinates,
1794
+ where x and y specify the upper left corner of the damage rectangle.
1795
+
1796
+ The initial value for pending damage is empty: no damage.
1797
+ wl_surface.damage_buffer adds pending damage: the new pending
1798
+ damage is the union of old pending damage and the given rectangle.
1799
+
1800
+ wl_surface.commit assigns pending damage as the current damage,
1801
+ and clears pending damage. The server will clear the current
1802
+ damage as it repaints the surface.
1803
+
1804
+ This request differs from wl_surface.damage in only one way - it
1805
+ takes damage in buffer coordinates instead of surface-local
1806
+ coordinates. While this generally is more intuitive than surface
1807
+ coordinates, it is especially desirable when using wp_viewport
1808
+ or when a drawing library (like EGL) is unaware of buffer scale
1809
+ and buffer transform.
1810
+
1811
+ Note: Because buffer transformation changes and damage requests may
1812
+ be interleaved in the protocol stream, it is impossible to determine
1813
+ the actual mapping between surface and buffer damage until
1814
+ wl_surface.commit time. Therefore, compositors wishing to take both
1815
+ kinds of damage into account will have to accumulate damage from the
1816
+ two requests separately and only transform from one to the other
1817
+ after receiving the wl_surface.commit.
1818
+ </description>
1819
+ <arg name="x" type="int" summary="buffer-local x coordinate"/>
1820
+ <arg name="y" type="int" summary="buffer-local y coordinate"/>
1821
+ <arg name="width" type="int" summary="width of damage rectangle"/>
1822
+ <arg name="height" type="int" summary="height of damage rectangle"/>
1823
+ </request>
1824
+
1825
+ <!-- Version 5 additions -->
1826
+
1827
+ <request name="offset" since="5">
1828
+ <description summary="set the surface contents offset">
1829
+ The x and y arguments specify the location of the new pending
1830
+ buffer's upper left corner, relative to the current buffer's upper
1831
+ left corner, in surface-local coordinates. In other words, the
1832
+ x and y, combined with the new surface size define in which
1833
+ directions the surface's size changes.
1834
+
1835
+ Surface location offset is double-buffered state, see
1836
+ wl_surface.commit.
1837
+
1838
+ This request is semantically equivalent to and the replaces the x and y
1839
+ arguments in the wl_surface.attach request in wl_surface versions prior
1840
+ to 5. See wl_surface.attach for details.
1841
+ </description>
1842
+ <arg name="x" type="int" summary="surface-local x coordinate"/>
1843
+ <arg name="y" type="int" summary="surface-local y coordinate"/>
1844
+ </request>
1845
+
1846
+ <!-- Version 6 additions -->
1847
+
1848
+ <event name="preferred_buffer_scale" since="6">
1849
+ <description summary="preferred buffer scale for the surface">
1850
+ This event indicates the preferred buffer scale for this surface. It is
1851
+ sent whenever the compositor's preference changes.
1852
+
1853
+ Before receiving this event the preferred buffer scale for this surface
1854
+ is 1.
1855
+
1856
+ It is intended that scaling aware clients use this event to scale their
1857
+ content and use wl_surface.set_buffer_scale to indicate the scale they
1858
+ have rendered with. This allows clients to supply a higher detail
1859
+ buffer.
1860
+
1861
+ The compositor shall emit a scale value greater than 0.
1862
+ </description>
1863
+ <arg name="factor" type="int" summary="preferred scaling factor"/>
1864
+ </event>
1865
+
1866
+ <event name="preferred_buffer_transform" since="6">
1867
+ <description summary="preferred buffer transform for the surface">
1868
+ This event indicates the preferred buffer transform for this surface.
1869
+ It is sent whenever the compositor's preference changes.
1870
+
1871
+ Before receiving this event the preferred buffer transform for this
1872
+ surface is normal.
1873
+
1874
+ Applying this transformation to the surface buffer contents and using
1875
+ wl_surface.set_buffer_transform might allow the compositor to use the
1876
+ surface buffer more efficiently.
1877
+ </description>
1878
+ <arg name="transform" type="uint" enum="wl_output.transform"
1879
+ summary="preferred transform"/>
1880
+ </event>
1881
+ </interface>
1882
+
1883
+ <interface name="wl_seat" version="9">
1884
+ <description summary="group of input devices">
1885
+ A seat is a group of keyboards, pointer and touch devices. This
1886
+ object is published as a global during start up, or when such a
1887
+ device is hot plugged. A seat typically has a pointer and
1888
+ maintains a keyboard focus and a pointer focus.
1889
+ </description>
1890
+
1891
+ <enum name="capability" bitfield="true">
1892
+ <description summary="seat capability bitmask">
1893
+ This is a bitmask of capabilities this seat has; if a member is
1894
+ set, then it is present on the seat.
1895
+ </description>
1896
+ <entry name="pointer" value="1" summary="the seat has pointer devices"/>
1897
+ <entry name="keyboard" value="2" summary="the seat has one or more keyboards"/>
1898
+ <entry name="touch" value="4" summary="the seat has touch devices"/>
1899
+ </enum>
1900
+
1901
+ <enum name="error">
1902
+ <description summary="wl_seat error values">
1903
+ These errors can be emitted in response to wl_seat requests.
1904
+ </description>
1905
+ <entry name="missing_capability" value="0"
1906
+ summary="get_pointer, get_keyboard or get_touch called on seat without the matching capability"/>
1907
+ </enum>
1908
+
1909
+ <event name="capabilities">
1910
+ <description summary="seat capabilities changed">
1911
+ This is emitted whenever a seat gains or loses the pointer,
1912
+ keyboard or touch capabilities. The argument is a capability
1913
+ enum containing the complete set of capabilities this seat has.
1914
+
1915
+ When the pointer capability is added, a client may create a
1916
+ wl_pointer object using the wl_seat.get_pointer request. This object
1917
+ will receive pointer events until the capability is removed in the
1918
+ future.
1919
+
1920
+ When the pointer capability is removed, a client should destroy the
1921
+ wl_pointer objects associated with the seat where the capability was
1922
+ removed, using the wl_pointer.release request. No further pointer
1923
+ events will be received on these objects.
1924
+
1925
+ In some compositors, if a seat regains the pointer capability and a
1926
+ client has a previously obtained wl_pointer object of version 4 or
1927
+ less, that object may start sending pointer events again. This
1928
+ behavior is considered a misinterpretation of the intended behavior
1929
+ and must not be relied upon by the client. wl_pointer objects of
1930
+ version 5 or later must not send events if created before the most
1931
+ recent event notifying the client of an added pointer capability.
1932
+
1933
+ The above behavior also applies to wl_keyboard and wl_touch with the
1934
+ keyboard and touch capabilities, respectively.
1935
+ </description>
1936
+ <arg name="capabilities" type="uint" enum="capability" summary="capabilities of the seat"/>
1937
+ </event>
1938
+
1939
+ <request name="get_pointer">
1940
+ <description summary="return pointer object">
1941
+ The ID provided will be initialized to the wl_pointer interface
1942
+ for this seat.
1943
+
1944
+ This request only takes effect if the seat has the pointer
1945
+ capability, or has had the pointer capability in the past.
1946
+ It is a protocol violation to issue this request on a seat that has
1947
+ never had the pointer capability. The missing_capability error will
1948
+ be sent in this case.
1949
+ </description>
1950
+ <arg name="id" type="new_id" interface="wl_pointer" summary="seat pointer"/>
1951
+ </request>
1952
+
1953
+ <request name="get_keyboard">
1954
+ <description summary="return keyboard object">
1955
+ The ID provided will be initialized to the wl_keyboard interface
1956
+ for this seat.
1957
+
1958
+ This request only takes effect if the seat has the keyboard
1959
+ capability, or has had the keyboard capability in the past.
1960
+ It is a protocol violation to issue this request on a seat that has
1961
+ never had the keyboard capability. The missing_capability error will
1962
+ be sent in this case.
1963
+ </description>
1964
+ <arg name="id" type="new_id" interface="wl_keyboard" summary="seat keyboard"/>
1965
+ </request>
1966
+
1967
+ <request name="get_touch">
1968
+ <description summary="return touch object">
1969
+ The ID provided will be initialized to the wl_touch interface
1970
+ for this seat.
1971
+
1972
+ This request only takes effect if the seat has the touch
1973
+ capability, or has had the touch capability in the past.
1974
+ It is a protocol violation to issue this request on a seat that has
1975
+ never had the touch capability. The missing_capability error will
1976
+ be sent in this case.
1977
+ </description>
1978
+ <arg name="id" type="new_id" interface="wl_touch" summary="seat touch interface"/>
1979
+ </request>
1980
+
1981
+ <!-- Version 2 additions -->
1982
+
1983
+ <event name="name" since="2">
1984
+ <description summary="unique identifier for this seat">
1985
+ In a multi-seat configuration the seat name can be used by clients to
1986
+ help identify which physical devices the seat represents.
1987
+
1988
+ The seat name is a UTF-8 string with no convention defined for its
1989
+ contents. Each name is unique among all wl_seat globals. The name is
1990
+ only guaranteed to be unique for the current compositor instance.
1991
+
1992
+ The same seat names are used for all clients. Thus, the name can be
1993
+ shared across processes to refer to a specific wl_seat global.
1994
+
1995
+ The name event is sent after binding to the seat global. This event is
1996
+ only sent once per seat object, and the name does not change over the
1997
+ lifetime of the wl_seat global.
1998
+
1999
+ Compositors may re-use the same seat name if the wl_seat global is
2000
+ destroyed and re-created later.
2001
+ </description>
2002
+ <arg name="name" type="string" summary="seat identifier"/>
2003
+ </event>
2004
+
2005
+ <!-- Version 5 additions -->
2006
+
2007
+ <request name="release" type="destructor" since="5">
2008
+ <description summary="release the seat object">
2009
+ Using this request a client can tell the server that it is not going to
2010
+ use the seat object anymore.
2011
+ </description>
2012
+ </request>
2013
+
2014
+ </interface>
2015
+
2016
+ <interface name="wl_pointer" version="9">
2017
+ <description summary="pointer input device">
2018
+ The wl_pointer interface represents one or more input devices,
2019
+ such as mice, which control the pointer location and pointer_focus
2020
+ of a seat.
2021
+
2022
+ The wl_pointer interface generates motion, enter and leave
2023
+ events for the surfaces that the pointer is located over,
2024
+ and button and axis events for button presses, button releases
2025
+ and scrolling.
2026
+ </description>
2027
+
2028
+ <enum name="error">
2029
+ <entry name="role" value="0" summary="given wl_surface has another role"/>
2030
+ </enum>
2031
+
2032
+ <request name="set_cursor">
2033
+ <description summary="set the pointer surface">
2034
+ Set the pointer surface, i.e., the surface that contains the
2035
+ pointer image (cursor). This request gives the surface the role
2036
+ of a cursor. If the surface already has another role, it raises
2037
+ a protocol error.
2038
+
2039
+ The cursor actually changes only if the pointer
2040
+ focus for this device is one of the requesting client's surfaces
2041
+ or the surface parameter is the current pointer surface. If
2042
+ there was a previous surface set with this request it is
2043
+ replaced. If surface is NULL, the pointer image is hidden.
2044
+
2045
+ The parameters hotspot_x and hotspot_y define the position of
2046
+ the pointer surface relative to the pointer location. Its
2047
+ top-left corner is always at (x, y) - (hotspot_x, hotspot_y),
2048
+ where (x, y) are the coordinates of the pointer location, in
2049
+ surface-local coordinates.
2050
+
2051
+ On wl_surface.offset requests to the pointer surface, hotspot_x
2052
+ and hotspot_y are decremented by the x and y parameters
2053
+ passed to the request. The offset must be applied by
2054
+ wl_surface.commit as usual.
2055
+
2056
+ The hotspot can also be updated by passing the currently set
2057
+ pointer surface to this request with new values for hotspot_x
2058
+ and hotspot_y.
2059
+
2060
+ The input region is ignored for wl_surfaces with the role of
2061
+ a cursor. When the use as a cursor ends, the wl_surface is
2062
+ unmapped.
2063
+
2064
+ The serial parameter must match the latest wl_pointer.enter
2065
+ serial number sent to the client. Otherwise the request will be
2066
+ ignored.
2067
+ </description>
2068
+ <arg name="serial" type="uint" summary="serial number of the enter event"/>
2069
+ <arg name="surface" type="object" interface="wl_surface" allow-null="true"
2070
+ summary="pointer surface"/>
2071
+ <arg name="hotspot_x" type="int" summary="surface-local x coordinate"/>
2072
+ <arg name="hotspot_y" type="int" summary="surface-local y coordinate"/>
2073
+ </request>
2074
+
2075
+ <event name="enter">
2076
+ <description summary="enter event">
2077
+ Notification that this seat's pointer is focused on a certain
2078
+ surface.
2079
+
2080
+ When a seat's focus enters a surface, the pointer image
2081
+ is undefined and a client should respond to this event by setting
2082
+ an appropriate pointer image with the set_cursor request.
2083
+ </description>
2084
+ <arg name="serial" type="uint" summary="serial number of the enter event"/>
2085
+ <arg name="surface" type="object" interface="wl_surface" summary="surface entered by the pointer"/>
2086
+ <arg name="surface_x" type="fixed" summary="surface-local x coordinate"/>
2087
+ <arg name="surface_y" type="fixed" summary="surface-local y coordinate"/>
2088
+ </event>
2089
+
2090
+ <event name="leave">
2091
+ <description summary="leave event">
2092
+ Notification that this seat's pointer is no longer focused on
2093
+ a certain surface.
2094
+
2095
+ The leave notification is sent before the enter notification
2096
+ for the new focus.
2097
+ </description>
2098
+ <arg name="serial" type="uint" summary="serial number of the leave event"/>
2099
+ <arg name="surface" type="object" interface="wl_surface" summary="surface left by the pointer"/>
2100
+ </event>
2101
+
2102
+ <event name="motion">
2103
+ <description summary="pointer motion event">
2104
+ Notification of pointer location change. The arguments
2105
+ surface_x and surface_y are the location relative to the
2106
+ focused surface.
2107
+ </description>
2108
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
2109
+ <arg name="surface_x" type="fixed" summary="surface-local x coordinate"/>
2110
+ <arg name="surface_y" type="fixed" summary="surface-local y coordinate"/>
2111
+ </event>
2112
+
2113
+ <enum name="button_state">
2114
+ <description summary="physical button state">
2115
+ Describes the physical state of a button that produced the button
2116
+ event.
2117
+ </description>
2118
+ <entry name="released" value="0" summary="the button is not pressed"/>
2119
+ <entry name="pressed" value="1" summary="the button is pressed"/>
2120
+ </enum>
2121
+
2122
+ <event name="button">
2123
+ <description summary="pointer button event">
2124
+ Mouse button click and release notifications.
2125
+
2126
+ The location of the click is given by the last motion or
2127
+ enter event.
2128
+ The time argument is a timestamp with millisecond
2129
+ granularity, with an undefined base.
2130
+
2131
+ The button is a button code as defined in the Linux kernel's
2132
+ linux/input-event-codes.h header file, e.g. BTN_LEFT.
2133
+
2134
+ Any 16-bit button code value is reserved for future additions to the
2135
+ kernel's event code list. All other button codes above 0xFFFF are
2136
+ currently undefined but may be used in future versions of this
2137
+ protocol.
2138
+ </description>
2139
+ <arg name="serial" type="uint" summary="serial number of the button event"/>
2140
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
2141
+ <arg name="button" type="uint" summary="button that produced the event"/>
2142
+ <arg name="state" type="uint" enum="button_state" summary="physical state of the button"/>
2143
+ </event>
2144
+
2145
+ <enum name="axis">
2146
+ <description summary="axis types">
2147
+ Describes the axis types of scroll events.
2148
+ </description>
2149
+ <entry name="vertical_scroll" value="0" summary="vertical axis"/>
2150
+ <entry name="horizontal_scroll" value="1" summary="horizontal axis"/>
2151
+ </enum>
2152
+
2153
+ <event name="axis">
2154
+ <description summary="axis event">
2155
+ Scroll and other axis notifications.
2156
+
2157
+ For scroll events (vertical and horizontal scroll axes), the
2158
+ value parameter is the length of a vector along the specified
2159
+ axis in a coordinate space identical to those of motion events,
2160
+ representing a relative movement along the specified axis.
2161
+
2162
+ For devices that support movements non-parallel to axes multiple
2163
+ axis events will be emitted.
2164
+
2165
+ When applicable, for example for touch pads, the server can
2166
+ choose to emit scroll events where the motion vector is
2167
+ equivalent to a motion event vector.
2168
+
2169
+ When applicable, a client can transform its content relative to the
2170
+ scroll distance.
2171
+ </description>
2172
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
2173
+ <arg name="axis" type="uint" enum="axis" summary="axis type"/>
2174
+ <arg name="value" type="fixed" summary="length of vector in surface-local coordinate space"/>
2175
+ </event>
2176
+
2177
+ <!-- Version 3 additions -->
2178
+
2179
+ <request name="release" type="destructor" since="3">
2180
+ <description summary="release the pointer object">
2181
+ Using this request a client can tell the server that it is not going to
2182
+ use the pointer object anymore.
2183
+
2184
+ This request destroys the pointer proxy object, so clients must not call
2185
+ wl_pointer_destroy() after using this request.
2186
+ </description>
2187
+ </request>
2188
+
2189
+ <!-- Version 5 additions -->
2190
+
2191
+ <event name="frame" since="5">
2192
+ <description summary="end of a pointer event sequence">
2193
+ Indicates the end of a set of events that logically belong together.
2194
+ A client is expected to accumulate the data in all events within the
2195
+ frame before proceeding.
2196
+
2197
+ All wl_pointer events before a wl_pointer.frame event belong
2198
+ logically together. For example, in a diagonal scroll motion the
2199
+ compositor will send an optional wl_pointer.axis_source event, two
2200
+ wl_pointer.axis events (horizontal and vertical) and finally a
2201
+ wl_pointer.frame event. The client may use this information to
2202
+ calculate a diagonal vector for scrolling.
2203
+
2204
+ When multiple wl_pointer.axis events occur within the same frame,
2205
+ the motion vector is the combined motion of all events.
2206
+ When a wl_pointer.axis and a wl_pointer.axis_stop event occur within
2207
+ the same frame, this indicates that axis movement in one axis has
2208
+ stopped but continues in the other axis.
2209
+ When multiple wl_pointer.axis_stop events occur within the same
2210
+ frame, this indicates that these axes stopped in the same instance.
2211
+
2212
+ A wl_pointer.frame event is sent for every logical event group,
2213
+ even if the group only contains a single wl_pointer event.
2214
+ Specifically, a client may get a sequence: motion, frame, button,
2215
+ frame, axis, frame, axis_stop, frame.
2216
+
2217
+ The wl_pointer.enter and wl_pointer.leave events are logical events
2218
+ generated by the compositor and not the hardware. These events are
2219
+ also grouped by a wl_pointer.frame. When a pointer moves from one
2220
+ surface to another, a compositor should group the
2221
+ wl_pointer.leave event within the same wl_pointer.frame.
2222
+ However, a client must not rely on wl_pointer.leave and
2223
+ wl_pointer.enter being in the same wl_pointer.frame.
2224
+ Compositor-specific policies may require the wl_pointer.leave and
2225
+ wl_pointer.enter event being split across multiple wl_pointer.frame
2226
+ groups.
2227
+ </description>
2228
+ </event>
2229
+
2230
+ <enum name="axis_source">
2231
+ <description summary="axis source types">
2232
+ Describes the source types for axis events. This indicates to the
2233
+ client how an axis event was physically generated; a client may
2234
+ adjust the user interface accordingly. For example, scroll events
2235
+ from a "finger" source may be in a smooth coordinate space with
2236
+ kinetic scrolling whereas a "wheel" source may be in discrete steps
2237
+ of a number of lines.
2238
+
2239
+ The "continuous" axis source is a device generating events in a
2240
+ continuous coordinate space, but using something other than a
2241
+ finger. One example for this source is button-based scrolling where
2242
+ the vertical motion of a device is converted to scroll events while
2243
+ a button is held down.
2244
+
2245
+ The "wheel tilt" axis source indicates that the actual device is a
2246
+ wheel but the scroll event is not caused by a rotation but a
2247
+ (usually sideways) tilt of the wheel.
2248
+ </description>
2249
+ <entry name="wheel" value="0" summary="a physical wheel rotation" />
2250
+ <entry name="finger" value="1" summary="finger on a touch surface" />
2251
+ <entry name="continuous" value="2" summary="continuous coordinate space"/>
2252
+ <entry name="wheel_tilt" value="3" summary="a physical wheel tilt" since="6"/>
2253
+ </enum>
2254
+
2255
+ <event name="axis_source" since="5">
2256
+ <description summary="axis source event">
2257
+ Source information for scroll and other axes.
2258
+
2259
+ This event does not occur on its own. It is sent before a
2260
+ wl_pointer.frame event and carries the source information for
2261
+ all events within that frame.
2262
+
2263
+ The source specifies how this event was generated. If the source is
2264
+ wl_pointer.axis_source.finger, a wl_pointer.axis_stop event will be
2265
+ sent when the user lifts the finger off the device.
2266
+
2267
+ If the source is wl_pointer.axis_source.wheel,
2268
+ wl_pointer.axis_source.wheel_tilt or
2269
+ wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event may
2270
+ or may not be sent. Whether a compositor sends an axis_stop event
2271
+ for these sources is hardware-specific and implementation-dependent;
2272
+ clients must not rely on receiving an axis_stop event for these
2273
+ scroll sources and should treat scroll sequences from these scroll
2274
+ sources as unterminated by default.
2275
+
2276
+ This event is optional. If the source is unknown for a particular
2277
+ axis event sequence, no event is sent.
2278
+ Only one wl_pointer.axis_source event is permitted per frame.
2279
+
2280
+ The order of wl_pointer.axis_discrete and wl_pointer.axis_source is
2281
+ not guaranteed.
2282
+ </description>
2283
+ <arg name="axis_source" type="uint" enum="axis_source" summary="source of the axis event"/>
2284
+ </event>
2285
+
2286
+ <event name="axis_stop" since="5">
2287
+ <description summary="axis stop event">
2288
+ Stop notification for scroll and other axes.
2289
+
2290
+ For some wl_pointer.axis_source types, a wl_pointer.axis_stop event
2291
+ is sent to notify a client that the axis sequence has terminated.
2292
+ This enables the client to implement kinetic scrolling.
2293
+ See the wl_pointer.axis_source documentation for information on when
2294
+ this event may be generated.
2295
+
2296
+ Any wl_pointer.axis events with the same axis_source after this
2297
+ event should be considered as the start of a new axis motion.
2298
+
2299
+ The timestamp is to be interpreted identical to the timestamp in the
2300
+ wl_pointer.axis event. The timestamp value may be the same as a
2301
+ preceding wl_pointer.axis event.
2302
+ </description>
2303
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
2304
+ <arg name="axis" type="uint" enum="axis" summary="the axis stopped with this event"/>
2305
+ </event>
2306
+
2307
+ <event name="axis_discrete" since="5" deprecated-since="8">
2308
+ <description summary="axis click event">
2309
+ Discrete step information for scroll and other axes.
2310
+
2311
+ This event carries the axis value of the wl_pointer.axis event in
2312
+ discrete steps (e.g. mouse wheel clicks).
2313
+
2314
+ This event is deprecated with wl_pointer version 8 - this event is not
2315
+ sent to clients supporting version 8 or later.
2316
+
2317
+ This event does not occur on its own, it is coupled with a
2318
+ wl_pointer.axis event that represents this axis value on a
2319
+ continuous scale. The protocol guarantees that each axis_discrete
2320
+ event is always followed by exactly one axis event with the same
2321
+ axis number within the same wl_pointer.frame. Note that the protocol
2322
+ allows for other events to occur between the axis_discrete and
2323
+ its coupled axis event, including other axis_discrete or axis
2324
+ events. A wl_pointer.frame must not contain more than one axis_discrete
2325
+ event per axis type.
2326
+
2327
+ This event is optional; continuous scrolling devices
2328
+ like two-finger scrolling on touchpads do not have discrete
2329
+ steps and do not generate this event.
2330
+
2331
+ The discrete value carries the directional information. e.g. a value
2332
+ of -2 is two steps towards the negative direction of this axis.
2333
+
2334
+ The axis number is identical to the axis number in the associated
2335
+ axis event.
2336
+
2337
+ The order of wl_pointer.axis_discrete and wl_pointer.axis_source is
2338
+ not guaranteed.
2339
+ </description>
2340
+ <arg name="axis" type="uint" enum="axis" summary="axis type"/>
2341
+ <arg name="discrete" type="int" summary="number of steps"/>
2342
+ </event>
2343
+
2344
+ <event name="axis_value120" since="8">
2345
+ <description summary="axis high-resolution scroll event">
2346
+ Discrete high-resolution scroll information.
2347
+
2348
+ This event carries high-resolution wheel scroll information,
2349
+ with each multiple of 120 representing one logical scroll step
2350
+ (a wheel detent). For example, an axis_value120 of 30 is one quarter of
2351
+ a logical scroll step in the positive direction, a value120 of
2352
+ -240 are two logical scroll steps in the negative direction within the
2353
+ same hardware event.
2354
+ Clients that rely on discrete scrolling should accumulate the
2355
+ value120 to multiples of 120 before processing the event.
2356
+
2357
+ The value120 must not be zero.
2358
+
2359
+ This event replaces the wl_pointer.axis_discrete event in clients
2360
+ supporting wl_pointer version 8 or later.
2361
+
2362
+ Where a wl_pointer.axis_source event occurs in the same
2363
+ wl_pointer.frame, the axis source applies to this event.
2364
+
2365
+ The order of wl_pointer.axis_value120 and wl_pointer.axis_source is
2366
+ not guaranteed.
2367
+ </description>
2368
+ <arg name="axis" type="uint" enum="axis" summary="axis type"/>
2369
+ <arg name="value120" type="int" summary="scroll distance as fraction of 120"/>
2370
+ </event>
2371
+
2372
+ <!-- Version 9 additions -->
2373
+
2374
+ <enum name="axis_relative_direction">
2375
+ <description summary="axis relative direction">
2376
+ This specifies the direction of the physical motion that caused a
2377
+ wl_pointer.axis event, relative to the wl_pointer.axis direction.
2378
+ </description>
2379
+ <entry name="identical" value="0"
2380
+ summary="physical motion matches axis direction"/>
2381
+ <entry name="inverted" value="1"
2382
+ summary="physical motion is the inverse of the axis direction"/>
2383
+ </enum>
2384
+
2385
+ <event name="axis_relative_direction" since="9">
2386
+ <description summary="axis relative physical direction event">
2387
+ Relative directional information of the entity causing the axis
2388
+ motion.
2389
+
2390
+ For a wl_pointer.axis event, the wl_pointer.axis_relative_direction
2391
+ event specifies the movement direction of the entity causing the
2392
+ wl_pointer.axis event. For example:
2393
+ - if a user's fingers on a touchpad move down and this
2394
+ causes a wl_pointer.axis vertical_scroll down event, the physical
2395
+ direction is 'identical'
2396
+ - if a user's fingers on a touchpad move down and this causes a
2397
+ wl_pointer.axis vertical_scroll up scroll up event ('natural
2398
+ scrolling'), the physical direction is 'inverted'.
2399
+
2400
+ A client may use this information to adjust scroll motion of
2401
+ components. Specifically, enabling natural scrolling causes the
2402
+ content to change direction compared to traditional scrolling.
2403
+ Some widgets like volume control sliders should usually match the
2404
+ physical direction regardless of whether natural scrolling is
2405
+ active. This event enables clients to match the scroll direction of
2406
+ a widget to the physical direction.
2407
+
2408
+ This event does not occur on its own, it is coupled with a
2409
+ wl_pointer.axis event that represents this axis value.
2410
+ The protocol guarantees that each axis_relative_direction event is
2411
+ always followed by exactly one axis event with the same
2412
+ axis number within the same wl_pointer.frame. Note that the protocol
2413
+ allows for other events to occur between the axis_relative_direction
2414
+ and its coupled axis event.
2415
+
2416
+ The axis number is identical to the axis number in the associated
2417
+ axis event.
2418
+
2419
+ The order of wl_pointer.axis_relative_direction,
2420
+ wl_pointer.axis_discrete and wl_pointer.axis_source is not
2421
+ guaranteed.
2422
+ </description>
2423
+ <arg name="axis" type="uint" enum="axis" summary="axis type"/>
2424
+ <arg name="direction" type="uint" enum="axis_relative_direction"
2425
+ summary="physical direction relative to axis motion"/>
2426
+ </event>
2427
+ </interface>
2428
+
2429
+ <interface name="wl_keyboard" version="9">
2430
+ <description summary="keyboard input device">
2431
+ The wl_keyboard interface represents one or more keyboards
2432
+ associated with a seat.
2433
+
2434
+ Each wl_keyboard has the following logical state:
2435
+
2436
+ - an active surface (possibly null),
2437
+ - the keys currently logically down,
2438
+ - the active modifiers,
2439
+ - the active group.
2440
+
2441
+ By default, the active surface is null, the keys currently logically down
2442
+ are empty, the active modifiers and the active group are 0.
2443
+ </description>
2444
+
2445
+ <enum name="keymap_format">
2446
+ <description summary="keyboard mapping format">
2447
+ This specifies the format of the keymap provided to the
2448
+ client with the wl_keyboard.keymap event.
2449
+ </description>
2450
+ <entry name="no_keymap" value="0"
2451
+ summary="no keymap; client must understand how to interpret the raw keycode"/>
2452
+ <entry name="xkb_v1" value="1"
2453
+ summary="libxkbcommon compatible, null-terminated string; to determine the xkb keycode, clients must add 8 to the key event keycode"/>
2454
+ </enum>
2455
+
2456
+ <event name="keymap">
2457
+ <description summary="keyboard mapping">
2458
+ This event provides a file descriptor to the client which can be
2459
+ memory-mapped in read-only mode to provide a keyboard mapping
2460
+ description.
2461
+
2462
+ From version 7 onwards, the fd must be mapped with MAP_PRIVATE by
2463
+ the recipient, as MAP_SHARED may fail.
2464
+ </description>
2465
+ <arg name="format" type="uint" enum="keymap_format" summary="keymap format"/>
2466
+ <arg name="fd" type="fd" summary="keymap file descriptor"/>
2467
+ <arg name="size" type="uint" summary="keymap size, in bytes"/>
2468
+ </event>
2469
+
2470
+ <event name="enter">
2471
+ <description summary="enter event">
2472
+ Notification that this seat's keyboard focus is on a certain
2473
+ surface.
2474
+
2475
+ The compositor must send the wl_keyboard.modifiers event after this
2476
+ event.
2477
+
2478
+ In the wl_keyboard logical state, this event sets the active surface to
2479
+ the surface argument and the keys currently logically down to the keys
2480
+ in the keys argument. The compositor must not send this event if the
2481
+ wl_keyboard already had an active surface immediately before this event.
2482
+ </description>
2483
+ <arg name="serial" type="uint" summary="serial number of the enter event"/>
2484
+ <arg name="surface" type="object" interface="wl_surface" summary="surface gaining keyboard focus"/>
2485
+ <arg name="keys" type="array" summary="the keys currently logically down"/>
2486
+ </event>
2487
+
2488
+ <event name="leave">
2489
+ <description summary="leave event">
2490
+ Notification that this seat's keyboard focus is no longer on
2491
+ a certain surface.
2492
+
2493
+ The leave notification is sent before the enter notification
2494
+ for the new focus.
2495
+
2496
+ In the wl_keyboard logical state, this event resets all values to their
2497
+ defaults. The compositor must not send this event if the active surface
2498
+ of the wl_keyboard was not equal to the surface argument immediately
2499
+ before this event.
2500
+ </description>
2501
+ <arg name="serial" type="uint" summary="serial number of the leave event"/>
2502
+ <arg name="surface" type="object" interface="wl_surface" summary="surface that lost keyboard focus"/>
2503
+ </event>
2504
+
2505
+ <enum name="key_state">
2506
+ <description summary="physical key state">
2507
+ Describes the physical state of a key that produced the key event.
2508
+ </description>
2509
+ <entry name="released" value="0" summary="key is not pressed"/>
2510
+ <entry name="pressed" value="1" summary="key is pressed"/>
2511
+ </enum>
2512
+
2513
+ <event name="key">
2514
+ <description summary="key event">
2515
+ A key was pressed or released.
2516
+ The time argument is a timestamp with millisecond
2517
+ granularity, with an undefined base.
2518
+
2519
+ The key is a platform-specific key code that can be interpreted
2520
+ by feeding it to the keyboard mapping (see the keymap event).
2521
+
2522
+ If this event produces a change in modifiers, then the resulting
2523
+ wl_keyboard.modifiers event must be sent after this event.
2524
+
2525
+ In the wl_keyboard logical state, this event adds the key to the keys
2526
+ currently logically down (if the state argument is pressed) or removes
2527
+ the key from the keys currently logically down (if the state argument is
2528
+ released). The compositor must not send this event if the wl_keyboard
2529
+ did not have an active surface immediately before this event. The
2530
+ compositor must not send this event if state is pressed (resp. released)
2531
+ and the key was already logically down (resp. was not logically down)
2532
+ immediately before this event.
2533
+ </description>
2534
+ <arg name="serial" type="uint" summary="serial number of the key event"/>
2535
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
2536
+ <arg name="key" type="uint" summary="key that produced the event"/>
2537
+ <arg name="state" type="uint" enum="key_state" summary="physical state of the key"/>
2538
+ </event>
2539
+
2540
+ <event name="modifiers">
2541
+ <description summary="modifier and group state">
2542
+ Notifies clients that the modifier and/or group state has
2543
+ changed, and it should update its local state.
2544
+
2545
+ The compositor may send this event without a surface of the client
2546
+ having keyboard focus, for example to tie modifier information to
2547
+ pointer focus instead. If a modifier event with pressed modifiers is sent
2548
+ without a prior enter event, the client can assume the modifier state is
2549
+ valid until it receives the next wl_keyboard.modifiers event. In order to
2550
+ reset the modifier state again, the compositor can send a
2551
+ wl_keyboard.modifiers event with no pressed modifiers.
2552
+
2553
+ In the wl_keyboard logical state, this event updates the modifiers and
2554
+ group.
2555
+ </description>
2556
+ <arg name="serial" type="uint" summary="serial number of the modifiers event"/>
2557
+ <arg name="mods_depressed" type="uint" summary="depressed modifiers"/>
2558
+ <arg name="mods_latched" type="uint" summary="latched modifiers"/>
2559
+ <arg name="mods_locked" type="uint" summary="locked modifiers"/>
2560
+ <arg name="group" type="uint" summary="keyboard layout"/>
2561
+ </event>
2562
+
2563
+ <!-- Version 3 additions -->
2564
+
2565
+ <request name="release" type="destructor" since="3">
2566
+ <description summary="release the keyboard object"/>
2567
+ </request>
2568
+
2569
+ <!-- Version 4 additions -->
2570
+
2571
+ <event name="repeat_info" since="4">
2572
+ <description summary="repeat rate and delay">
2573
+ Informs the client about the keyboard's repeat rate and delay.
2574
+
2575
+ This event is sent as soon as the wl_keyboard object has been created,
2576
+ and is guaranteed to be received by the client before any key press
2577
+ event.
2578
+
2579
+ Negative values for either rate or delay are illegal. A rate of zero
2580
+ will disable any repeating (regardless of the value of delay).
2581
+
2582
+ This event can be sent later on as well with a new value if necessary,
2583
+ so clients should continue listening for the event past the creation
2584
+ of wl_keyboard.
2585
+ </description>
2586
+ <arg name="rate" type="int"
2587
+ summary="the rate of repeating keys in characters per second"/>
2588
+ <arg name="delay" type="int"
2589
+ summary="delay in milliseconds since key down until repeating starts"/>
2590
+ </event>
2591
+ </interface>
2592
+
2593
+ <interface name="wl_touch" version="9">
2594
+ <description summary="touchscreen input device">
2595
+ The wl_touch interface represents a touchscreen
2596
+ associated with a seat.
2597
+
2598
+ Touch interactions can consist of one or more contacts.
2599
+ For each contact, a series of events is generated, starting
2600
+ with a down event, followed by zero or more motion events,
2601
+ and ending with an up event. Events relating to the same
2602
+ contact point can be identified by the ID of the sequence.
2603
+ </description>
2604
+
2605
+ <event name="down">
2606
+ <description summary="touch down event and beginning of a touch sequence">
2607
+ A new touch point has appeared on the surface. This touch point is
2608
+ assigned a unique ID. Future events from this touch point reference
2609
+ this ID. The ID ceases to be valid after a touch up event and may be
2610
+ reused in the future.
2611
+ </description>
2612
+ <arg name="serial" type="uint" summary="serial number of the touch down event"/>
2613
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
2614
+ <arg name="surface" type="object" interface="wl_surface" summary="surface touched"/>
2615
+ <arg name="id" type="int" summary="the unique ID of this touch point"/>
2616
+ <arg name="x" type="fixed" summary="surface-local x coordinate"/>
2617
+ <arg name="y" type="fixed" summary="surface-local y coordinate"/>
2618
+ </event>
2619
+
2620
+ <event name="up">
2621
+ <description summary="end of a touch event sequence">
2622
+ The touch point has disappeared. No further events will be sent for
2623
+ this touch point and the touch point's ID is released and may be
2624
+ reused in a future touch down event.
2625
+ </description>
2626
+ <arg name="serial" type="uint" summary="serial number of the touch up event"/>
2627
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
2628
+ <arg name="id" type="int" summary="the unique ID of this touch point"/>
2629
+ </event>
2630
+
2631
+ <event name="motion">
2632
+ <description summary="update of touch point coordinates">
2633
+ A touch point has changed coordinates.
2634
+ </description>
2635
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
2636
+ <arg name="id" type="int" summary="the unique ID of this touch point"/>
2637
+ <arg name="x" type="fixed" summary="surface-local x coordinate"/>
2638
+ <arg name="y" type="fixed" summary="surface-local y coordinate"/>
2639
+ </event>
2640
+
2641
+ <event name="frame">
2642
+ <description summary="end of touch frame event">
2643
+ Indicates the end of a set of events that logically belong together.
2644
+ A client is expected to accumulate the data in all events within the
2645
+ frame before proceeding.
2646
+
2647
+ A wl_touch.frame terminates at least one event but otherwise no
2648
+ guarantee is provided about the set of events within a frame. A client
2649
+ must assume that any state not updated in a frame is unchanged from the
2650
+ previously known state.
2651
+ </description>
2652
+ </event>
2653
+
2654
+ <event name="cancel">
2655
+ <description summary="touch session cancelled">
2656
+ Sent if the compositor decides the touch stream is a global
2657
+ gesture. No further events are sent to the clients from that
2658
+ particular gesture. Touch cancellation applies to all touch points
2659
+ currently active on this client's surface. The client is
2660
+ responsible for finalizing the touch points, future touch points on
2661
+ this surface may reuse the touch point ID.
2662
+
2663
+ No frame event is required after the cancel event.
2664
+ </description>
2665
+ </event>
2666
+
2667
+ <!-- Version 3 additions -->
2668
+
2669
+ <request name="release" type="destructor" since="3">
2670
+ <description summary="release the touch object"/>
2671
+ </request>
2672
+
2673
+ <!-- Version 6 additions -->
2674
+
2675
+ <event name="shape" since="6">
2676
+ <description summary="update shape of touch point">
2677
+ Sent when a touchpoint has changed its shape.
2678
+
2679
+ This event does not occur on its own. It is sent before a
2680
+ wl_touch.frame event and carries the new shape information for
2681
+ any previously reported, or new touch points of that frame.
2682
+
2683
+ Other events describing the touch point such as wl_touch.down,
2684
+ wl_touch.motion or wl_touch.orientation may be sent within the
2685
+ same wl_touch.frame. A client should treat these events as a single
2686
+ logical touch point update. The order of wl_touch.shape,
2687
+ wl_touch.orientation and wl_touch.motion is not guaranteed.
2688
+ A wl_touch.down event is guaranteed to occur before the first
2689
+ wl_touch.shape event for this touch ID but both events may occur within
2690
+ the same wl_touch.frame.
2691
+
2692
+ A touchpoint shape is approximated by an ellipse through the major and
2693
+ minor axis length. The major axis length describes the longer diameter
2694
+ of the ellipse, while the minor axis length describes the shorter
2695
+ diameter. Major and minor are orthogonal and both are specified in
2696
+ surface-local coordinates. The center of the ellipse is always at the
2697
+ touchpoint location as reported by wl_touch.down or wl_touch.move.
2698
+
2699
+ This event is only sent by the compositor if the touch device supports
2700
+ shape reports. The client has to make reasonable assumptions about the
2701
+ shape if it did not receive this event.
2702
+ </description>
2703
+ <arg name="id" type="int" summary="the unique ID of this touch point"/>
2704
+ <arg name="major" type="fixed" summary="length of the major axis in surface-local coordinates"/>
2705
+ <arg name="minor" type="fixed" summary="length of the minor axis in surface-local coordinates"/>
2706
+ </event>
2707
+
2708
+ <event name="orientation" since="6">
2709
+ <description summary="update orientation of touch point">
2710
+ Sent when a touchpoint has changed its orientation.
2711
+
2712
+ This event does not occur on its own. It is sent before a
2713
+ wl_touch.frame event and carries the new shape information for
2714
+ any previously reported, or new touch points of that frame.
2715
+
2716
+ Other events describing the touch point such as wl_touch.down,
2717
+ wl_touch.motion or wl_touch.shape may be sent within the
2718
+ same wl_touch.frame. A client should treat these events as a single
2719
+ logical touch point update. The order of wl_touch.shape,
2720
+ wl_touch.orientation and wl_touch.motion is not guaranteed.
2721
+ A wl_touch.down event is guaranteed to occur before the first
2722
+ wl_touch.orientation event for this touch ID but both events may occur
2723
+ within the same wl_touch.frame.
2724
+
2725
+ The orientation describes the clockwise angle of a touchpoint's major
2726
+ axis to the positive surface y-axis and is normalized to the -180 to
2727
+ +180 degree range. The granularity of orientation depends on the touch
2728
+ device, some devices only support binary rotation values between 0 and
2729
+ 90 degrees.
2730
+
2731
+ This event is only sent by the compositor if the touch device supports
2732
+ orientation reports.
2733
+ </description>
2734
+ <arg name="id" type="int" summary="the unique ID of this touch point"/>
2735
+ <arg name="orientation" type="fixed" summary="angle between major axis and positive surface y-axis in degrees"/>
2736
+ </event>
2737
+ </interface>
2738
+
2739
+ <interface name="wl_output" version="4">
2740
+ <description summary="compositor output region">
2741
+ An output describes part of the compositor geometry. The
2742
+ compositor works in the 'compositor coordinate system' and an
2743
+ output corresponds to a rectangular area in that space that is
2744
+ actually visible. This typically corresponds to a monitor that
2745
+ displays part of the compositor space. This object is published
2746
+ as global during start up, or when a monitor is hotplugged.
2747
+ </description>
2748
+
2749
+ <enum name="subpixel">
2750
+ <description summary="subpixel geometry information">
2751
+ This enumeration describes how the physical
2752
+ pixels on an output are laid out.
2753
+ </description>
2754
+ <entry name="unknown" value="0" summary="unknown geometry"/>
2755
+ <entry name="none" value="1" summary="no geometry"/>
2756
+ <entry name="horizontal_rgb" value="2" summary="horizontal RGB"/>
2757
+ <entry name="horizontal_bgr" value="3" summary="horizontal BGR"/>
2758
+ <entry name="vertical_rgb" value="4" summary="vertical RGB"/>
2759
+ <entry name="vertical_bgr" value="5" summary="vertical BGR"/>
2760
+ </enum>
2761
+
2762
+ <enum name="transform">
2763
+ <description summary="transformation applied to buffer contents">
2764
+ This describes transformations that clients and compositors apply to
2765
+ buffer contents.
2766
+
2767
+ The flipped values correspond to an initial flip around a
2768
+ vertical axis followed by rotation.
2769
+
2770
+ The purpose is mainly to allow clients to render accordingly and
2771
+ tell the compositor, so that for fullscreen surfaces, the
2772
+ compositor will still be able to scan out directly from client
2773
+ surfaces.
2774
+ </description>
2775
+ <entry name="normal" value="0" summary="no transform"/>
2776
+ <entry name="90" value="1" summary="90 degrees counter-clockwise"/>
2777
+ <entry name="180" value="2" summary="180 degrees counter-clockwise"/>
2778
+ <entry name="270" value="3" summary="270 degrees counter-clockwise"/>
2779
+ <entry name="flipped" value="4" summary="180 degree flip around a vertical axis"/>
2780
+ <entry name="flipped_90" value="5" summary="flip and rotate 90 degrees counter-clockwise"/>
2781
+ <entry name="flipped_180" value="6" summary="flip and rotate 180 degrees counter-clockwise"/>
2782
+ <entry name="flipped_270" value="7" summary="flip and rotate 270 degrees counter-clockwise"/>
2783
+ </enum>
2784
+
2785
+ <event name="geometry">
2786
+ <description summary="properties of the output">
2787
+ The geometry event describes geometric properties of the output.
2788
+ The event is sent when binding to the output object and whenever
2789
+ any of the properties change.
2790
+
2791
+ The physical size can be set to zero if it doesn't make sense for this
2792
+ output (e.g. for projectors or virtual outputs).
2793
+
2794
+ The geometry event will be followed by a done event (starting from
2795
+ version 2).
2796
+
2797
+ Clients should use wl_surface.preferred_buffer_transform instead of the
2798
+ transform advertised by this event to find the preferred buffer
2799
+ transform to use for a surface.
2800
+
2801
+ Note: wl_output only advertises partial information about the output
2802
+ position and identification. Some compositors, for instance those not
2803
+ implementing a desktop-style output layout or those exposing virtual
2804
+ outputs, might fake this information. Instead of using x and y, clients
2805
+ should use xdg_output.logical_position. Instead of using make and model,
2806
+ clients should use name and description.
2807
+ </description>
2808
+ <arg name="x" type="int"
2809
+ summary="x position within the global compositor space"/>
2810
+ <arg name="y" type="int"
2811
+ summary="y position within the global compositor space"/>
2812
+ <arg name="physical_width" type="int"
2813
+ summary="width in millimeters of the output"/>
2814
+ <arg name="physical_height" type="int"
2815
+ summary="height in millimeters of the output"/>
2816
+ <arg name="subpixel" type="int" enum="subpixel"
2817
+ summary="subpixel orientation of the output"/>
2818
+ <arg name="make" type="string"
2819
+ summary="textual description of the manufacturer"/>
2820
+ <arg name="model" type="string"
2821
+ summary="textual description of the model"/>
2822
+ <arg name="transform" type="int" enum="transform"
2823
+ summary="additional transformation applied to buffer contents during presentation"/>
2824
+ </event>
2825
+
2826
+ <enum name="mode" bitfield="true">
2827
+ <description summary="mode information">
2828
+ These flags describe properties of an output mode.
2829
+ They are used in the flags bitfield of the mode event.
2830
+ </description>
2831
+ <entry name="current" value="0x1"
2832
+ summary="indicates this is the current mode"/>
2833
+ <entry name="preferred" value="0x2"
2834
+ summary="indicates this is the preferred mode"/>
2835
+ </enum>
2836
+
2837
+ <event name="mode">
2838
+ <description summary="advertise available modes for the output">
2839
+ The mode event describes an available mode for the output.
2840
+
2841
+ The event is sent when binding to the output object and there
2842
+ will always be one mode, the current mode. The event is sent
2843
+ again if an output changes mode, for the mode that is now
2844
+ current. In other words, the current mode is always the last
2845
+ mode that was received with the current flag set.
2846
+
2847
+ Non-current modes are deprecated. A compositor can decide to only
2848
+ advertise the current mode and never send other modes. Clients
2849
+ should not rely on non-current modes.
2850
+
2851
+ The size of a mode is given in physical hardware units of
2852
+ the output device. This is not necessarily the same as
2853
+ the output size in the global compositor space. For instance,
2854
+ the output may be scaled, as described in wl_output.scale,
2855
+ or transformed, as described in wl_output.transform. Clients
2856
+ willing to retrieve the output size in the global compositor
2857
+ space should use xdg_output.logical_size instead.
2858
+
2859
+ The vertical refresh rate can be set to zero if it doesn't make
2860
+ sense for this output (e.g. for virtual outputs).
2861
+
2862
+ The mode event will be followed by a done event (starting from
2863
+ version 2).
2864
+
2865
+ Clients should not use the refresh rate to schedule frames. Instead,
2866
+ they should use the wl_surface.frame event or the presentation-time
2867
+ protocol.
2868
+
2869
+ Note: this information is not always meaningful for all outputs. Some
2870
+ compositors, such as those exposing virtual outputs, might fake the
2871
+ refresh rate or the size.
2872
+ </description>
2873
+ <arg name="flags" type="uint" enum="mode" summary="bitfield of mode flags"/>
2874
+ <arg name="width" type="int" summary="width of the mode in hardware units"/>
2875
+ <arg name="height" type="int" summary="height of the mode in hardware units"/>
2876
+ <arg name="refresh" type="int" summary="vertical refresh rate in mHz"/>
2877
+ </event>
2878
+
2879
+ <!-- Version 2 additions -->
2880
+
2881
+ <event name="done" since="2">
2882
+ <description summary="sent all information about output">
2883
+ This event is sent after all other properties have been
2884
+ sent after binding to the output object and after any
2885
+ other property changes done after that. This allows
2886
+ changes to the output properties to be seen as
2887
+ atomic, even if they happen via multiple events.
2888
+ </description>
2889
+ </event>
2890
+
2891
+ <event name="scale" since="2">
2892
+ <description summary="output scaling properties">
2893
+ This event contains scaling geometry information
2894
+ that is not in the geometry event. It may be sent after
2895
+ binding the output object or if the output scale changes
2896
+ later. The compositor will emit a non-zero, positive
2897
+ value for scale. If it is not sent, the client should
2898
+ assume a scale of 1.
2899
+
2900
+ A scale larger than 1 means that the compositor will
2901
+ automatically scale surface buffers by this amount
2902
+ when rendering. This is used for very high resolution
2903
+ displays where applications rendering at the native
2904
+ resolution would be too small to be legible.
2905
+
2906
+ Clients should use wl_surface.preferred_buffer_scale
2907
+ instead of this event to find the preferred buffer
2908
+ scale to use for a surface.
2909
+
2910
+ The scale event will be followed by a done event.
2911
+ </description>
2912
+ <arg name="factor" type="int" summary="scaling factor of output"/>
2913
+ </event>
2914
+
2915
+ <!-- Version 3 additions -->
2916
+
2917
+ <request name="release" type="destructor" since="3">
2918
+ <description summary="release the output object">
2919
+ Using this request a client can tell the server that it is not going to
2920
+ use the output object anymore.
2921
+ </description>
2922
+ </request>
2923
+
2924
+ <!-- Version 4 additions -->
2925
+
2926
+ <event name="name" since="4">
2927
+ <description summary="name of this output">
2928
+ Many compositors will assign user-friendly names to their outputs, show
2929
+ them to the user, allow the user to refer to an output, etc. The client
2930
+ may wish to know this name as well to offer the user similar behaviors.
2931
+
2932
+ The name is a UTF-8 string with no convention defined for its contents.
2933
+ Each name is unique among all wl_output globals. The name is only
2934
+ guaranteed to be unique for the compositor instance.
2935
+
2936
+ The same output name is used for all clients for a given wl_output
2937
+ global. Thus, the name can be shared across processes to refer to a
2938
+ specific wl_output global.
2939
+
2940
+ The name is not guaranteed to be persistent across sessions, thus cannot
2941
+ be used to reliably identify an output in e.g. configuration files.
2942
+
2943
+ Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do
2944
+ not assume that the name is a reflection of an underlying DRM connector,
2945
+ X11 connection, etc.
2946
+
2947
+ The name event is sent after binding the output object. This event is
2948
+ only sent once per output object, and the name does not change over the
2949
+ lifetime of the wl_output global.
2950
+
2951
+ Compositors may re-use the same output name if the wl_output global is
2952
+ destroyed and re-created later. Compositors should avoid re-using the
2953
+ same name if possible.
2954
+
2955
+ The name event will be followed by a done event.
2956
+ </description>
2957
+ <arg name="name" type="string" summary="output name"/>
2958
+ </event>
2959
+
2960
+ <event name="description" since="4">
2961
+ <description summary="human-readable description of this output">
2962
+ Many compositors can produce human-readable descriptions of their
2963
+ outputs. The client may wish to know this description as well, e.g. for
2964
+ output selection purposes.
2965
+
2966
+ The description is a UTF-8 string with no convention defined for its
2967
+ contents. The description is not guaranteed to be unique among all
2968
+ wl_output globals. Examples might include 'Foocorp 11" Display' or
2969
+ 'Virtual X11 output via :1'.
2970
+
2971
+ The description event is sent after binding the output object and
2972
+ whenever the description changes. The description is optional, and may
2973
+ not be sent at all.
2974
+
2975
+ The description event will be followed by a done event.
2976
+ </description>
2977
+ <arg name="description" type="string" summary="output description"/>
2978
+ </event>
2979
+ </interface>
2980
+
2981
+ <interface name="wl_region" version="1">
2982
+ <description summary="region interface">
2983
+ A region object describes an area.
2984
+
2985
+ Region objects are used to describe the opaque and input
2986
+ regions of a surface.
2987
+ </description>
2988
+
2989
+ <request name="destroy" type="destructor">
2990
+ <description summary="destroy region">
2991
+ Destroy the region. This will invalidate the object ID.
2992
+ </description>
2993
+ </request>
2994
+
2995
+ <request name="add">
2996
+ <description summary="add rectangle to region">
2997
+ Add the specified rectangle to the region.
2998
+ </description>
2999
+ <arg name="x" type="int" summary="region-local x coordinate"/>
3000
+ <arg name="y" type="int" summary="region-local y coordinate"/>
3001
+ <arg name="width" type="int" summary="rectangle width"/>
3002
+ <arg name="height" type="int" summary="rectangle height"/>
3003
+ </request>
3004
+
3005
+ <request name="subtract">
3006
+ <description summary="subtract rectangle from region">
3007
+ Subtract the specified rectangle from the region.
3008
+ </description>
3009
+ <arg name="x" type="int" summary="region-local x coordinate"/>
3010
+ <arg name="y" type="int" summary="region-local y coordinate"/>
3011
+ <arg name="width" type="int" summary="rectangle width"/>
3012
+ <arg name="height" type="int" summary="rectangle height"/>
3013
+ </request>
3014
+ </interface>
3015
+
3016
+ <interface name="wl_subcompositor" version="1">
3017
+ <description summary="sub-surface compositing">
3018
+ The global interface exposing sub-surface compositing capabilities.
3019
+ A wl_surface, that has sub-surfaces associated, is called the
3020
+ parent surface. Sub-surfaces can be arbitrarily nested and create
3021
+ a tree of sub-surfaces.
3022
+
3023
+ The root surface in a tree of sub-surfaces is the main
3024
+ surface. The main surface cannot be a sub-surface, because
3025
+ sub-surfaces must always have a parent.
3026
+
3027
+ A main surface with its sub-surfaces forms a (compound) window.
3028
+ For window management purposes, this set of wl_surface objects is
3029
+ to be considered as a single window, and it should also behave as
3030
+ such.
3031
+
3032
+ The aim of sub-surfaces is to offload some of the compositing work
3033
+ within a window from clients to the compositor. A prime example is
3034
+ a video player with decorations and video in separate wl_surface
3035
+ objects. This should allow the compositor to pass YUV video buffer
3036
+ processing to dedicated overlay hardware when possible.
3037
+ </description>
3038
+
3039
+ <request name="destroy" type="destructor">
3040
+ <description summary="unbind from the subcompositor interface">
3041
+ Informs the server that the client will not be using this
3042
+ protocol object anymore. This does not affect any other
3043
+ objects, wl_subsurface objects included.
3044
+ </description>
3045
+ </request>
3046
+
3047
+ <enum name="error">
3048
+ <entry name="bad_surface" value="0"
3049
+ summary="the to-be sub-surface is invalid"/>
3050
+ <entry name="bad_parent" value="1"
3051
+ summary="the to-be sub-surface parent is invalid"/>
3052
+ </enum>
3053
+
3054
+ <request name="get_subsurface">
3055
+ <description summary="give a surface the role sub-surface">
3056
+ Create a sub-surface interface for the given surface, and
3057
+ associate it with the given parent surface. This turns a
3058
+ plain wl_surface into a sub-surface.
3059
+
3060
+ The to-be sub-surface must not already have another role, and it
3061
+ must not have an existing wl_subsurface object. Otherwise the
3062
+ bad_surface protocol error is raised.
3063
+
3064
+ Adding sub-surfaces to a parent is a double-buffered operation on the
3065
+ parent (see wl_surface.commit). The effect of adding a sub-surface
3066
+ becomes visible on the next time the state of the parent surface is
3067
+ applied.
3068
+
3069
+ The parent surface must not be one of the child surface's descendants,
3070
+ and the parent must be different from the child surface, otherwise the
3071
+ bad_parent protocol error is raised.
3072
+
3073
+ This request modifies the behaviour of wl_surface.commit request on
3074
+ the sub-surface, see the documentation on wl_subsurface interface.
3075
+ </description>
3076
+ <arg name="id" type="new_id" interface="wl_subsurface"
3077
+ summary="the new sub-surface object ID"/>
3078
+ <arg name="surface" type="object" interface="wl_surface"
3079
+ summary="the surface to be turned into a sub-surface"/>
3080
+ <arg name="parent" type="object" interface="wl_surface"
3081
+ summary="the parent surface"/>
3082
+ </request>
3083
+ </interface>
3084
+
3085
+ <interface name="wl_subsurface" version="1">
3086
+ <description summary="sub-surface interface to a wl_surface">
3087
+ An additional interface to a wl_surface object, which has been
3088
+ made a sub-surface. A sub-surface has one parent surface. A
3089
+ sub-surface's size and position are not limited to that of the parent.
3090
+ Particularly, a sub-surface is not automatically clipped to its
3091
+ parent's area.
3092
+
3093
+ A sub-surface becomes mapped, when a non-NULL wl_buffer is applied
3094
+ and the parent surface is mapped. The order of which one happens
3095
+ first is irrelevant. A sub-surface is hidden if the parent becomes
3096
+ hidden, or if a NULL wl_buffer is applied. These rules apply
3097
+ recursively through the tree of surfaces.
3098
+
3099
+ The behaviour of a wl_surface.commit request on a sub-surface
3100
+ depends on the sub-surface's mode. The possible modes are
3101
+ synchronized and desynchronized, see methods
3102
+ wl_subsurface.set_sync and wl_subsurface.set_desync. Synchronized
3103
+ mode caches the wl_surface state to be applied when the parent's
3104
+ state gets applied, and desynchronized mode applies the pending
3105
+ wl_surface state directly. A sub-surface is initially in the
3106
+ synchronized mode.
3107
+
3108
+ Sub-surfaces also have another kind of state, which is managed by
3109
+ wl_subsurface requests, as opposed to wl_surface requests. This
3110
+ state includes the sub-surface position relative to the parent
3111
+ surface (wl_subsurface.set_position), and the stacking order of
3112
+ the parent and its sub-surfaces (wl_subsurface.place_above and
3113
+ .place_below). This state is applied when the parent surface's
3114
+ wl_surface state is applied, regardless of the sub-surface's mode.
3115
+ As the exception, set_sync and set_desync are effective immediately.
3116
+
3117
+ The main surface can be thought to be always in desynchronized mode,
3118
+ since it does not have a parent in the sub-surfaces sense.
3119
+
3120
+ Even if a sub-surface is in desynchronized mode, it will behave as
3121
+ in synchronized mode, if its parent surface behaves as in
3122
+ synchronized mode. This rule is applied recursively throughout the
3123
+ tree of surfaces. This means, that one can set a sub-surface into
3124
+ synchronized mode, and then assume that all its child and grand-child
3125
+ sub-surfaces are synchronized, too, without explicitly setting them.
3126
+
3127
+ Destroying a sub-surface takes effect immediately. If you need to
3128
+ synchronize the removal of a sub-surface to the parent surface update,
3129
+ unmap the sub-surface first by attaching a NULL wl_buffer, update parent,
3130
+ and then destroy the sub-surface.
3131
+
3132
+ If the parent wl_surface object is destroyed, the sub-surface is
3133
+ unmapped.
3134
+
3135
+ A sub-surface never has the keyboard focus of any seat.
3136
+
3137
+ The wl_surface.offset request is ignored: clients must use set_position
3138
+ instead to move the sub-surface.
3139
+ </description>
3140
+
3141
+ <request name="destroy" type="destructor">
3142
+ <description summary="remove sub-surface interface">
3143
+ The sub-surface interface is removed from the wl_surface object
3144
+ that was turned into a sub-surface with a
3145
+ wl_subcompositor.get_subsurface request. The wl_surface's association
3146
+ to the parent is deleted. The wl_surface is unmapped immediately.
3147
+ </description>
3148
+ </request>
3149
+
3150
+ <enum name="error">
3151
+ <entry name="bad_surface" value="0"
3152
+ summary="wl_surface is not a sibling or the parent"/>
3153
+ </enum>
3154
+
3155
+ <request name="set_position">
3156
+ <description summary="reposition the sub-surface">
3157
+ This schedules a sub-surface position change.
3158
+ The sub-surface will be moved so that its origin (top left
3159
+ corner pixel) will be at the location x, y of the parent surface
3160
+ coordinate system. The coordinates are not restricted to the parent
3161
+ surface area. Negative values are allowed.
3162
+
3163
+ The scheduled coordinates will take effect whenever the state of the
3164
+ parent surface is applied.
3165
+
3166
+ If more than one set_position request is invoked by the client before
3167
+ the commit of the parent surface, the position of a new request always
3168
+ replaces the scheduled position from any previous request.
3169
+
3170
+ The initial position is 0, 0.
3171
+ </description>
3172
+ <arg name="x" type="int" summary="x coordinate in the parent surface"/>
3173
+ <arg name="y" type="int" summary="y coordinate in the parent surface"/>
3174
+ </request>
3175
+
3176
+ <request name="place_above">
3177
+ <description summary="restack the sub-surface">
3178
+ This sub-surface is taken from the stack, and put back just
3179
+ above the reference surface, changing the z-order of the sub-surfaces.
3180
+ The reference surface must be one of the sibling surfaces, or the
3181
+ parent surface. Using any other surface, including this sub-surface,
3182
+ will cause a protocol error.
3183
+
3184
+ The z-order is double-buffered. Requests are handled in order and
3185
+ applied immediately to a pending state. The final pending state is
3186
+ copied to the active state the next time the state of the parent
3187
+ surface is applied.
3188
+
3189
+ A new sub-surface is initially added as the top-most in the stack
3190
+ of its siblings and parent.
3191
+ </description>
3192
+ <arg name="sibling" type="object" interface="wl_surface"
3193
+ summary="the reference surface"/>
3194
+ </request>
3195
+
3196
+ <request name="place_below">
3197
+ <description summary="restack the sub-surface">
3198
+ The sub-surface is placed just below the reference surface.
3199
+ See wl_subsurface.place_above.
3200
+ </description>
3201
+ <arg name="sibling" type="object" interface="wl_surface"
3202
+ summary="the reference surface"/>
3203
+ </request>
3204
+
3205
+ <request name="set_sync">
3206
+ <description summary="set sub-surface to synchronized mode">
3207
+ Change the commit behaviour of the sub-surface to synchronized
3208
+ mode, also described as the parent dependent mode.
3209
+
3210
+ In synchronized mode, wl_surface.commit on a sub-surface will
3211
+ accumulate the committed state in a cache, but the state will
3212
+ not be applied and hence will not change the compositor output.
3213
+ The cached state is applied to the sub-surface immediately after
3214
+ the parent surface's state is applied. This ensures atomic
3215
+ updates of the parent and all its synchronized sub-surfaces.
3216
+ Applying the cached state will invalidate the cache, so further
3217
+ parent surface commits do not (re-)apply old state.
3218
+
3219
+ See wl_subsurface for the recursive effect of this mode.
3220
+ </description>
3221
+ </request>
3222
+
3223
+ <request name="set_desync">
3224
+ <description summary="set sub-surface to desynchronized mode">
3225
+ Change the commit behaviour of the sub-surface to desynchronized
3226
+ mode, also described as independent or freely running mode.
3227
+
3228
+ In desynchronized mode, wl_surface.commit on a sub-surface will
3229
+ apply the pending state directly, without caching, as happens
3230
+ normally with a wl_surface. Calling wl_surface.commit on the
3231
+ parent surface has no effect on the sub-surface's wl_surface
3232
+ state. This mode allows a sub-surface to be updated on its own.
3233
+
3234
+ If cached state exists when wl_surface.commit is called in
3235
+ desynchronized mode, the pending state is added to the cached
3236
+ state, and applied as a whole. This invalidates the cache.
3237
+
3238
+ Note: even if a sub-surface is set to desynchronized, a parent
3239
+ sub-surface may override it to behave as synchronized. For details,
3240
+ see wl_subsurface.
3241
+
3242
+ If a surface's parent surface behaves as desynchronized, then
3243
+ the cached state is applied on set_desync.
3244
+ </description>
3245
+ </request>
3246
+ </interface>
3247
+
3248
+ </protocol>