protocol/wayland.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <protocol name="wayland">
   3
   4   <copyright>
   5     Copyright © 2008-2011 Kristian Høgsberg
   6     Copyright © 2010-2011 Intel Corporation
   7
   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
  18     warranty.
  19
  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
  27     THIS SOFTWARE.
  28   </copyright>
  29
  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.
  34     </description>
  35     <request name="bind">
  36       <description summary="bind an object to the display">
  37         Binds a new, client-created object to the server using @name as
  38         the identifier.
  39       </description>
  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"/>
  44     </request>
  45
  46     <request name="sync">
  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.
  52       </description>
  53       <arg name="callback" type="new_id" interface="wl_callback"/>
  54     </request>
  55
  56     <event name="error">
  57       <description summary="fatal error event">
  58         The error event is sent out when a fatal (non-recoverable)
  59         error has occurred.
  60       </description>
  61       <arg name="object_id" type="object" interface="wl_object"/>
  62       <arg name="code" type="uint"/>
  63       <arg name="message" type="string"/>
  64     </event>
  65
  66     <enum name="error">
  67       <description summary="global error values">
  68         These errors are global and can be emitted in response to any
  69         server request.
  70       </description>
  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"/>
  77     </enum>
  78
  79     <event name="global">
  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
  88         object.
  89       </description>
  90       <arg name="name" type="uint"/>
  91       <arg name="interface" type="string"/>
  92       <arg name="version" type="uint"/>
  93     </event>
  94
  95     <event name="global_remove">
  96       <description summary="announce removal of global object">
  97         Notify the client of removed global objects.
  98       </description>
  99       <arg name="name" type="uint"/>
 100     </event>
 101
 102     <event name="delete_id">
 103       <description summary="acknowledge object id deletion">
 104         Server has deleted the id and client can now reuse it.
 105       </description>
 106       <arg name="id" type="uint" />
 107     </event>
 108   </interface>
 109
 110   <interface name="wl_callback" version="1">
 111     <event name="done">
 112       <arg name="serial" type="uint"/>
 113     </event>
 114   </interface>
 115
 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.
 121     </description>
 122
 123     <request name="create_surface">
 124       <description summary="create new surface">
 125         Ask the compositor to create a new surface.
 126       </description>
 127       <arg name="id" type="new_id" interface="wl_surface"/>
 128     </request>
 129
 130     <request name="create_region">
 131       <description summary="create new region">
 132         Ask the compositor to create a new region.
 133       </description>
 134       <arg name="id" type="new_id" interface="wl_region"/>
 135     </request>
 136   </interface>
 137
 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
 146       small buffers.
 147     </description>
 148
 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.
 157
 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
 160         a buffer from it.
 161       </description>
 162
 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"/>
 169     </request>
 170
 171     <request name="destroy" type="destructor">
 172       <description summary="destroy the pool">
 173         Destroy the pool.
 174       </description>
 175     </request>
 176   </interface>
 177
 178   <interface name="wl_shm" version="1">
 179     <description summary="shared memory support">
 180       Support for shared memory buffers.
 181     </description>
 182
 183     <enum name="error">
 184       <entry name="invalid_format" value="0"/>
 185       <entry name="invalid_stride" value="1"/>
 186       <entry name="invalid_fd" value="2"/>
 187     </enum>
 188
 189     <enum name="format">
 190       <entry name="argb8888" value="0"/>
 191       <entry name="xrgb8888" value="1"/>
 192     </enum>
 193
 194     <request name="create_pool">
 195       <description summary="create a shm pool">
 196         This creates wl_shm_pool object, which can be used to create
 197         shared memory based wl_buffer objects.  The server will mmap
 198         size bytes of the passed fd, to use as backing memory for then
 199         pool.
 200       </description>
 201
 202       <arg name="id" type="new_id" interface="wl_shm_pool"/>
 203       <arg name="fd" type="fd"/>
 204       <arg name="size" type="int"/>
 205     </request>
 206
 207     <event name="format">
 208       <arg name="format" type="uint"/>
 209     </event>
 210   </interface>
 211
 212   <interface name="wl_buffer" version="1">
 213     <description summary="content for a wl_surface">
 214       A buffer provides the content for a wl_surface.  Buffers are
 215       created through factory interfaces such as wl_drm, wl_shm or
 216       similar.  It has a width and a height and can be attached to a
 217       wl_surface, but the mechanism by which a client provides and
 218       updates the contents is defined by the buffer factory interface
 219     </description>
 220
 221     <request name="destroy" type="destructor">
 222       <description summary="destroy a buffer">
 223         Destroy a buffer.  This will invalidate the object id.
 224       </description>
 225     </request>
 226
 227     <event name="release">
 228       <description summary="compositor releases buffer">
 229         Sent when an attached buffer is no longer used by the compositor.
 230       </description>
 231     </event>
 232   </interface>
 233
 234
 235   <interface name="wl_data_offer" version="1">
 236     <request name="accept">
 237       <description summary="accept one of the offered mime-types">
 238         Indicate that the client can accept the given mime-type, or
 239         NULL for not accepted.  Use for feedback during drag and drop.
 240       </description>
 241
 242       <arg name="serial" type="uint"/>
 243       <arg name="type" type="string"/>
 244     </request>
 245
 246     <request name="receive">
 247       <arg name="mime_type" type="string"/>
 248       <arg name="fd" type="fd"/>
 249     </request>
 250
 251     <request name="destroy" type="destructor"/>
 252
 253     <event name="offer">
 254       <description summary="advertise offered mime-type">
 255         Sent immediately after creating the wl_data_offer object.  One
 256         event per offered mime type.
 257       </description>
 258
 259       <arg name="type" type="string"/>
 260     </event>
 261   </interface>
 262
 263   <interface name="wl_data_source" version="1">
 264     <request name="offer">
 265       <description summary="add an offered mime type">
 266         This request adds a mime-type to the set of mime-types
 267         advertised to targets.  Can be called several times to offer
 268         multiple types.
 269       </description>
 270       <arg name="type" type="string"/>
 271     </request>
 272
 273     <request name="destroy" type="destructor">
 274       <description summary="destroy the data source">
 275         Destroy the data source.
 276       </description>
 277     </request>
 278
 279     <event name="target">
 280       <description summary="a target accepts an offered mime-type">
 281         Sent when a target accepts pointer_focus or motion events.  If
 282         a target does not accept any of the offered types, type is NULL.
 283       </description>
 284
 285       <arg name="mime_type" type="string"/>
 286     </event>
 287
 288     <event name="send">
 289       <description summary="send the data">
 290         Request for data from another client.  Send the data as the
 291         specified mime-type over the passed fd, then close the fd.
 292       </description>
 293
 294       <arg name="mime_type" type="string"/>
 295       <arg name="fd" type="fd"/>
 296     </event>
 297
 298     <event name="cancelled">
 299       <description summary="selection was cancelled">
 300         Another selection became active.
 301       </description>
 302     </event>
 303
 304   </interface>
 305
 306   <interface name="wl_data_device" version="1">
 307     <request name="start_drag">
 308       <description summary="start drag and drop operation">
 309         This request asks the compositor to start a drag and drop
 310         operation on behalf of the client.  The source argument is the
 311         data source that provides the data for the eventual data
 312         transfer.  The origin surface is the surface where the drag
 313         originates and the client must have an active implicit grab
 314         that matches the serial.  The icon surface is an optional
 315         (can be nil) surface that provides an icon to be moved around
 316         with the cursor.  Initially, the top-left corner of the icon
 317         surface is placed at the cursor hotspot, but subsequent
 318         surface.attach request can move the relative position.
 319       </description>
 320       <arg name="source" type="object" interface="wl_data_source"/>
 321       <arg name="origin" type="object" interface="wl_surface"/>
 322       <arg name="icon" type="object" interface="wl_surface"/>
 323       <arg name="serial" type="uint"/>
 324     </request>
 325
 326     <request name="set_selection">
 327       <arg name="source" type="object" interface="wl_data_source"/>
 328       <arg name="serial" type="uint"/>
 329     </request>
 330
 331     <event name="data_offer">
 332       <description summary="introduce a new wl_data_offer">
 333         The data_offer event introduces a new wl_data_offer object,
 334         which will subsequently be used in either the
 335         data_device.enter event (for drag and drop) or the
 336         data_device.selection event (for selections).  Immediately
 337         following the data_device_data_offer event, the new data_offer
 338         object will send out data_offer.offer events to describe the
 339         mime-types it offers.
 340       </description>
 341
 342       <arg name="id" type="new_id" interface="wl_data_offer"/>
 343     </event>
 344
 345     <event name="enter">
 346       <arg name="serial" type="uint"/>
 347       <arg name="surface" type="object" interface="wl_surface"/>
 348       <arg name="x" type="int"/>
 349       <arg name="y" type="int"/>
 350       <arg name="id" type="object" interface="wl_data_offer"/>
 351     </event>
 352
 353     <event name="leave"/>
 354
 355     <event name="motion">
 356       <arg name="time" type="uint"/>
 357       <arg name="x" type="int"/>
 358       <arg name="y" type="int"/>
 359     </event>
 360
 361     <event name="drop"/>
 362
 363     <event name="selection">
 364       <description summary="advertise new selection">
 365         The selection event is sent out to notify the client of a new
 366         wl_data_offer for the selection for this device.  The
 367         data_device.data_offer and the data_offer.offer events are
 368         sent out immediately before this event to introduce the data
 369         offer object.  The selection event is sent to a client
 370         immediately before receiving keyboard focus and when a new
 371         selection is set while the client has keyboard focus.  The
 372         data_offer is valid until a new data_offer or NULL is received
 373         or until the client loses keyboard focus.
 374       </description>
 375       <arg name="id" type="object" interface="wl_data_offer"/>
 376     </event>
 377   </interface>
 378
 379   <interface name="wl_data_device_manager" version="1">
 380     <request name="create_data_source">
 381       <arg name="id" type="new_id" interface="wl_data_source"/>
 382     </request>
 383
 384     <request name="get_data_device">
 385       <arg name="id" type="new_id" interface="wl_data_device"/>
 386       <arg name="input_device" type="object" interface="wl_input_device"/>
 387     </request>
 388   </interface>
 389
 390   <interface name="wl_shell" version="1">
 391     <request name="get_shell_surface">
 392       <arg name="id" type="new_id" interface="wl_shell_surface"/>
 393       <arg name="surface" type="object" interface="wl_surface"/>
 394     </request>
 395   </interface>
 396
 397   <interface name="wl_shell_surface" version="1">
 398
 399     <description summary="desktop style meta data interface">
 400       An interface implemented by a wl_surface.  On server side the
 401       object is automatically destroyed when the related wl_surface is
 402       destroyed.  On client side, wl_shell_surface_destroy() must be
 403       called before destroying the wl_surface object.
 404     </description>
 405
 406     <event name="ping">
 407       <description summary="ping client">
 408         Ping a client to check if it is receiving events and sending
 409         requests. A client is expected to reply with a pong request.
 410       </description>
 411       <arg name="serial" type="uint"/>
 412     </event>
 413
 414     <request name="pong">
 415       <description summary="respond to a ping event">
 416         A client must respond to a ping event with a pong request or
 417         the client may be deemed unresponsive.
 418       </description>
 419       <arg name="serial" type="uint"/>
 420     </request>
 421
 422     <request name="move">
 423       <arg name="input_device" type="object" interface="wl_input_device"/>
 424       <arg name="serial" type="uint"/>
 425     </request>
 426
 427     <enum name="resize">
 428       <entry name="none" value="0"/>
 429       <entry name="top" value="1"/>
 430       <entry name="bottom" value="2"/>
 431       <entry name="left" value="4"/>
 432       <entry name="top_left" value="5"/>
 433       <entry name="bottom_left" value="6"/>
 434       <entry name="right" value="8"/>
 435       <entry name="top_right" value="9"/>
 436       <entry name="bottom_right" value="10"/>
 437     </enum>
 438
 439     <request name="resize">
 440       <arg name="input_device" type="object" interface="wl_input_device"/>
 441       <arg name="serial" type="uint"/>
 442       <arg name="edges" type="uint"/>
 443     </request>
 444
 445     <request name="set_toplevel">
 446       <description summary="make the surface a top level surface">
 447         Make the surface a toplevel window.
 448       </description>
 449     </request>
 450
 451     <request name="set_transient">
 452       <description summary="make the surface a transient surface">
 453         Map the surface relative to an existing surface. The x and y
 454         arguments specify the locations of the upper left corner of
 455         the surface relative to the upper left corner of the parent
 456         surface.  The flags argument controls overflow/clipping
 457         behaviour when the surface would intersect a screen edge,
 458         panel or such.  And possibly whether the offset only
 459         determines the initial position or if the surface is locked to
 460         that relative position during moves.
 461       </description>
 462
 463       <arg name="parent" type="object" interface="wl_shell_surface"/>
 464       <arg name="x" type="int"/>
 465       <arg name="y" type="int"/>
 466       <arg name="flags" type="uint"/>
 467     </request>
 468
 469     <request name="set_fullscreen">
 470       <description summary="make the surface a fullscreen surface">
 471         Map the surface as a fullscreen surface. If an output parameter is
 472         given then the surface will be made fullscreen on that output. If the
 473         client does not specify the output then the compositor will apply its
 474         policy - usually choosing the output on which the surface has the
 475         biggest surface area.
 476
 477         The client may specify a method to resolve a size conflict between the
 478         output size and the surface size - this is provided through the
 479         fullscreen_method parameter.
 480
 481         The framerate parameter is used only when the fullscreen_method is set
 482         to "driver", to indicate the preferred framerate. framerate=0 indicates
 483         that the app does not care about framerate.
 484
 485         The compositor must reply to this request with a configure event with
 486         the dimensions for the output on which the surface will be made fullscreen.
 487       </description>
 488       <arg name="method" type="uint"/>
 489       <arg name="framerate" type="uint"/>
 490       <arg name="output" type="object" interface="wl_output"/>
 491     </request>
 492
 493     <enum name="fullscreen_method">
 494       <description summary="different method to set the surface fullscreen">
 495         Hints to indicate compositor how to deal with a conflict between the
 496         dimensions for the surface and the dimensions of the output. As a hint
 497         the compositor is free to ignore this parameter.
 498
 499         "default" The client has no preference on fullscreen behavior,
 500         policies are determined by compositor.
 501
 502         "scale" The client prefers scaling by the compositor. Scaling would
 503         always preserve surface's aspect ratio with surface centered on the
 504         output
 505
 506         "driver" The client wants to switch video mode to the smallest mode
 507         that can fit the client buffer. If the sizes do not match the
 508         compositor must add black borders.
 509
 510         "fill" The surface is centered on the output on the screen with no
 511         scaling. If the surface is of insufficient size the compositor must
 512         add black borders.
 513       </description>
 514       <entry name="default" value="0"/>
 515       <entry name="scale" value="1"/>
 516       <entry name="driver" value="2"/>
 517       <entry name="fill" value="3"/>
 518     </enum>
 519
 520     <request name="set_popup">
 521       <description summary="make the surface a popup surface">
 522         Popup surfaces.  Will switch an implicit grab into
 523         owner-events mode, and grab will continue after the implicit
 524         grab ends (button released).  Once the implicit grab is over,
 525         the popup grab continues until the window is destroyed or a
 526         mouse button is pressed in any other clients window.  A click
 527         in any of the clients surfaces is reported as normal, however,
 528         clicks in other clients surfaces will be discarded and trigger
 529         the callback.
 530
 531         TODO: Grab keyboard too, maybe just terminate on any click
 532         inside or outside the surface?
 533       </description>
 534
 535       <arg name="input_device" type="object" interface="wl_input_device"/>
 536       <arg name="serial" type="uint"/>
 537       <arg name="parent" type="object" interface="wl_shell_surface"/>
 538       <arg name="x" type="int"/>
 539       <arg name="y" type="int"/>
 540       <arg name="flags" type="uint"/>
 541     </request>
 542
 543     <request name="set_maximized">
 544       <description summary="make the surface a maximized surface">
 545         A request from the client to notify the compositor the maximized
 546         operation. The compositor will reply with a configure event telling
 547         the expected new surface size. The operation is completed on the
 548         next buffer attach to this surface.
 549         A maximized client will fill the fullscreen of the output it is bound
 550         to, except the panel area. This is the main difference between
 551         a maximized shell surface and a fullscreen shell surface.
 552       </description>
 553       <arg name="output" type="object" interface="wl_output"/>
 554     </request>
 555
 556     <event name="configure">
 557       <description summary="suggest resize">
 558         The configure event asks the client to resize its surface.
 559         The size is a hint, in the sense that the client is free to
 560         ignore it if it doesn't resize, pick a smaller size (to
 561         satisfy aspect ration or resize in steps of NxM pixels).  The
 562         client is free to dismiss all but the last configure event it
 563         received.
 564       </description>
 565
 566       <arg name="edges" type="uint"/>
 567       <arg name="width" type="int"/>
 568       <arg name="height" type="int"/>
 569     </event>
 570
 571     <event name="popup_done">
 572       <description summary="popup interaction is done">
 573         The popup_done event is sent out when a popup grab is broken,
 574         that is, when the users clicks a surface that doesn't belong
 575         to the client owning the popup surface.
 576       </description>
 577     </event>
 578   </interface>
 579
 580   <interface name="wl_surface" version="1">
 581     <description summary="an onscreen surface">
 582       A surface.  This is an image that is displayed on the screen.
 583       It has a location, size and pixel contents.
 584     </description>
 585
 586     <request name="destroy" type="destructor">
 587       <description summary="delete surface">
 588         Deletes the surface and invalidates its object id.
 589       </description>
 590     </request>
 591
 592     <request name="attach">
 593       <description summary="set the surface contents">
 594         Copy the contents of a buffer into this surface. The x and y
 595         arguments specify the location of the new buffers upper left
 596         corner, relative to the old buffers upper left corner.
 597       </description>
 598
 599       <arg name="buffer" type="object" interface="wl_buffer"/>
 600       <arg name="x" type="int"/>
 601       <arg name="y" type="int"/>
 602     </request>
 603
 604     <request name="damage">
 605       <description summary="mark part of the surface damaged">
 606         After attaching a new buffer, this request is used to describe
 607         the regions where the new buffer is different from the
 608         previous buffer and needs to be repainted.  Coordinates are
 609         relative to the new buffer.
 610       </description>
 611
 612       <arg name="x" type="int"/>
 613       <arg name="y" type="int"/>
 614       <arg name="width" type="int"/>
 615       <arg name="height" type="int"/>
 616     </request>
 617
 618     <request name="frame">
 619       <description summary="request repaint feedback">
 620         Request notification when the next frame is displayed.  Useful
 621         for throttling redrawing operations, and driving animations.
 622         The notification will only be posted for one frame unless
 623         requested again.
 624       </description>
 625
 626       <arg name="callback" type="new_id" interface="wl_callback"/>
 627     </request>
 628
 629     <request name="set_opaque_region">
 630       <description summary="set opaque region">
 631         This requests sets the region of the surface that contain
 632         opaque content.  The opaque region is an optimization hint for
 633         the compositor that lets it optimize out redrawing of content
 634         behind opaque regions.  Setting an opaque region is not
 635         required for correct behaviour, but marking transparent
 636         content as opaque will result in repaint artifacts.
 637
 638         The region will be clipped to the extents of the current
 639         surface size.  Setting the region has copy semantics, and the
 640         region object can be destroyed immediately after setting the
 641         opaque region.  If a buffer of a different size is attached or
 642         if a nil region is set, the opaque region will revert back to
 643         default.  The default opaque region is empty.
 644       </description>
 645
 646       <arg name="region" type="object" interface="wl_region"/>
 647     </request>
 648
 649     <request name="set_input_region">
 650       <description summary="set input region">
 651         This requests sets the region of the surface that can receive
 652         pointer and touch events.  The region will be clipped to the
 653         extents of the current surface size.  Setting the region has
 654         copy semantics, and the region object can be destroyed
 655         immediately after setting the input region.  If a buffer of a
 656         different size is attached or if a nil region is passed, the
 657         input region will revert back to default.  The default input
 658         region is the entire surface.
 659       </description>
 660
 661       <arg name="region" type="object" interface="wl_region"/>
 662     </request>
 663
 664     <event name="enter">
 665       <description summary="surface enters an output">
 666         This is emitted whenever a surface's creation, movement, or resizing
 667         results in some part of it being within the scanout region of an
 668         output.
 669       </description>
 670       <arg name="output" type="object" interface="wl_output"/>
 671     </event>
 672
 673     <event name="leave">
 674       <description summary="surface leaves an output">
 675         This is emitted whenever a surface's creation, movement, or resizing
 676         results in it no longer having any part of it within the scanout region
 677         of an output.
 678       </description>
 679       <arg name="output" type="object" interface="wl_output"/>
 680     </event>
 681   </interface>
 682
 683   <interface name="wl_input_device" version="1">
 684     <description summary="input device group">
 685       A group of keyboards and pointer devices (mice, for
 686       example). This object is published as a global during start up,
 687       or when such a device is hot plugged.  A input_device group
 688       typically has a pointer and maintains a keyboard_focus and a
 689       pointer_focus.
 690     </description>
 691
 692     <request name="attach">
 693       <description summary="set the pointer image">
 694         Set the pointer's image.  This request only takes effect if
 695         the pointer focus for this device is one of the requesting
 696         clients surfaces.
 697       </description>
 698
 699       <arg name="serial" type="uint"/>
 700       <arg name="buffer" type="object" interface="wl_buffer"/>
 701       <arg name="hotspot_x" type="int"/>
 702       <arg name="hotspot_y" type="int"/>
 703     </request>
 704
 705     <event name="motion">
 706       <description summary="pointer motion event">
 707         Notification of pointer location change. The arguments surface_[xy]
 708         are the location relative to the focused surface.
 709       </description>
 710
 711       <arg name="time" type="uint"/>
 712       <arg name="surface_x" type="int"/>
 713       <arg name="surface_y" type="int"/>
 714     </event>
 715
 716     <event name="button">
 717       <description summary="pointer button event">
 718         Mouse button click and release notifications.  The location
 719         of the click is given by the last motion or pointer_focus event.
 720       </description>
 721
 722       <arg name="serial" type="uint"/>
 723       <arg name="time" type="uint"/>
 724       <arg name="button" type="uint"/>
 725       <arg name="state" type="uint"/>
 726     </event>
 727
 728     <enum name="axis">
 729       <description summary="axis types"/>
 730       <entry name="vertical_scroll" value="0"/>
 731       <entry name="horizontal_scroll" value="1"/>
 732     </enum>
 733
 734     <event name="axis">
 735       <description summary="axis event">
 736         Scroll and other axis notifications.
 737       </description>
 738
 739       <arg name="time" type="uint"/>
 740       <arg name="axis" type="uint"/>
 741       <arg name="value" type="int"/>
 742     </event>
 743
 744     <event name="key">
 745       <description summary="key event">
 746         A key was pressed or released.
 747       </description>
 748
 749       <arg name="serial" type="uint"/>
 750       <arg name="time" type="uint"/>
 751       <arg name="key" type="uint"/>
 752       <arg name="state" type="uint"/>
 753     </event>
 754
 755     <event name="pointer_enter">
 756       <description summary="pointer enter event">
 757         Notification that this input device's pointer is focused on
 758         certain surface. When an input_device enters a surface, the
 759         pointer image is undefined and a client should respond to this
 760         event by setting an appropriate pointer image.
 761       </description>
 762
 763       <arg name="serial" type="uint"/>
 764       <arg name="surface" type="object" interface="wl_surface"/>
 765       <arg name="surface_x" type="int"/>
 766       <arg name="surface_y" type="int"/>
 767     </event>
 768
 769     <event name="pointer_leave">
 770       <description summary="pointer leave event">
 771       </description>
 772       <arg name="serial" type="uint"/>
 773       <arg name="surface" type="object" interface="wl_surface"/>
 774     </event>
 775
 776     <event name="keyboard_enter">
 777       <arg name="serial" type="uint"/>
 778       <arg name="surface" type="object" interface="wl_surface"/>
 779       <arg name="keys" type="array"/>
 780     </event>
 781
 782     <event name="keyboard_leave">
 783       <arg name="serial" type="uint"/>
 784       <arg name="surface" type="object" interface="wl_surface"/>
 785     </event>
 786
 787     <event name="touch_down">
 788       <arg name="serial" type="uint"/>
 789       <arg name="time" type="uint"/>
 790       <arg name="surface" type="object" interface="wl_surface"/>
 791       <arg name="id" type="int" />
 792       <arg name="x" type="int" />
 793       <arg name="y" type="int" />
 794     </event>
 795
 796     <event name="touch_up">
 797       <arg name="serial" type="uint"/>
 798       <arg name="time" type="uint"/>
 799       <arg name="id" type="int" />
 800     </event>
 801
 802     <event name="touch_motion">
 803       <arg name="time" type="uint"/>
 804       <arg name="id" type="int" />
 805       <arg name="x" type="int" />
 806       <arg name="y" type="int" />
 807     </event>
 808
 809     <event name="touch_frame">
 810       <description summary="end of touch frame event">
 811         Indicates the end of a contact point list.
 812       </description>
 813     </event>
 814
 815     <event name="touch_cancel">
 816       <description summary="touch session cancelled">
 817         Sent if the compositor decides the touch stream is a global
 818         gesture. No further events are sent to the clients from that
 819         particular gesture.
 820       </description>
 821     </event>
 822   </interface>
 823
 824
 825   <interface name="wl_output" version="1">
 826     <description summary="compositor output region">
 827       An output describes part of the compositor geometry.  The
 828       compositor work in the 'compositor coordinate system' and an
 829       output corresponds to rectangular area in that space that is
 830       actually visible.  This typically corresponds to a monitor that
 831       displays part of the compositor space.  This object is published
 832       as global during start up, or when a screen is hot plugged.
 833     </description>
 834
 835     <enum name="subpixel">
 836       <entry name="unknown" value="0"/>
 837       <entry name="none" value="1"/>
 838       <entry name="horizontal_rgb" value="2"/>
 839       <entry name="horizontal_bgr" value="3"/>
 840       <entry name="vertical_rgb" value="4"/>
 841       <entry name="vertical_bgr" value="5"/>
 842     </enum>
 843
 844     <event name="geometry">
 845       <arg name="x" type="int"/>
 846       <arg name="y" type="int"/>
 847       <arg name="physical_width" type="int"/>
 848       <arg name="physical_height" type="int"/>
 849       <arg name="subpixel" type="int"/>
 850       <arg name="make" type="string"/>
 851       <arg name="model" type="string"/>
 852     </event>
 853
 854     <enum name="mode">
 855       <description summary="values for the flags bitfield in the mode event"/>
 856       <entry name="current" value="0x1"/>
 857       <entry name="preferred" value="0x2"/>
 858     </enum>
 859
 860     <event name="mode">
 861       <arg name="flags" type="uint"/>
 862       <arg name="width" type="int"/>
 863       <arg name="height" type="int"/>
 864       <arg name="refresh" type="int"/>
 865     </event>
 866   </interface>
 867
 868   <interface name="wl_region" version="1">
 869     <description summary="region interface">
 870       Region.
 871     </description>
 872
 873     <request name="destroy" type="destructor">
 874       <description summary="destroy region">
 875         Destroy the region.  This will invalidate the object id.
 876       </description>
 877     </request>
 878
 879     <request name="add">
 880       <description summary="add rectangle to region">
 881         Add the specified rectangle to the region
 882       </description>
 883
 884       <arg name="x" type="int"/>
 885       <arg name="y" type="int"/>
 886       <arg name="width" type="int"/>
 887       <arg name="height" type="int"/>
 888     </request>
 889
 890     <request name="subtract">
 891       <description summary="subtract rectangle from region">
 892         Subtract the specified rectangle from the region
 893       </description>
 894
 895       <arg name="x" type="int"/>
 896       <arg name="y" type="int"/>
 897       <arg name="width" type="int"/>
 898       <arg name="height" type="int"/>
 899     </request>
 900
 901   </interface>
 902
 903 </protocol>