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\n 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   <!-- The core global object. This is a special singleton object.
  31        It is used for internal wayland protocol features. -->
  32   <interface name="wl_display" version="1">
  33     <request name="bind">
  34       <arg name="name" type="uint"/>
  35       <arg name="interface" type="string"/>
  36       <arg name="version" type="uint"/>
  37       <arg name="id" type="new_id" interface="wl_object"/>
  38     </request>
  39
  40     <!-- sync is an just an echo, which will reply with a key event.
  41          Since requests are handled in-order, this can be used as a
  42          barrier to ensure all previous requests have been handled.
  43          The key argument can be used to correlate between multiple
  44          sync invocations. -->
  45     <request name="sync">
  46       <arg name="callback" type="new_id" interface="wl_callback"/>
  47     </request>
  48
  49     <!-- A fatal error has occurred. -->
  50     <event name="error">
  51       <arg name="object_id" type="object" interface="wl_object"/>
  52       <arg name="code" type="uint"/>
  53       <arg name="message" type="string"/>
  54     </event>
  55
  56     <enum name="error">
  57       <entry name="invalid_object" value="0"/>
  58       <entry name="invalid_method" value="1"/>
  59       <entry name="no_memory" value="2"/>
  60     </enum>
  61
  62     <!-- Notify the client of global objects. These are objects that
  63          are created by the server. Globals are published on the
  64          initial client connection sequence, upon device hotplugs,
  65          device disconnects, reconfiguration or other events.  The
  66          server will always announce an object before the object sends
  67          out events. -->
  68     <event name="global">
  69       <arg name="name" type="uint"/>
  70       <arg name="interface" type="string"/>
  71       <arg name="version" type="uint"/>
  72     </event>
  73
  74     <!-- Notify the client of removed global objects. -->
  75     <event name="global_remove">
  76       <arg name="name" type="uint" />
  77     </event>
  78
  79     <!-- Server has deleted the id and client can now reuse it. -->
  80     <event name="delete_id">
  81       <arg name="id" type="uint" />
  82     </event>
  83   </interface>
  84
  85   <interface name="wl_callback" version="1">
  86     <event name="done">
  87       <arg name="time" type="uint"/>
  88     </event>
  89   </interface>
  90
  91   <!-- A compositor. This object is a global.  The compositor is in
  92        charge of combining the contents of multiple surfaces into one
  93        displayable output. -->
  94   <interface name="wl_compositor" version="1">
  95     <!-- Factory request for a surface objects. A surface is akin to a
  96          window. -->
  97     <request name="create_surface">
  98       <arg name="id" type="new_id" interface="wl_surface"/>
  99     </request>
 100   </interface>
 101
 102   <!-- Shared memory support -->
 103   <interface name="wl_shm" version="1">
 104     <enum name="error">
 105       <entry name="invalid_format" value="0"/>
 106       <entry name="invalid_stride" value="1"/>
 107       <entry name="invalid_fd" value="2"/>
 108     </enum>
 109
 110     <enum name="format">
 111       <entry name="argb32" value="0"/>
 112       <entry name="premultiplied_argb32" value="1"/>
 113       <entry name="xrgb32" value="2"/>
 114     </enum>
 115
 116     <!-- Transfer a shm buffer to the server.  The allocated buffer
 117          would include at least stride * height bytes starting at the
 118          beginning of fd.  The file descriptor is transferred over the
 119          socket using AF_UNIX magical features. width, height, stride
 120          and format describe the respective properties of the pixel
 121          data contained in the buffer. -->
 122     <request name="create_buffer">
 123       <arg name="id" type="new_id" interface="wl_buffer"/>
 124       <arg name="fd" type="fd"/>
 125       <arg name="width" type="int"/>
 126       <arg name="height" type="int"/>
 127       <arg name="stride" type="uint"/>
 128       <arg name="format" type="uint"/>
 129     </request>
 130
 131     <event name="format">
 132       <arg name="format" type="uint"/>
 133     </event>
 134   </interface>
 135
 136
 137   <!-- A pixel buffer. Created using the drm, shm or similar objects.
 138        It has a size, visual and contents, but not a location on the
 139        screen. -->
 140   <interface name="wl_buffer" version="1">
 141     <!-- Notify the server that the specified area of the buffers
 142          contents have changed.  To describe a more complicated area
 143          of damage, break down the region into rectangles and use this
 144          request several times.
 145     -->
 146     <request name="damage">
 147       <arg name="x" type="int"/>
 148       <arg name="y" type="int"/>
 149       <arg name="width" type="int"/>
 150       <arg name="height" type="int"/>
 151     </request>
 152
 153     <!-- Destroy a buffer.  This will invalidate the object id. -->
 154     <request name="destroy" type="destructor"/>
 155
 156     <!-- Sent when an attached buffer is no longer used by the compositor. -->
 157     <event name="release"/>
 158   </interface>
 159
 160
 161   <interface name="wl_data_offer" version="1">
 162     <!-- Indicate that the client can accept the given mime-type, or
 163          NULL for not accepted.  Use for feedback during drag and
 164          drop. -->
 165     <request name="accept">
 166       <arg name="time" type="uint"/>
 167       <arg name="type" type="string"/>
 168     </request>
 169
 170     <request name="receive">
 171       <arg name="mime_type" type="string"/>
 172       <arg name="fd" type="fd"/>
 173     </request>
 174
 175     <request name="destroy" type="destructor"/>
 176
 177     <!-- Sent immediately after creating the wl_data_offer object.  One
 178          event per offered mime type. -->
 179     <event name="offer">
 180       <arg name="type" type="string"/>
 181     </event>
 182   </interface>
 183
 184   <interface name="wl_data_source" version="1">
 185     <!-- Add an offered mime type.  Can be called several times to
 186          offer multiple types. -->
 187     <request name="offer">
 188       <arg name="type" type="string"/>
 189     </request>
 190
 191     <!-- Destroy the selection. -->
 192     <request name="destroy" type="destructor"/>
 193
 194     <!-- Sent when a target accepts pointer_focus or motion events.
 195          If a target does not accept any of the offered types, type is
 196          NULL -->
 197     <event name="target">
 198       <arg name="mime_type" type="string"/>
 199     </event>
 200
 201     <!-- Request for data from another client.  Send the data in the
 202          specified mime-type over the passed fd, the close it. -->
 203     <event name="send">
 204       <arg name="mime_type" type="string"/>
 205       <arg name="fd" type="fd"/>
 206     </event>
 207
 208     <!-- Another selection became active. -->
 209     <event name="cancelled"/>
 210   </interface>
 211
 212   <interface name="wl_data_device" version="1">
 213     <request name="start_drag">
 214       <arg name="source" type="object" interface="wl_data_source"/>
 215       <arg name="surface" type="object" interface="wl_surface"/>
 216       <arg name="time" type="uint"/>
 217     </request>
 218
 219     <request name="attach">
 220       <arg name="time" type="uint"/>
 221       <arg name="buffer" type="object" interface="wl_buffer"/>
 222       <arg name="x" type="int"/>
 223       <arg name="y" type="int"/>
 224     </request>
 225
 226     <request name="set_selection">
 227       <arg name="source" type="object" interface="wl_data_source"/>
 228       <arg name="time" type="uint"/>
 229     </request>
 230
 231     <!-- The data_offer event introduces a new wl_data_offer object,
 232          which will subsequently be used in either the
 233          data_device.enter event (for drag and drop) or the
 234          data_device.selection event (for selections).  Immediately
 235          following the data_device_data_offer event, the new
 236          data_offer object will send out data_offer.offer events to
 237          describe the mime-types it offers. -->
 238     <event name="data_offer">
 239       <arg name="id" type="new_id" interface="wl_data_offer"/>
 240     </event>
 241
 242     <event name="enter">
 243       <arg name="time" type="uint"/>
 244       <arg name="surface" type="object" interface="wl_surface"/>
 245       <arg name="x" type="int"/>
 246       <arg name="y" type="int"/>
 247       <arg name="id" type="object" interface="wl_data_offer"/>
 248     </event>
 249
 250     <event name="leave"/>
 251
 252     <event name="motion">
 253       <arg name="time" type="uint"/>
 254       <arg name="x" type="int"/>
 255       <arg name="y" type="int"/>
 256     </event>
 257
 258     <event name="drop"/>
 259
 260     <!-- The selection event is sent out to notify the client of a new
 261          wl_data_offer for the selection for this device.  The
 262          data_device.data_offer and the data_offer.offer events are
 263          sent out immediately before this event to introduce the data
 264          offer object.  The selection event is sent to a client
 265          immediately before receiving keyboard focus and when a new
 266          selection is set while the client has keyboard focus.  The
 267          data_offer is valid until a new data_offer or NULL is
 268          received or until the client loses keyboard focus. -->
 269     <event name="selection">
 270       <arg name="id" type="object" interface="wl_data_offer"/>
 271     </event>
 272   </interface>
 273
 274   <interface name="wl_data_device_manager" version="1">
 275     <request name="create_data_source">
 276       <arg name="id" type="new_id" interface="wl_data_source"/>
 277     </request>
 278
 279     <request name="get_data_device">
 280       <arg name="id" type="new_id" interface="wl_data_device"/>
 281       <arg name="input_device" type="object" interface="wl_input_device"/>
 282     </request>
 283   </interface>
 284
 285   <interface name="wl_shell" version="1">
 286     <request name="get_shell_surface">
 287       <arg name="id" type="new_id" interface="wl_shell_surface"/>
 288       <arg name="surface" type="object" interface="wl_surface"/>
 289     </request>
 290   </interface>
 291
 292   <!-- A wrapper interface for shell related actions on a wl_surface.
 293        On server side the object is automatically destroyed when the
 294        related wl_surface is destroyed.
 295        On client side, wl_shell_surface_destroy() must be called
 296        before destroying the wl_surface object. -->
 297   <interface name="wl_shell_surface" version="1">
 298     <request name="move">
 299       <arg name="input_device" type="object" interface="wl_input_device"/>
 300       <arg name="time" type="uint"/>
 301     </request>
 302
 303     <enum name="resize">
 304       <entry name="none" value="0"/>
 305       <entry name="top" value="1"/>
 306       <entry name="bottom" value="2"/>
 307       <entry name="left" value="4"/>
 308       <entry name="top_left" value="5"/>
 309       <entry name="bottom_left" value="6"/>
 310       <entry name="right" value="8"/>
 311       <entry name="top_right" value="9"/>
 312       <entry name="bottom_right" value="10"/>
 313     </enum>
 314
 315     <request name="resize">
 316       <arg name="input_device" type="object" interface="wl_input_device"/>
 317       <arg name="time" type="uint"/>
 318       <!-- edges is an enum, need to get the values in here -->
 319       <arg name="edges" type="uint"/>
 320     </request>
 321
 322     <!-- Make the surface visible as a toplevel window. -->
 323     <request name="set_toplevel"/>
 324
 325     <!-- Map the surface relative to an existing surface. The x and y
 326          arguments specify the locations of the upper left corner of
 327          the surface relative to the upper left corner of the parent
 328          surface.  The flags argument controls overflow/clipping
 329          behaviour when the surface would intersect a screen edge,
 330          panel or such.  And possibly whether the offset only
 331          determines the initial position or if the surface is locked
 332          to that relative position during moves. -->
 333     <request name="set_transient">
 334       <arg name="parent" type="object" interface="wl_shell_surface"/>
 335       <arg name="x" type="int"/>
 336       <arg name="y" type="int"/>
 337       <arg name="flags" type="uint"/>
 338     </request>
 339
 340     <!-- Map the surface as a fullscreen surface.  There are a number
 341          of options here: on which output? if the surface size doesn't
 342          match the output size, do we scale, change resolution, or add
 343          black borders? is that something the client controls?  what
 344          about transient surfaces, do they float on top of the
 345          fullscreen? what if there's already a fullscreen surface on
 346          the output, maybe you can only go fullscreen if you're
 347          active?  -->
 348     <request name="set_fullscreen"/>
 349
 350     <!-- Popup surfaces.  Will switch an implicit grab into
 351          owner-events mode, and grab will continue after the implicit
 352          grab ends (button released).  Once the implicit grab is over,
 353          the popup grab continues until the window is destroyed or a
 354          mouse button is pressed in any other clients window.  A click
 355          in any of the clients surfaces is reported as normal,
 356          however, clicks in other clients surfaces will be discarded
 357          and trigger the callback.
 358
 359          TODO: Grab keyboard too, maybe just terminate on any click
 360          inside or outside the surface?
 361     -->
 362     <request name="set_popup">
 363       <arg name="input_device" type="object" interface="wl_input_device"/>
 364       <arg name="time" type="uint"/>
 365       <arg name="parent" type="object" interface="wl_shell_surface"/>
 366       <arg name="x" type="int"/>
 367       <arg name="y" type="int"/>
 368       <arg name="flags" type="uint"/>
 369     </request>
 370
 371     <!-- The configure event asks the client to resize its surface.
 372          The size is a hint, in the sense that the client is free to
 373          ignore it if it doesn't resize, pick a smaller size (to
 374          satisfy aspect ration or resize in steps of NxM pixels).  The
 375          client is free to dismiss all but the last configure event it
 376          received. -->
 377     <event name="configure">
 378       <arg name="time" type="uint"/>
 379       <arg name="edges" type="uint"/>
 380       <arg name="width" type="int"/>
 381       <arg name="height" type="int"/>
 382     </event>
 383
 384     <!-- The popup_done event is sent out when a popup grab is broken,
 385          that is, when the users clicks a surface that doesn't belong
 386          to the client owning the popup surface. -->
 387     <event name="popup_done"/>
 388   </interface>
 389
 390
 391   <!-- A surface. This is an image that is displayed on the screen.
 392        It has a location, size and pixel contents. Similar to a window. -->
 393   <interface name="wl_surface" version="1">
 394     <!-- Deletes the surface and invalidates its object id. -->
 395     <request name="destroy" type="destructor"/>
 396
 397     <!-- Copy the contents of a buffer into this surface. The x and y
 398          arguments specify the location of the new buffers upper left
 399          corner, relative to the old buffers upper left corner. -->
 400     <request name="attach">
 401       <arg name="buffer" type="object" interface="wl_buffer"/>
 402       <arg name="x" type="int"/>
 403       <arg name="y" type="int"/>
 404     </request>
 405
 406     <!-- After attaching a new buffer, this request is used to
 407          describe the regions where the new buffer is different from
 408          the previous buffer and needs to be repainted.  Coordinates
 409          are relative to the new buffer. -->
 410     <request name="damage">
 411       <arg name="x" type="int"/>
 412       <arg name="y" type="int"/>
 413       <arg name="width" type="int"/>
 414       <arg name="height" type="int"/>
 415     </request>
 416
 417     <!-- Request notification when the next frame is displayed.
 418          Useful for throttling redrawing operations, and driving
 419          animations.  The notification will only be posted for one
 420          frame unless requested again. -->
 421     <request name="frame">
 422       <arg name="callback" type="new_id" interface="wl_callback"/>
 423     </request>
 424
 425   </interface>
 426
 427
 428   <!-- A group of keyboards and pointer devices (mice, for
 429        example). This object is published as a global during start up,
 430        or when such a device is hot plugged.  A input_device group
 431        typically has a pointer and maintains a keyboard_focus and a
 432        pointer_focus.  -->
 433   <interface name="wl_input_device" version="1">
 434     <!-- Set the pointer's image.  This request only takes effect if
 435          the pointer focus for this device is one of the requesting
 436          clients surfaces.  -->
 437     <request name="attach">
 438       <arg name="time" type="uint"/>
 439       <arg name="buffer" type="object" interface="wl_buffer"/>
 440       <arg name="hotspot_x" type="int"/>
 441       <arg name="hotspot_y" type="int"/>
 442     </request>
 443
 444     <!-- Notification of pointer location change.
 445          x,y are the absolute location on the screen.
 446          surface_[xy] are the location relative to the focused surface. -->
 447     <event name="motion">
 448       <arg name="time" type="uint"/>
 449       <arg name="x" type="int"/>
 450       <arg name="y" type="int"/>
 451       <arg name="surface_x" type="int"/>
 452       <arg name="surface_y" type="int"/>
 453     </event>
 454
 455     <!-- Mouse button click and release notifications.  The location
 456          of the click is given by the last motion or pointer_focus
 457          event. -->
 458     <event name="button">
 459       <arg name="time" type="uint"/>
 460       <arg name="button" type="uint"/>
 461       <arg name="state" type="uint"/>
 462     </event>
 463
 464     <!-- Keyboard press. -->
 465     <event name="key">
 466       <arg name="time" type="uint"/>
 467       <arg name="key" type="uint"/>
 468       <arg name="state" type="uint"/>
 469     </event>
 470
 471     <!-- Notification that this input device's pointer is focused on
 472          certain surface. When an input_device enters a surface, the
 473          pointer image is undefined and a client should respond to
 474          this event by setting an apropriate pointer image. -->
 475     <event name="pointer_focus">
 476       <arg name="time" type="uint"/>
 477       <arg name="surface" type="object" interface="wl_surface"/>
 478       <arg name="x" type="int"/>
 479       <arg name="y" type="int"/>
 480       <arg name="surface_x" type="int"/>
 481       <arg name="surface_y" type="int"/>
 482     </event>
 483
 484     <event name="keyboard_focus">
 485       <arg name="time" type="uint"/>
 486       <arg name="surface" type="object" interface="wl_surface"/>
 487       <arg name="keys" type="array"/>
 488     </event>
 489
 490     <event name="touch_down">
 491       <arg name="time" type="uint"/>
 492       <arg name="surface" type="object" interface="wl_surface"/>
 493       <arg name="id" type="int" />
 494       <arg name="x" type="int" />
 495       <arg name="y" type="int" />
 496     </event>
 497
 498     <event name="touch_up">
 499       <arg name="time" type="uint"/>
 500       <arg name="id" type="int" />
 501     </event>
 502
 503     <event name="touch_motion">
 504       <arg name="time" type="uint"/>
 505       <arg name="id" type="int" />
 506       <arg name="x" type="int" />
 507       <arg name="y" type="int" />
 508     </event>
 509
 510     <!-- Indicates the end of a contact point list. -->
 511     <event name="touch_frame"/>
 512
 513     <!-- Sent if the compositor decides the touch stream is a global
 514          gesture. No further events are sent to the clients from that
 515          particular gesture. -->
 516     <event name="touch_cancel"/>
 517   </interface>
 518
 519
 520   <!-- An output describes part of the compositor geometry.  The
 521        compositor work in the 'compositor coordinate system' and an
 522        output corresponds to rectangular area in that space that is
 523        actually visible.  This typically corresponds to a monitor that
 524        displays part of the compositor space.  This object is
 525        published as global during start up, or when a screen is hot
 526        plugged.  -->
 527   <interface name="wl_output" version="1">
 528
 529     <enum name="subpixel">
 530       <entry name="unknown" value="0"/>
 531       <entry name="none" value="1"/>
 532       <entry name="horizontal_rgb" value="2"/>
 533       <entry name="horizontal_bgr" value="3"/>
 534       <entry name="vertical_rgb" value="4"/>
 535       <entry name="vertical_bgr" value="5"/>
 536     </enum>
 537
 538     <event name="geometry">
 539       <arg name="x" type="int"/>
 540       <arg name="y" type="int"/>
 541       <arg name="physical_width" type="int"/>
 542       <arg name="physical_height" type="int"/>
 543       <arg name="subpixel" type="int"/>
 544       <arg name="make" type="string"/>
 545       <arg name="model" type="string"/>
 546     </event>
 547
 548     <!-- Values for the flags bitfield of the mode event. -->
 549     <enum name="mode">
 550       <entry name="current" value="0x1"/>
 551       <entry name="preferred" value="0x2"/>
 552     </enum>
 553
 554     <event name="mode">
 555       <arg name="flags" type="uint"/>
 556       <arg name="width" type="int"/>
 557       <arg name="height" type="int"/>
 558       <arg name="refresh" type="int"/>
 559     </event>
 560   </interface>
 561
 562 </protocol>