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="fixed"/>
 349       <arg name="y" type="fixed"/>
 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="fixed"/>
 358       <arg name="y" type="fixed"/>
 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="seat" type="object" interface="wl_seat"/>
 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     <request name="pong">
 407       <description summary="respond to a ping event">
 408         A client must respond to a ping event with a pong request or
 409         the client may be deemed unresponsive.
 410       </description>
 411       <arg name="serial" type="uint"/>
 412     </request>
 413
 414     <request name="move">
 415       <arg name="seat" type="object" interface="wl_seat"/>
 416       <arg name="serial" type="uint"/>
 417     </request>
 418
 419     <enum name="resize">
 420       <entry name="none" value="0"/>
 421       <entry name="top" value="1"/>
 422       <entry name="bottom" value="2"/>
 423       <entry name="left" value="4"/>
 424       <entry name="top_left" value="5"/>
 425       <entry name="bottom_left" value="6"/>
 426       <entry name="right" value="8"/>
 427       <entry name="top_right" value="9"/>
 428       <entry name="bottom_right" value="10"/>
 429     </enum>
 430
 431     <request name="resize">
 432       <arg name="seat" type="object" interface="wl_seat"/>
 433       <arg name="serial" type="uint"/>
 434       <arg name="edges" type="uint"/>
 435     </request>
 436
 437     <request name="set_toplevel">
 438       <description summary="make the surface a top level surface">
 439         Make the surface a toplevel window.
 440       </description>
 441     </request>
 442
 443     <request name="set_transient">
 444       <description summary="make the surface a transient surface">
 445         Map the surface relative to an existing surface. The x and y
 446         arguments specify the locations of the upper left corner of
 447         the surface relative to the upper left corner of the parent
 448         surface.  The flags argument controls overflow/clipping
 449         behaviour when the surface would intersect a screen edge,
 450         panel or such.  And possibly whether the offset only
 451         determines the initial position or if the surface is locked to
 452         that relative position during moves.
 453       </description>
 454
 455       <arg name="parent" type="object" interface="wl_shell_surface"/>
 456       <arg name="x" type="int"/>
 457       <arg name="y" type="int"/>
 458       <arg name="flags" type="uint"/>
 459     </request>
 460
 461     <request name="set_fullscreen">
 462       <description summary="make the surface a fullscreen surface">
 463         Map the surface as a fullscreen surface. If an output parameter is
 464         given then the surface will be made fullscreen on that output. If the
 465         client does not specify the output then the compositor will apply its
 466         policy - usually choosing the output on which the surface has the
 467         biggest surface area.
 468
 469         The client may specify a method to resolve a size conflict between the
 470         output size and the surface size - this is provided through the
 471         fullscreen_method parameter.
 472
 473         The framerate parameter is used only when the fullscreen_method is set
 474         to "driver", to indicate the preferred framerate. framerate=0 indicates
 475         that the app does not care about framerate.  The framerate is
 476         specified in mHz, that is framerate of 60000 is 60Hz.
 477
 478         The compositor must reply to this request with a configure event with
 479         the dimensions for the output on which the surface will be made fullscreen.
 480       </description>
 481       <arg name="method" type="uint"/>
 482       <arg name="framerate" type="uint"/>
 483       <arg name="output" type="object" interface="wl_output"/>
 484     </request>
 485
 486     <enum name="fullscreen_method">
 487       <description summary="different method to set the surface fullscreen">
 488         Hints to indicate compositor how to deal with a conflict between the
 489         dimensions for the surface and the dimensions of the output. As a hint
 490         the compositor is free to ignore this parameter.
 491
 492         "default" The client has no preference on fullscreen behavior,
 493         policies are determined by compositor.
 494
 495         "scale" The client prefers scaling by the compositor. Scaling would
 496         always preserve surface's aspect ratio with surface centered on the
 497         output
 498
 499         "driver" The client wants to switch video mode to the smallest mode
 500         that can fit the client buffer. If the sizes do not match the
 501         compositor must add black borders.
 502
 503         "fill" The surface is centered on the output on the screen with no
 504         scaling. If the surface is of insufficient size the compositor must
 505         add black borders.
 506       </description>
 507       <entry name="default" value="0"/>
 508       <entry name="scale" value="1"/>
 509       <entry name="driver" value="2"/>
 510       <entry name="fill" value="3"/>
 511     </enum>
 512
 513     <request name="set_popup">
 514       <description summary="make the surface a popup surface">
 515         Popup surfaces.  Will switch an implicit grab into
 516         owner-events mode, and grab will continue after the implicit
 517         grab ends (button released).  Once the implicit grab is over,
 518         the popup grab continues until the window is destroyed or a
 519         mouse button is pressed in any other clients window.  A click
 520         in any of the clients surfaces is reported as normal, however,
 521         clicks in other clients surfaces will be discarded and trigger
 522         the callback.
 523
 524         TODO: Grab keyboard too, maybe just terminate on any click
 525         inside or outside the surface?
 526       </description>
 527
 528       <arg name="seat" type="object" interface="wl_seat"/>
 529       <arg name="serial" type="uint"/>
 530       <arg name="parent" type="object" interface="wl_shell_surface"/>
 531       <arg name="x" type="int"/>
 532       <arg name="y" type="int"/>
 533       <arg name="flags" type="uint"/>
 534     </request>
 535
 536     <request name="set_maximized">
 537       <description summary="make the surface a maximized surface">
 538         A request from the client to notify the compositor the maximized
 539         operation. The compositor will reply with a configure event telling
 540         the expected new surface size. The operation is completed on the
 541         next buffer attach to this surface.
 542         A maximized client will fill the fullscreen of the output it is bound
 543         to, except the panel area. This is the main difference between
 544         a maximized shell surface and a fullscreen shell surface.
 545       </description>
 546       <arg name="output" type="object" interface="wl_output"/>
 547     </request>
 548
 549     <request name="set_title">
 550       <description summary="set surface title">
 551       </description>
 552       <arg name="title" type="string"/>
 553     </request>
 554
 555     <request name="set_class">
 556       <description summary="set surface class">
 557         The surface class identifies the general class of applications
 558         to which the surface belongs.  The class is the file name of
 559         the applications .desktop file (absolute path if non-standard
 560         location).
 561       </description>
 562       <arg name="class_" type="string"/>
 563     </request>
 564
 565     <event name="ping">
 566       <description summary="ping client">
 567         Ping a client to check if it is receiving events and sending
 568         requests. A client is expected to reply with a pong request.
 569       </description>
 570       <arg name="serial" type="uint"/>
 571     </event>
 572
 573     <event name="configure">
 574       <description summary="suggest resize">
 575         The configure event asks the client to resize its surface.
 576         The size is a hint, in the sense that the client is free to
 577         ignore it if it doesn't resize, pick a smaller size (to
 578         satisfy aspect ration or resize in steps of NxM pixels).  The
 579         client is free to dismiss all but the last configure event it
 580         received.
 581       </description>
 582
 583       <arg name="edges" type="uint"/>
 584       <arg name="width" type="int"/>
 585       <arg name="height" type="int"/>
 586     </event>
 587
 588     <event name="popup_done">
 589       <description summary="popup interaction is done">
 590         The popup_done event is sent out when a popup grab is broken,
 591         that is, when the users clicks a surface that doesn't belong
 592         to the client owning the popup surface.
 593       </description>
 594     </event>
 595   </interface>
 596
 597   <interface name="wl_surface" version="1">
 598     <description summary="an onscreen surface">
 599       A surface.  This is an image that is displayed on the screen.
 600       It has a location, size and pixel contents.
 601     </description>
 602
 603     <request name="destroy" type="destructor">
 604       <description summary="delete surface">
 605         Deletes the surface and invalidates its object id.
 606       </description>
 607     </request>
 608
 609     <request name="attach">
 610       <description summary="set the surface contents">
 611         Copy the contents of a buffer into this surface. The x and y
 612         arguments specify the location of the new buffers upper left
 613         corner, relative to the old buffers upper left corner.
 614       </description>
 615
 616       <arg name="buffer" type="object" interface="wl_buffer"/>
 617       <arg name="x" type="int"/>
 618       <arg name="y" type="int"/>
 619     </request>
 620
 621     <request name="damage">
 622       <description summary="mark part of the surface damaged">
 623         After attaching a new buffer, this request is used to describe
 624         the regions where the new buffer is different from the
 625         previous buffer and needs to be repainted.  Coordinates are
 626         relative to the new buffer.
 627       </description>
 628
 629       <arg name="x" type="int"/>
 630       <arg name="y" type="int"/>
 631       <arg name="width" type="int"/>
 632       <arg name="height" type="int"/>
 633     </request>
 634
 635     <request name="frame">
 636       <description summary="request repaint feedback">
 637         Request notification when the next frame is displayed.  Useful
 638         for throttling redrawing operations, and driving animations.
 639         The notification will only be posted for one frame unless
 640         requested again.
 641       </description>
 642
 643       <arg name="callback" type="new_id" interface="wl_callback"/>
 644     </request>
 645
 646     <request name="set_opaque_region">
 647       <description summary="set opaque region">
 648         This requests sets the region of the surface that contain
 649         opaque content.  The opaque region is an optimization hint for
 650         the compositor that lets it optimize out redrawing of content
 651         behind opaque regions.  Setting an opaque region is not
 652         required for correct behaviour, but marking transparent
 653         content as opaque will result in repaint artifacts.
 654
 655         The region will be clipped to the extents of the current
 656         surface size.  Setting the region has copy semantics, and the
 657         region object can be destroyed immediately after setting the
 658         opaque region.  If a buffer of a different size is attached or
 659         if a nil region is set, the opaque region will revert back to
 660         default.  The default opaque region is empty.
 661       </description>
 662
 663       <arg name="region" type="object" interface="wl_region"/>
 664     </request>
 665
 666     <request name="set_input_region">
 667       <description summary="set input region">
 668         This requests sets the region of the surface that can receive
 669         pointer and touch events.  The region will be clipped to the
 670         extents of the current surface size.  Setting the region has
 671         copy semantics, and the region object can be destroyed
 672         immediately after setting the input region.  If a buffer of a
 673         different size is attached or if a nil region is passed, the
 674         input region will revert back to default.  The default input
 675         region is the entire surface.
 676       </description>
 677
 678       <arg name="region" type="object" interface="wl_region"/>
 679     </request>
 680
 681     <event name="enter">
 682       <description summary="surface enters an output">
 683         This is emitted whenever a surface's creation, movement, or resizing
 684         results in some part of it being within the scanout region of an
 685         output.
 686       </description>
 687       <arg name="output" type="object" interface="wl_output"/>
 688     </event>
 689
 690     <event name="leave">
 691       <description summary="surface leaves an output">
 692         This is emitted whenever a surface's creation, movement, or resizing
 693         results in it no longer having any part of it within the scanout region
 694         of an output.
 695       </description>
 696       <arg name="output" type="object" interface="wl_output"/>
 697     </event>
 698   </interface>
 699
 700   <interface name="wl_seat" version="1">
 701     <description summary="seat">
 702       A group of keyboards, pointer (mice, for example) and touch
 703       devices . This object is published as a global during start up,
 704       or when such a device is hot plugged.  A seat typically has a
 705       pointer and maintains a keyboard_focus and a pointer_focus.
 706     </description>
 707
 708     <enum name="capability">
 709       <description summary="seat capability bitmask">
 710         This is a bitmask of capabilities this seat has; if a member is
 711         set, then it is present on the seat.
 712       </description>
 713       <entry name="pointer" value="1" summary="wl_pointer"/>
 714       <entry name="keyboard" value="2" summary="wl_keyboard"/>
 715       <entry name="touch" value="4" summary="wl_touch"/>
 716     </enum>
 717
 718
 719     <event name="capabilities">
 720       <description summary="seat capabilities changed">
 721         This is emitted whenever a seat gains or loses the pointer,
 722         keyboard or touch capabilities.  The argument is a wl_seat_caps_mask
 723         enum containing the complete set of capabilities this seat has.
 724       </description>
 725       <arg name="capabilities" type="uint"/>
 726     </event>
 727
 728     <request name="get_pointer">
 729       <description summary="return pointer object">
 730         The ID provided will be initialized to the wl_pointer interface
 731         for this seat.
 732       </description>
 733       <arg name="id" type="new_id" interface="wl_pointer"/>
 734     </request>
 735
 736     <request name="get_keyboard">
 737       <description summary="return pointer object">
 738         The ID provided will be initialized to the wl_keyboard interface
 739         for this seat.
 740       </description>
 741       <arg name="id" type="new_id" interface="wl_keyboard"/>
 742     </request>
 743
 744     <request name="get_touch">
 745       <description summary="return pointer object">
 746         The ID provided will be initialized to the wl_touch interface
 747         for this seat.
 748       </description>
 749       <arg name="id" type="new_id" interface="wl_touch"/>
 750     </request>
 751   </interface>
 752
 753   <interface name="wl_pointer" version="1">
 754     <request name="attach">
 755       <description summary="set the pointer image">
 756         Set the pointer's image.  This request only takes effect if
 757         the pointer focus for this device is one of the requesting
 758         clients surfaces.
 759       </description>
 760
 761       <arg name="serial" type="uint"/>
 762       <arg name="buffer" type="object" interface="wl_buffer"/>
 763       <arg name="hotspot_x" type="int"/>
 764       <arg name="hotspot_y" type="int"/>
 765     </request>
 766
 767     <event name="enter">
 768       <description summary="enter event">
 769         Notification that this seat's pointer is focused on a certain
 770         surface. When an seat's focus enters a surface, the pointer image
 771         is undefined and a client should respond to this event by setting
 772         an appropriate pointer image.
 773       </description>
 774
 775       <arg name="serial" type="uint"/>
 776       <arg name="surface" type="object" interface="wl_surface"/>
 777       <arg name="surface_x" type="fixed"/>
 778       <arg name="surface_y" type="fixed"/>
 779     </event>
 780
 781     <event name="leave">
 782       <description summary="leave event">
 783       </description>
 784       <arg name="serial" type="uint"/>
 785       <arg name="surface" type="object" interface="wl_surface"/>
 786     </event>
 787
 788     <event name="motion">
 789       <description summary="pointer motion event">
 790         Notification of pointer location change. The arguments surface_[xy]
 791         are the location relative to the focused surface.
 792       </description>
 793
 794       <arg name="time" type="uint"/>
 795       <arg name="surface_x" type="fixed"/>
 796       <arg name="surface_y" type="fixed"/>
 797     </event>
 798
 799     <event name="button">
 800       <description summary="pointer button event">
 801         Mouse button click and release notifications.  The location
 802         of the click is given by the last motion or pointer_focus event.
 803       </description>
 804
 805       <arg name="serial" type="uint"/>
 806       <arg name="time" type="uint"/>
 807       <arg name="button" type="uint"/>
 808       <arg name="state" type="uint"/>
 809     </event>
 810
 811     <enum name="axis">
 812       <description summary="axis types"/>
 813       <entry name="vertical_scroll" value="0"/>
 814       <entry name="horizontal_scroll" value="1"/>
 815     </enum>
 816
 817     <event name="axis">
 818       <description summary="axis event">
 819         Scroll and other axis notifications.
 820       </description>
 821
 822       <arg name="time" type="uint"/>
 823       <arg name="axis" type="uint"/>
 824       <arg name="value" type="int"/>
 825     </event>
 826   </interface>
 827
 828   <interface name="wl_keyboard" version="1">
 829     <description summary="keyboard input device">
 830     </description>
 831
 832     <event name="enter">
 833       <arg name="serial" type="uint"/>
 834       <arg name="surface" type="object" interface="wl_surface"/>
 835       <arg name="keys" type="array"/>
 836     </event>
 837
 838     <event name="leave">
 839       <arg name="serial" type="uint"/>
 840       <arg name="surface" type="object" interface="wl_surface"/>
 841     </event>
 842
 843     <event name="key">
 844       <description summary="key event">
 845         A key was pressed or released.
 846       </description>
 847
 848       <arg name="serial" type="uint"/>
 849       <arg name="time" type="uint"/>
 850       <arg name="key" type="uint"/>
 851       <arg name="state" type="uint"/>
 852     </event>
 853   </interface>
 854
 855   <interface name="wl_touch" version="1">
 856     <description summary="touch screen input device">
 857     </description>
 858
 859     <event name="down">
 860       <arg name="serial" type="uint"/>
 861       <arg name="time" type="uint"/>
 862       <arg name="surface" type="object" interface="wl_surface"/>
 863       <arg name="id" type="int" />
 864       <arg name="x" type="fixed" />
 865       <arg name="y" type="fixed" />
 866     </event>
 867
 868     <event name="up">
 869       <arg name="serial" type="uint"/>
 870       <arg name="time" type="uint"/>
 871       <arg name="id" type="int" />
 872     </event>
 873
 874     <event name="motion">
 875       <arg name="time" type="uint"/>
 876       <arg name="id" type="int" />
 877       <arg name="x" type="fixed" />
 878       <arg name="y" type="fixed" />
 879     </event>
 880
 881     <event name="frame">
 882       <description summary="end of touch frame event">
 883         Indicates the end of a contact point list.
 884       </description>
 885     </event>
 886
 887     <event name="cancel">
 888       <description summary="touch session cancelled">
 889         Sent if the compositor decides the touch stream is a global
 890         gesture. No further events are sent to the clients from that
 891         particular gesture.
 892       </description>
 893     </event>
 894   </interface>
 895
 896
 897   <interface name="wl_output" version="1">
 898     <description summary="compositor output region">
 899       An output describes part of the compositor geometry.  The
 900       compositor work in the 'compositor coordinate system' and an
 901       output corresponds to rectangular area in that space that is
 902       actually visible.  This typically corresponds to a monitor that
 903       displays part of the compositor space.  This object is published
 904       as global during start up, or when a screen is hot plugged.
 905     </description>
 906
 907     <enum name="subpixel">
 908       <entry name="unknown" value="0"/>
 909       <entry name="none" value="1"/>
 910       <entry name="horizontal_rgb" value="2"/>
 911       <entry name="horizontal_bgr" value="3"/>
 912       <entry name="vertical_rgb" value="4"/>
 913       <entry name="vertical_bgr" value="5"/>
 914     </enum>
 915
 916     <event name="geometry">
 917       <description summary="properties of the output"/>
 918       <arg name="x" type="int"
 919            summary="x position within the global compositor space"/>
 920       <arg name="y" type="int"
 921            summary="y position within the global compositor space"/>
 922       <arg name="physical_width" type="int"
 923            summary="width in milimeters of the output"/>
 924       <arg name="physical_height" type="int"
 925            summary="height in milimeters of the output"/>
 926       <arg name="subpixel" type="int"
 927            summary="subpixel orientation of the output"/>
 928       <arg name="make" type="string"
 929            summary="textual description of the manufacturer"/>
 930       <arg name="model" type="string"
 931            summary="textual description of the model"/>
 932     </event>
 933
 934     <enum name="mode">
 935       <description summary="values for the flags bitfield in the mode event"/>
 936       <entry name="current" value="0x1"
 937              summary="indicates this is the current mode"/>
 938       <entry name="preferred" value="0x2"
 939              summary="indicates this is the preferred mode"/>
 940     </enum>
 941
 942     <event name="mode">
 943       <description summary="advertise available modes for the output">
 944         The mode event describes an available mode for the output.
 945         The event is sent when binding to the output object and there
 946         will always be one mode, the current mode.  The event is sent
 947         again if an output changes mode, for the mode that is now
 948         current.  In other words, the current mode is always the last
 949         mode that was received with the current flag set.
 950       </description>
 951       <arg name="flags" type="uint" summary="mask of wl_output_mode flags"/>
 952       <arg name="width" type="int" summary="width of the mode in pixels"/>
 953       <arg name="height" type="int" summary="height of the mode in pixels"/>
 954       <arg name="refresh" type="int" summary="vertical refresh rate in mHz"/>
 955     </event>
 956   </interface>
 957
 958   <interface name="wl_region" version="1">
 959     <description summary="region interface">
 960       Region.
 961     </description>
 962
 963     <request name="destroy" type="destructor">
 964       <description summary="destroy region">
 965         Destroy the region.  This will invalidate the object id.
 966       </description>
 967     </request>
 968
 969     <request name="add">
 970       <description summary="add rectangle to region">
 971         Add the specified rectangle to the region
 972       </description>
 973
 974       <arg name="x" type="int"/>
 975       <arg name="y" type="int"/>
 976       <arg name="width" type="int"/>
 977       <arg name="height" type="int"/>
 978     </request>
 979
 980     <request name="subtract">
 981       <description summary="subtract rectangle from region">
 982         Subtract the specified rectangle from the region
 983       </description>
 984
 985       <arg name="x" type="int"/>
 986       <arg name="y" type="int"/>
 987       <arg name="width" type="int"/>
 988       <arg name="height" type="int"/>
 989     </request>
 990
 991   </interface>
 992
 993 </protocol>