1 <?xml version="1.0" encoding="UTF-8"?>
2 <protocol name="wayland">
5 Copyright © 2008-2011 Kristian Høgsberg
6 Copyright © 2010-2011 Intel Corporation
8 Permission to use, copy, modify, distribute, and sell this
9 software and its documentation for any purpose is hereby granted
10 without fee, provided that the above copyright notice appear in
11 all copies and that both that copyright notice and this permission
12 notice appear in supporting documentation, and that the name of
13 the copyright holders not be used in advertising or publicity
14 pertaining to distribution of the software without specific,
15 written prior permission. The copyright holders make no
16 representations about the suitability of this software for any
17 purpose. It is provided "as is" without express or implied
20 THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
21 SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
22 FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
23 SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
24 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
25 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
26 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
30 <interface name="wl_display" version="1">
31 <description summary="core global object">
32 The core global object. This is a special singleton object. It
33 is used for internal wayland protocol features.
36 <description summary="bind an object to the display">
37 Binds a new, client-created object to the server using @name as
40 <arg name="name" type="uint" summary="unique number id for object"/>
41 <arg name="interface" type="string"/>
42 <arg name="version" type="uint"/>
43 <arg name="id" type="new_id" interface="wl_object"/>
47 <description summary="asynchronous roundtrip">
48 The sync request asks the server to invoke the 'done' request
49 on the provided wl_callback object. Since requests are
50 handled in-order, this can be used as a barrier to ensure all
51 previous requests have been handled.
53 <arg name="callback" type="new_id" interface="wl_callback"/>
57 <description summary="fatal error event">
58 The error event is sent out when a fatal (non-recoverable)
61 <arg name="object_id" type="object" interface="wl_object"/>
62 <arg name="code" type="uint"/>
63 <arg name="message" type="string"/>
67 <description summary="global error values">
68 These errors are global and can be emitted in response to any
71 <entry name="invalid_object" value="0"
72 summary="server couldn't find object"/>
73 <entry name="invalid_method" value="1"
74 summary="method doesn't exist on the specified interface"/>
75 <entry name="no_memory" value="2"
76 summary="server is out of memory"/>
80 <description summary="announce global object">
81 Notify the client of global objects. These are objects that
82 are created by the server. Globals are published on the
83 initial client connection sequence, upon device hotplugs,
84 device disconnects, reconfiguration or other events. A client
85 can 'bind' to a global object by using the bind request. This
86 creates a client side handle that lets the object emit events
87 to the client and lets the client invoke requests on the
90 <arg name="name" type="uint"/>
91 <arg name="interface" type="string"/>
92 <arg name="version" type="uint"/>
95 <event name="global_remove">
96 <description summary="announce removal of global object">
97 Notify the client of removed global objects.
99 <arg name="name" type="uint"/>
102 <event name="delete_id">
103 <description summary="acknowledge object id deletion">
104 Server has deleted the id and client can now reuse it.
106 <arg name="id" type="uint" />
110 <interface name="wl_callback" version="1">
112 <arg name="serial" type="uint"/>
116 <interface name="wl_compositor" version="1">
117 <description summary="the compositor singleton">
118 A compositor. This object is a singleton global. The
119 compositor is in charge of combining the contents of multiple
120 surfaces into one displayable output.
123 <request name="create_surface">
124 <description summary="create new surface">
125 Ask the compositor to create a new surface.
127 <arg name="id" type="new_id" interface="wl_surface"/>
130 <request name="create_region">
131 <description summary="create new region">
132 Ask the compositor to create a new region.
134 <arg name="id" type="new_id" interface="wl_region"/>
138 <interface name="wl_shm_pool" version="1">
139 <description summary="a shared memory pool">
140 The wl_shm_pool object encapsulates a piece of memory shared
141 between the compsitor and client. Through the wl_shm_pool
142 object, the client can allocate shared memory wl_buffer objects.
143 The objects will share the same underlying mapped memory.
144 Reusing the mapped memory avoids the setup/teardown overhead and
145 is useful when interactively resizing a surface or for many
149 <request name="create_buffer">
150 <description summary="create wl_buffer from pool">
151 Create a wl_buffer from the pool. The buffer is created a
152 offset bytes into the pool and has width and height as
153 specified. The stride arguments specifies the number of bytes
154 from beginning of one row to the beginning of the next. The
155 format is the pixel format of the buffer and must be one of
156 those advertised through the wl_shm.format event.
158 A buffer will keep a reference to the pool it was created from
159 so it is valid to destroy the pool immediatedly after creating
163 <arg name="id" type="new_id" interface="wl_buffer"/>
164 <arg name="offset" type="int"/>
165 <arg name="width" type="int"/>
166 <arg name="height" type="int"/>
167 <arg name="stride" type="int"/>
168 <arg name="format" type="uint"/>
171 <request name="destroy" type="destructor">
172 <description summary="destroy the pool">
177 <request name="resize">
178 <description summary="change the size of the pool mapping">
179 This request will cause the server to remap the backing memory
180 for the pool from the fd passed when the pool was creating but
184 <arg name="size" type="int"/>
188 <interface name="wl_shm" version="1">
189 <description summary="shared memory support">
190 Support for shared memory buffers.
194 <entry name="invalid_format" value="0"/>
195 <entry name="invalid_stride" value="1"/>
196 <entry name="invalid_fd" value="2"/>
200 <entry name="argb8888" value="0"/>
201 <entry name="xrgb8888" value="1"/>
204 <request name="create_pool">
205 <description summary="create a shm pool">
206 This creates wl_shm_pool object, which can be used to create
207 shared memory based wl_buffer objects. The server will mmap
208 size bytes of the passed fd, to use as backing memory for then
212 <arg name="id" type="new_id" interface="wl_shm_pool"/>
213 <arg name="fd" type="fd"/>
214 <arg name="size" type="int"/>
217 <event name="format">
218 <arg name="format" type="uint"/>
222 <interface name="wl_buffer" version="1">
223 <description summary="content for a wl_surface">
224 A buffer provides the content for a wl_surface. Buffers are
225 created through factory interfaces such as wl_drm, wl_shm or
226 similar. It has a width and a height and can be attached to a
227 wl_surface, but the mechanism by which a client provides and
228 updates the contents is defined by the buffer factory interface
231 <request name="destroy" type="destructor">
232 <description summary="destroy a buffer">
233 Destroy a buffer. This will invalidate the object id.
237 <event name="release">
238 <description summary="compositor releases buffer">
239 Sent when an attached buffer is no longer used by the compositor.
245 <interface name="wl_data_offer" version="1">
246 <request name="accept">
247 <description summary="accept one of the offered mime-types">
248 Indicate that the client can accept the given mime-type, or
249 NULL for not accepted. Use for feedback during drag and drop.
252 <arg name="serial" type="uint"/>
253 <arg name="type" type="string" allow-null="true"/>
256 <request name="receive">
257 <arg name="mime_type" type="string"/>
258 <arg name="fd" type="fd"/>
261 <request name="destroy" type="destructor"/>
264 <description summary="advertise offered mime-type">
265 Sent immediately after creating the wl_data_offer object. One
266 event per offered mime type.
269 <arg name="type" type="string"/>
273 <interface name="wl_data_source" version="1">
274 <request name="offer">
275 <description summary="add an offered mime type">
276 This request adds a mime-type to the set of mime-types
277 advertised to targets. Can be called several times to offer
280 <arg name="type" type="string"/>
283 <request name="destroy" type="destructor">
284 <description summary="destroy the data source">
285 Destroy the data source.
289 <event name="target">
290 <description summary="a target accepts an offered mime-type">
291 Sent when a target accepts pointer_focus or motion events. If
292 a target does not accept any of the offered types, type is NULL.
295 <arg name="mime_type" type="string" allow-null="true"/>
299 <description summary="send the data">
300 Request for data from another client. Send the data as the
301 specified mime-type over the passed fd, then close the fd.
304 <arg name="mime_type" type="string"/>
305 <arg name="fd" type="fd"/>
308 <event name="cancelled">
309 <description summary="selection was cancelled">
310 Another selection became active.
316 <interface name="wl_data_device" version="1">
317 <request name="start_drag">
318 <description summary="start drag and drop operation">
319 This request asks the compositor to start a drag and drop
320 operation on behalf of the client.
322 The source argument is the data source that provides the data
323 for the eventual data transfer. If source is NULL, enter, leave
324 and motion events are sent only to the client that initiated the
325 drag and the client is expected to handle the data passing
328 The origin surface is the surface where the drag originates and
329 the client must have an active implicit grab that matches the
332 The icon surface is an optional (can be nil) surface that
333 provides an icon to be moved around with the cursor. Initially,
334 the top-left corner of the icon surface is placed at the cursor
335 hotspot, but subsequent surface.attach request can move the
338 <arg name="source" type="object" interface="wl_data_source" allow-null="true"/>
339 <arg name="origin" type="object" interface="wl_surface"/>
340 <arg name="icon" type="object" interface="wl_surface" allow-null="true"/>
341 <arg name="serial" type="uint"/>
344 <request name="set_selection">
345 <arg name="source" type="object" interface="wl_data_source" allow-null="true"/>
346 <arg name="serial" type="uint"/>
349 <event name="data_offer">
350 <description summary="introduce a new wl_data_offer">
351 The data_offer event introduces a new wl_data_offer object,
352 which will subsequently be used in either the
353 data_device.enter event (for drag and drop) or the
354 data_device.selection event (for selections). Immediately
355 following the data_device_data_offer event, the new data_offer
356 object will send out data_offer.offer events to describe the
357 mime-types it offers.
360 <arg name="id" type="new_id" interface="wl_data_offer"/>
364 <arg name="serial" type="uint"/>
365 <arg name="surface" type="object" interface="wl_surface"/>
366 <arg name="x" type="fixed"/>
367 <arg name="y" type="fixed"/>
368 <arg name="id" type="object" interface="wl_data_offer" allow-null="true"/>
371 <event name="leave"/>
373 <event name="motion">
374 <arg name="time" type="uint"/>
375 <arg name="x" type="fixed"/>
376 <arg name="y" type="fixed"/>
381 <event name="selection">
382 <description summary="advertise new selection">
383 The selection event is sent out to notify the client of a new
384 wl_data_offer for the selection for this device. The
385 data_device.data_offer and the data_offer.offer events are
386 sent out immediately before this event to introduce the data
387 offer object. The selection event is sent to a client
388 immediately before receiving keyboard focus and when a new
389 selection is set while the client has keyboard focus. The
390 data_offer is valid until a new data_offer or NULL is received
391 or until the client loses keyboard focus.
393 <arg name="id" type="object" interface="wl_data_offer" allow-null="true"/>
397 <interface name="wl_data_device_manager" version="1">
398 <request name="create_data_source">
399 <arg name="id" type="new_id" interface="wl_data_source"/>
402 <request name="get_data_device">
403 <arg name="id" type="new_id" interface="wl_data_device"/>
404 <arg name="seat" type="object" interface="wl_seat"/>
408 <interface name="wl_shell" version="1">
409 <request name="get_shell_surface">
410 <arg name="id" type="new_id" interface="wl_shell_surface"/>
411 <arg name="surface" type="object" interface="wl_surface"/>
415 <interface name="wl_shell_surface" version="1">
417 <description summary="desktop style meta data interface">
418 An interface implemented by a wl_surface. On server side the
419 object is automatically destroyed when the related wl_surface is
420 destroyed. On client side, wl_shell_surface_destroy() must be
421 called before destroying the wl_surface object.
424 <request name="pong">
425 <description summary="respond to a ping event">
426 A client must respond to a ping event with a pong request or
427 the client may be deemed unresponsive.
429 <arg name="serial" type="uint"/>
432 <request name="move">
433 <arg name="seat" type="object" interface="wl_seat"/>
434 <arg name="serial" type="uint"/>
438 <entry name="none" value="0"/>
439 <entry name="top" value="1"/>
440 <entry name="bottom" value="2"/>
441 <entry name="left" value="4"/>
442 <entry name="top_left" value="5"/>
443 <entry name="bottom_left" value="6"/>
444 <entry name="right" value="8"/>
445 <entry name="top_right" value="9"/>
446 <entry name="bottom_right" value="10"/>
449 <request name="resize">
450 <arg name="seat" type="object" interface="wl_seat"/>
451 <arg name="serial" type="uint"/>
452 <arg name="edges" type="uint"/>
455 <request name="set_toplevel">
456 <description summary="make the surface a top level surface">
457 Make the surface a toplevel window.
461 <enum name="transient">
462 <entry name="inactive" value="0x1" summary="do not set keyboard focus"/>
465 <request name="set_transient">
466 <description summary="make the surface a transient surface">
467 Map the surface relative to an existing surface. The x and y
468 arguments specify the locations of the upper left corner of
469 the surface relative to the upper left corner of the parent
470 surface. The flags argument controls overflow/clipping
471 behaviour when the surface would intersect a screen edge,
472 panel or such. And possibly whether the offset only
473 determines the initial position or if the surface is locked to
474 that relative position during moves.
477 <arg name="parent" type="object" interface="wl_surface"/>
478 <arg name="x" type="int"/>
479 <arg name="y" type="int"/>
480 <arg name="flags" type="uint"/>
483 <request name="set_fullscreen">
484 <description summary="make the surface a fullscreen surface">
485 Map the surface as a fullscreen surface. If an output parameter is
486 given then the surface will be made fullscreen on that output. If the
487 client does not specify the output then the compositor will apply its
488 policy - usually choosing the output on which the surface has the
489 biggest surface area.
491 The client may specify a method to resolve a size conflict between the
492 output size and the surface size - this is provided through the
493 fullscreen_method parameter.
495 The framerate parameter is used only when the fullscreen_method is set
496 to "driver", to indicate the preferred framerate. framerate=0 indicates
497 that the app does not care about framerate. The framerate is
498 specified in mHz, that is framerate of 60000 is 60Hz.
500 The compositor must reply to this request with a configure event with
501 the dimensions for the output on which the surface will be made fullscreen.
503 <arg name="method" type="uint"/>
504 <arg name="framerate" type="uint"/>
505 <arg name="output" type="object" interface="wl_output" allow-null="true"/>
508 <enum name="fullscreen_method">
509 <description summary="different method to set the surface fullscreen">
510 Hints to indicate compositor how to deal with a conflict between the
511 dimensions for the surface and the dimensions of the output. As a hint
512 the compositor is free to ignore this parameter.
514 "default" The client has no preference on fullscreen behavior,
515 policies are determined by compositor.
517 "scale" The client prefers scaling by the compositor. Scaling would
518 always preserve surface's aspect ratio with surface centered on the
521 "driver" The client wants to switch video mode to the smallest mode
522 that can fit the client buffer. If the sizes do not match the
523 compositor must add black borders.
525 "fill" The surface is centered on the output on the screen with no
526 scaling. If the surface is of insufficient size the compositor must
529 <entry name="default" value="0"/>
530 <entry name="scale" value="1"/>
531 <entry name="driver" value="2"/>
532 <entry name="fill" value="3"/>
535 <request name="set_popup">
536 <description summary="make the surface a popup surface">
537 Popup surfaces. Will switch an implicit grab into
538 owner-events mode, and grab will continue after the implicit
539 grab ends (button released). Once the implicit grab is over,
540 the popup grab continues until the window is destroyed or a
541 mouse button is pressed in any other clients window. A click
542 in any of the clients surfaces is reported as normal, however,
543 clicks in other clients surfaces will be discarded and trigger
546 TODO: Grab keyboard too, maybe just terminate on any click
547 inside or outside the surface?
550 <arg name="seat" type="object" interface="wl_seat"/>
551 <arg name="serial" type="uint"/>
552 <arg name="parent" type="object" interface="wl_surface"/>
553 <arg name="x" type="int"/>
554 <arg name="y" type="int"/>
555 <arg name="flags" type="uint"/>
558 <request name="set_maximized">
559 <description summary="make the surface a maximized surface">
560 A request from the client to notify the compositor the maximized
561 operation. The compositor will reply with a configure event telling
562 the expected new surface size. The operation is completed on the
563 next buffer attach to this surface.
564 A maximized client will fill the fullscreen of the output it is bound
565 to, except the panel area. This is the main difference between
566 a maximized shell surface and a fullscreen shell surface.
568 <arg name="output" type="object" interface="wl_output" allow-null="true"/>
571 <request name="set_title">
572 <description summary="set surface title">
574 <arg name="title" type="string"/>
577 <request name="set_class">
578 <description summary="set surface class">
579 The surface class identifies the general class of applications
580 to which the surface belongs. The class is the file name of
581 the applications .desktop file (absolute path if non-standard
584 <arg name="class_" type="string"/>
588 <description summary="ping client">
589 Ping a client to check if it is receiving events and sending
590 requests. A client is expected to reply with a pong request.
592 <arg name="serial" type="uint"/>
595 <event name="configure">
596 <description summary="suggest resize">
597 The configure event asks the client to resize its surface.
598 The size is a hint, in the sense that the client is free to
599 ignore it if it doesn't resize, pick a smaller size (to
600 satisfy aspect ration or resize in steps of NxM pixels). The
601 client is free to dismiss all but the last configure event it
605 <arg name="edges" type="uint"/>
606 <arg name="width" type="int"/>
607 <arg name="height" type="int"/>
610 <event name="popup_done">
611 <description summary="popup interaction is done">
612 The popup_done event is sent out when a popup grab is broken,
613 that is, when the users clicks a surface that doesn't belong
614 to the client owning the popup surface.
619 <interface name="wl_surface" version="1">
620 <description summary="an onscreen surface">
621 A surface. This is an image that is displayed on the screen.
622 It has a location, size and pixel contents.
625 <request name="destroy" type="destructor">
626 <description summary="delete surface">
627 Deletes the surface and invalidates its object id.
631 <request name="attach">
632 <description summary="set the surface contents">
633 Copy the contents of a buffer into this surface. The x and y
634 arguments specify the location of the new buffers upper left
635 corner, relative to the old buffers upper left corner.
638 <arg name="buffer" type="object" interface="wl_buffer" allow-null="true"/>
639 <arg name="x" type="int"/>
640 <arg name="y" type="int"/>
643 <request name="damage">
644 <description summary="mark part of the surface damaged">
645 After attaching a new buffer, this request is used to describe
646 the regions where the new buffer is different from the
647 previous buffer and needs to be repainted. Coordinates are
648 relative to the new buffer.
651 <arg name="x" type="int"/>
652 <arg name="y" type="int"/>
653 <arg name="width" type="int"/>
654 <arg name="height" type="int"/>
657 <request name="frame">
658 <description summary="request repaint feedback">
659 Request notification when the next frame is displayed. Useful
660 for throttling redrawing operations, and driving animations.
661 The notification will only be posted for one frame unless
665 <arg name="callback" type="new_id" interface="wl_callback"/>
668 <request name="set_opaque_region">
669 <description summary="set opaque region">
670 This requests sets the region of the surface that contain
671 opaque content. The opaque region is an optimization hint for
672 the compositor that lets it optimize out redrawing of content
673 behind opaque regions. Setting an opaque region is not
674 required for correct behaviour, but marking transparent
675 content as opaque will result in repaint artifacts.
677 The region will be clipped to the extents of the current
678 surface size. Setting the region has copy semantics, and the
679 region object can be destroyed immediately after setting the
680 opaque region. If a buffer of a different size is attached or
681 if a nil region is set, the opaque region will revert back to
682 default. The default opaque region is empty.
685 <arg name="region" type="object" interface="wl_region"/>
688 <request name="set_input_region">
689 <description summary="set input region">
690 This requests sets the region of the surface that can receive
691 pointer and touch events. The region will be clipped to the
692 extents of the current surface size. Setting the region has
693 copy semantics, and the region object can be destroyed
694 immediately after setting the input region. If a buffer of a
695 different size is attached or if a nil region is passed, the
696 input region will revert back to default. The default input
697 region is the entire surface.
700 <arg name="region" type="object" interface="wl_region" allow-null="true"/>
704 <description summary="surface enters an output">
705 This is emitted whenever a surface's creation, movement, or resizing
706 results in some part of it being within the scanout region of an
709 <arg name="output" type="object" interface="wl_output"/>
713 <description summary="surface leaves an output">
714 This is emitted whenever a surface's creation, movement, or resizing
715 results in it no longer having any part of it within the scanout region
718 <arg name="output" type="object" interface="wl_output"/>
722 <interface name="wl_seat" version="1">
723 <description summary="seat">
724 A group of keyboards, pointer (mice, for example) and touch
725 devices . This object is published as a global during start up,
726 or when such a device is hot plugged. A seat typically has a
727 pointer and maintains a keyboard_focus and a pointer_focus.
730 <enum name="capability">
731 <description summary="seat capability bitmask">
732 This is a bitmask of capabilities this seat has; if a member is
733 set, then it is present on the seat.
735 <entry name="pointer" value="1" summary="wl_pointer"/>
736 <entry name="keyboard" value="2" summary="wl_keyboard"/>
737 <entry name="touch" value="4" summary="wl_touch"/>
741 <event name="capabilities">
742 <description summary="seat capabilities changed">
743 This is emitted whenever a seat gains or loses the pointer,
744 keyboard or touch capabilities. The argument is a wl_seat_caps_mask
745 enum containing the complete set of capabilities this seat has.
747 <arg name="capabilities" type="uint"/>
750 <request name="get_pointer">
751 <description summary="return pointer object">
752 The ID provided will be initialized to the wl_pointer interface
755 <arg name="id" type="new_id" interface="wl_pointer"/>
758 <request name="get_keyboard">
759 <description summary="return pointer object">
760 The ID provided will be initialized to the wl_keyboard interface
763 <arg name="id" type="new_id" interface="wl_keyboard"/>
766 <request name="get_touch">
767 <description summary="return pointer object">
768 The ID provided will be initialized to the wl_touch interface
771 <arg name="id" type="new_id" interface="wl_touch"/>
775 <interface name="wl_pointer" version="1">
776 <request name="set_cursor">
777 <description summary="set the pointer surface">
778 Set the pointer surface, i.e., the surface that contains the
779 pointer image. This request only takes effect if the pointer
780 focus for this device is one of the requesting client surfaces
781 or the surface parameter is the current pointer surface. If
782 there was a previous surface set with this request it is
783 replaced. If surface is NULL, the pointer image is hidden.
785 The parameters hotspot_x and hotspot_y define the position of
786 the pointer surface relative to the pointer location. Its
787 top-left corner is always at (x, y) - (hotspot_x, hotspot_y),
788 where (x, y) are the coordinates of the pointer location.
790 On surface.attach requests to the pointer surface, hotspot_x
791 and hotspot_y are decremented by the x and y parameters
792 passed to the request.
794 The hotspot can also be updated by passing the current set
795 pointer surface to this request with new values for hotspot_x
799 <arg name="serial" type="uint"/>
800 <arg name="surface" type="object" interface="wl_surface" allow-null="true"/>
801 <arg name="hotspot_x" type="int"/>
802 <arg name="hotspot_y" type="int"/>
806 <description summary="enter event">
807 Notification that this seat's pointer is focused on a certain
808 surface. When an seat's focus enters a surface, the pointer image
809 is undefined and a client should respond to this event by setting
810 an appropriate pointer image.
813 <arg name="serial" type="uint"/>
814 <arg name="surface" type="object" interface="wl_surface"/>
815 <arg name="surface_x" type="fixed"/>
816 <arg name="surface_y" type="fixed"/>
820 <description summary="leave event">
822 <arg name="serial" type="uint"/>
823 <arg name="surface" type="object" interface="wl_surface"/>
826 <event name="motion">
827 <description summary="pointer motion event">
828 Notification of pointer location change. The arguments surface_[xy]
829 are the location relative to the focused surface.
832 <arg name="time" type="uint"/>
833 <arg name="surface_x" type="fixed"/>
834 <arg name="surface_y" type="fixed"/>
837 <enum name="button_state">
838 <description summary="physical button state">
839 Describes the physical state of a button which provoked the button
842 <entry name="released" value="0" summary="button is not pressed"/>
843 <entry name="pressed" value="1" summary="button is pressed"/>
846 <event name="button">
847 <description summary="pointer button event">
848 Mouse button click and release notifications. The location
849 of the click is given by the last motion or pointer_focus event.
852 <arg name="serial" type="uint"/>
853 <arg name="time" type="uint"/>
854 <arg name="button" type="uint"/>
855 <arg name="state" type="uint"/>
859 <description summary="axis types"/>
860 <entry name="vertical_scroll" value="0"/>
861 <entry name="horizontal_scroll" value="1"/>
865 <description summary="axis event">
866 Scroll and other axis notifications.
869 <arg name="time" type="uint"/>
870 <arg name="axis" type="uint"/>
871 <arg name="value" type="fixed"/>
875 <interface name="wl_keyboard" version="1">
876 <description summary="keyboard input device">
879 <enum name="keymap_format">
880 <description summary="keyboard mapping format">
881 This enum specifies the format of the keymap provided to the client
882 with the wl_keyboard::keymap event.
884 <entry name="xkb_v1" value="1" description="libxkbcommon compatible"/>
887 <event name="keymap">
888 <description summary="keyboard mapping">
889 This event provides a file descriptor to the client which can be
890 memory-mapped to provide a keyboard mapping description.
892 <arg name="format" type="uint"/>
893 <arg name="fd" type="fd"/>
894 <arg name="size" type="uint"/>
898 <arg name="serial" type="uint"/>
899 <arg name="surface" type="object" interface="wl_surface"/>
900 <arg name="keys" type="array"/>
904 <arg name="serial" type="uint"/>
905 <arg name="surface" type="object" interface="wl_surface"/>
908 <enum name="key_state">
909 <description summary="physical key state">
910 Describes the physical state of a key which provoked the key event.
911 When a key repeats, the sequence is down -> repeat -> repeat -> up.
913 <entry name="released" value="0" summary="key is not pressed"/>
914 <entry name="pressed" value="1" summary="key is pressed"/>
915 <entry name="repeat" value="2" summary="key is pressed and repeating"/>
919 <description summary="key event">
920 A key was pressed or released.
923 <arg name="serial" type="uint"/>
924 <arg name="time" type="uint"/>
925 <arg name="key" type="uint"/>
926 <arg name="state" type="uint"/>
929 <event name="modifiers">
930 <description summary="modifier and group state">
931 Notifies clients that the modifier and/or group state has
932 changed, and it should update its local state.
935 <arg name="serial" type="uint"/>
936 <arg name="mods_depressed" type="uint"/>
937 <arg name="mods_latched" type="uint"/>
938 <arg name="mods_locked" type="uint"/>
939 <arg name="group" type="uint"/>
943 <interface name="wl_touch" version="1">
944 <description summary="touch screen input device">
948 <arg name="serial" type="uint"/>
949 <arg name="time" type="uint"/>
950 <arg name="surface" type="object" interface="wl_surface"/>
951 <arg name="id" type="int" />
952 <arg name="x" type="fixed" />
953 <arg name="y" type="fixed" />
957 <arg name="serial" type="uint"/>
958 <arg name="time" type="uint"/>
959 <arg name="id" type="int" />
962 <event name="motion">
963 <arg name="time" type="uint"/>
964 <arg name="id" type="int" />
965 <arg name="x" type="fixed" />
966 <arg name="y" type="fixed" />
970 <description summary="end of touch frame event">
971 Indicates the end of a contact point list.
975 <event name="cancel">
976 <description summary="touch session cancelled">
977 Sent if the compositor decides the touch stream is a global
978 gesture. No further events are sent to the clients from that
985 <interface name="wl_output" version="1">
986 <description summary="compositor output region">
987 An output describes part of the compositor geometry. The
988 compositor work in the 'compositor coordinate system' and an
989 output corresponds to rectangular area in that space that is
990 actually visible. This typically corresponds to a monitor that
991 displays part of the compositor space. This object is published
992 as global during start up, or when a screen is hot plugged.
995 <enum name="subpixel">
996 <entry name="unknown" value="0"/>
997 <entry name="none" value="1"/>
998 <entry name="horizontal_rgb" value="2"/>
999 <entry name="horizontal_bgr" value="3"/>
1000 <entry name="vertical_rgb" value="4"/>
1001 <entry name="vertical_bgr" value="5"/>
1004 <event name="geometry">
1005 <description summary="properties of the output"/>
1006 <arg name="x" type="int"
1007 summary="x position within the global compositor space"/>
1008 <arg name="y" type="int"
1009 summary="y position within the global compositor space"/>
1010 <arg name="physical_width" type="int"
1011 summary="width in millimeters of the output"/>
1012 <arg name="physical_height" type="int"
1013 summary="height in millimeters of the output"/>
1014 <arg name="subpixel" type="int"
1015 summary="subpixel orientation of the output"/>
1016 <arg name="make" type="string"
1017 summary="textual description of the manufacturer"/>
1018 <arg name="model" type="string"
1019 summary="textual description of the model"/>
1023 <description summary="values for the flags bitfield in the mode event"/>
1024 <entry name="current" value="0x1"
1025 summary="indicates this is the current mode"/>
1026 <entry name="preferred" value="0x2"
1027 summary="indicates this is the preferred mode"/>
1031 <description summary="advertise available modes for the output">
1032 The mode event describes an available mode for the output.
1033 The event is sent when binding to the output object and there
1034 will always be one mode, the current mode. The event is sent
1035 again if an output changes mode, for the mode that is now
1036 current. In other words, the current mode is always the last
1037 mode that was received with the current flag set.
1039 <arg name="flags" type="uint" summary="mask of wl_output_mode flags"/>
1040 <arg name="width" type="int" summary="width of the mode in pixels"/>
1041 <arg name="height" type="int" summary="height of the mode in pixels"/>
1042 <arg name="refresh" type="int" summary="vertical refresh rate in mHz"/>
1046 <interface name="wl_region" version="1">
1047 <description summary="region interface">
1051 <request name="destroy" type="destructor">
1052 <description summary="destroy region">
1053 Destroy the region. This will invalidate the object id.
1057 <request name="add">
1058 <description summary="add rectangle to region">
1059 Add the specified rectangle to the region
1062 <arg name="x" type="int"/>
1063 <arg name="y" type="int"/>
1064 <arg name="width" type="int"/>
1065 <arg name="height" type="int"/>
1068 <request name="subtract">
1069 <description summary="subtract rectangle from region">
1070 Subtract the specified rectangle from the region
1073 <arg name="x" type="int"/>
1074 <arg name="y" type="int"/>
1075 <arg name="width" type="int"/>
1076 <arg name="height" type="int"/>