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