wayland.xml 45.3 KB
Newer Older
1
<?xml version="1.0" encoding="UTF-8"?>
2
<protocol name="wayland">
3

4
5
6
7
8
9
  <copyright>
    Copyright © 2008-2011 Kristian Høgsberg
    Copyright © 2010-2011 Intel Corporation

    Permission to use, copy, modify, distribute, and sell this
    software and its documentation for any purpose is hereby granted
Tiago Vignatti's avatar
Tiago Vignatti committed
10
    without fee, provided that the above copyright notice appear in
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
    all copies and that both that copyright notice and this permission
    notice appear in supporting documentation, and that the name of
    the copyright holders not be used in advertising or publicity
    pertaining to distribution of the software without specific,
    written prior permission.  The copyright holders make no
    representations about the suitability of this software for any
    purpose.  It is provided "as is" without express or implied
    warranty.

    THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
    SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
    FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
    SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
    AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
    ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
    THIS SOFTWARE.
  </copyright>

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
Tiago Vignatti's avatar
Tiago Vignatti committed
33
      is used for internal Wayland protocol features.
34
    </description>
35

36
    <request name="sync">
37
      <description summary="asynchronous roundtrip">
Tiago Vignatti's avatar
Tiago Vignatti committed
38
	The sync request asks the server to emit the 'done' event
39
40
41
42
	on the provided wl_callback object.  Since requests are
	handled in-order, this can be used as a barrier to ensure all
	previous requests have been handled.
      </description>
43
      <arg name="callback" type="new_id" interface="wl_callback"/>
44
45
    </request>

46
47
48
49
    <request name="get_registry">
      <arg name="callback" type="new_id" interface="wl_registry"/>
    </request>

Kristian Høgsberg's avatar
Kristian Høgsberg committed
50
    <event name="error">
51
52
53
54
      <description summary="fatal error event">
	The error event is sent out when a fatal (non-recoverable)
	error has occurred.
      </description>
55
      <arg name="object_id" type="object"/>
Kristian Høgsberg's avatar
Kristian Høgsberg committed
56
57
      <arg name="code" type="uint"/>
      <arg name="message" type="string"/>
58
59
    </event>

Kristian Høgsberg's avatar
Kristian Høgsberg committed
60
    <enum name="error">
61
62
63
64
65
66
67
68
69
70
      <description summary="global error values">
	These errors are global and can be emitted in response to any
	server request.
      </description>
      <entry name="invalid_object" value="0"
	     summary="server couldn't find object"/>
      <entry name="invalid_method" value="1"
	     summary="method doesn't exist on the specified interface"/>
      <entry name="no_memory" value="2"
	     summary="server is out of memory"/>
Kristian Høgsberg's avatar
Kristian Høgsberg committed
71
    </enum>
72

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
    <event name="delete_id">
      <description summary="acknowledge object id deletion">
	Server has deleted the id and client can now reuse it.
      </description>
      <arg name="id" type="uint" />
    </event>
  </interface>

  <interface name="wl_registry" version="1">
    <request name="bind">
      <description summary="bind an object to the display">
	Binds a new, client-created object to the server using @name as
	the identifier.
      </description>
      <arg name="name" type="uint" summary="unique number id for object"/>
      <arg name="id" type="new_id"/>
    </request>

91
    <event name="global">
92
93
94
95
96
97
98
99
100
101
      <description summary="announce global object">
	Notify the client of global objects.  These are objects that
	are created by the server.  Globals are published on the
	initial client connection sequence, upon device hotplugs,
	device disconnects, reconfiguration or other events.  A client
	can 'bind' to a global object by using the bind request.  This
	creates a client side handle that lets the object emit events
	to the client and lets the client invoke requests on the
	object.
      </description>
102
      <arg name="name" type="uint"/>
103
      <arg name="interface" type="string"/>
104
105
106
      <arg name="version" type="uint"/>
    </event>

Laszlo Agocs's avatar
Laszlo Agocs committed
107
    <event name="global_remove">
108
109
110
111
      <description summary="announce removal of global object">
	Notify the client of removed global objects.
      </description>
      <arg name="name" type="uint"/>
Laszlo Agocs's avatar
Laszlo Agocs committed
112
    </event>
113
  </interface>
114

115
116
  <interface name="wl_callback" version="1">
    <event name="done">
117
      <arg name="serial" type="uint"/>
118
119
120
    </event>
  </interface>

121
  <interface name="wl_compositor" version="1">
122
123
124
125
126
127
    <description summary="the compositor singleton">
      A compositor.  This object is a singleton global.  The
      compositor is in charge of combining the contents of multiple
      surfaces into one displayable output.
    </description>

128
    <request name="create_surface">
129
130
131
      <description summary="create new surface">
	Ask the compositor to create a new surface.
      </description>
132
      <arg name="id" type="new_id" interface="wl_surface"/>
133
    </request>
134
135
136
137
138
139
140

    <request name="create_region">
      <description summary="create new region">
	Ask the compositor to create a new region.
      </description>
      <arg name="id" type="new_id" interface="wl_region"/>
    </request>
141
142
  </interface>

143
144
145
  <interface name="wl_shm_pool" version="1">
    <description summary="a shared memory pool">
      The wl_shm_pool object encapsulates a piece of memory shared
Tiago Vignatti's avatar
Tiago Vignatti committed
146
      between the compositor and client.  Through the wl_shm_pool
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
      object, the client can allocate shared memory wl_buffer objects.
      The objects will share the same underlying mapped memory.
      Reusing the mapped memory avoids the setup/teardown overhead and
      is useful when interactively resizing a surface or for many
      small buffers.
    </description>

    <request name="create_buffer">
      <description summary="create wl_buffer from pool">
	Create a wl_buffer from the pool.  The buffer is created a
	offset bytes into the pool and has width and height as
	specified.  The stride arguments specifies the number of bytes
	from beginning of one row to the beginning of the next.  The
	format is the pixel format of the buffer and must be one of
	those advertised through the wl_shm.format event.

	A buffer will keep a reference to the pool it was created from
Tiago Vignatti's avatar
Tiago Vignatti committed
164
	so it is valid to destroy the pool immediately after creating
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
	a buffer from it.
      </description>

      <arg name="id" type="new_id" interface="wl_buffer"/>
      <arg name="offset" type="int"/>
      <arg name="width" type="int"/>
      <arg name="height" type="int"/>
      <arg name="stride" type="int"/>
      <arg name="format" type="uint"/>
    </request>

    <request name="destroy" type="destructor">
      <description summary="destroy the pool">
	Destroy the pool.
      </description>
    </request>
181
182
183
184
185
186
187
188
189
190

    <request name="resize">
      <description summary="change the size of the pool mapping">
	This request will cause the server to remap the backing memory
	for the pool from the fd passed when the pool was creating but
	using the new size.
      </description>

      <arg name="size" type="int"/>
    </request>
191
192
  </interface>

193
  <interface name="wl_shm" version="1">
194
195
196
197
    <description summary="shared memory support">
      Support for shared memory buffers.
    </description>

198
    <enum name="error">
199
      <entry name="invalid_format" value="0"/>
200
201
202
203
      <entry name="invalid_stride" value="1"/>
      <entry name="invalid_fd" value="2"/>
    </enum>

204
    <enum name="format">
205
206
      <entry name="argb8888" value="0"/>
      <entry name="xrgb8888" value="1"/>
207
208
    </enum>

209
210
211
212
213
214
    <request name="create_pool">
      <description summary="create a shm pool">
	This creates wl_shm_pool object, which can be used to create
	shared memory based wl_buffer objects.  The server will mmap
	size bytes of the passed fd, to use as backing memory for then
	pool.
215
216
      </description>

217
      <arg name="id" type="new_id" interface="wl_shm_pool"/>
218
      <arg name="fd" type="fd"/>
219
      <arg name="size" type="int"/>
220
    </request>
221
222
223
224

    <event name="format">
      <arg name="format" type="uint"/>
    </event>
225
226
  </interface>

227
  <interface name="wl_buffer" version="1">
228
229
230
231
    <description summary="content for a wl_surface">
      A buffer provides the content for a wl_surface.  Buffers are
      created through factory interfaces such as wl_drm, wl_shm or
      similar.  It has a width and a height and can be attached to a
Tiago Vignatti's avatar
Tiago Vignatti committed
232
      wl_surface, but the mechanism by which a client provides and
233
234
235
236
237
238
      updates the contents is defined by the buffer factory interface
    </description>

    <request name="destroy" type="destructor">
      <description summary="destroy a buffer">
	Destroy a buffer.  This will invalidate the object id.
239
240

	For possible side-effects to a surface, see wl_surface.attach.
241
242
      </description>
    </request>
Benjamin Franzke's avatar
Benjamin Franzke committed
243

244
    <event name="release">
Tiago Vignatti's avatar
Tiago Vignatti committed
245
      <description summary="compositor releases buffer">
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
	Sent when this wl_buffer is no longer used by the compositor.

	If a client does not get a release event before the frame callback
	requested in the same wl_surface.commit that attaches this wl_buffer
	to a surface, then the client may assume, that the compositor will
	be using this wl_buffer until the client attaches another wl_buffer.
	Therefore the client will need a second wl_buffer to update the
	surface contents again.

	Otherwise, if a release event arrives before the frame callback, the
	client is immediately free to re-use the buffer and its backing
	storage, and does not necessarily need a second buffer. Typically
	this is possible, when the compositor maintains a copy of the
	wl_surface contents, e.g. as a GL texture. This is an important
	optimization for GL(ES) compositors with wl_shm clients.
261
262
      </description>
    </event>
263
264
  </interface>

265
266
267

  <interface name="wl_data_offer" version="1">
    <request name="accept">
268
269
270
271
272
      <description summary="accept one of the offered mime-types">
	Indicate that the client can accept the given mime-type, or
	NULL for not accepted.  Use for feedback during drag and drop.
      </description>

273
      <arg name="serial" type="uint"/>
274
      <arg name="type" type="string" allow-null="true"/>
275
276
277
278
279
280
281
282
283
284
    </request>

    <request name="receive">
      <arg name="mime_type" type="string"/>
      <arg name="fd" type="fd"/>
    </request>

    <request name="destroy" type="destructor"/>

    <event name="offer">
285
286
287
288
289
      <description summary="advertise offered mime-type">
	Sent immediately after creating the wl_data_offer object.  One
	event per offered mime type.
      </description>

290
291
292
293
294
295
      <arg name="type" type="string"/>
    </event>
  </interface>

  <interface name="wl_data_source" version="1">
    <request name="offer">
296
297
298
299
300
      <description summary="add an offered mime type">
	This request adds a mime-type to the set of mime-types
	advertised to targets.  Can be called several times to offer
	multiple types.
      </description>
301
302
303
      <arg name="type" type="string"/>
    </request>

304
305
306
307
308
    <request name="destroy" type="destructor">
      <description summary="destroy the data source">
	Destroy the data source.
      </description>
    </request>
309
310

    <event name="target">
311
312
313
314
315
      <description summary="a target accepts an offered mime-type">
	Sent when a target accepts pointer_focus or motion events.  If
	a target does not accept any of the offered types, type is NULL.
      </description>

316
      <arg name="mime_type" type="string" allow-null="true"/>
317
318
319
    </event>

    <event name="send">
320
321
322
323
324
      <description summary="send the data">
	Request for data from another client.  Send the data as the
	specified mime-type over the passed fd, then close the fd.
      </description>

325
326
327
328
      <arg name="mime_type" type="string"/>
      <arg name="fd" type="fd"/>
    </event>

329
330
331
332
333
334
    <event name="cancelled">
      <description summary="selection was cancelled">
	Another selection became active.
      </description>
    </event>

335
336
337
338
  </interface>

  <interface name="wl_data_device" version="1">
    <request name="start_drag">
339
340
      <description summary="start drag and drop operation">
	This request asks the compositor to start a drag and drop
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
	operation on behalf of the client.

	The source argument is the data source that provides the data
	for the eventual data transfer. If source is NULL, enter, leave
	and motion events are sent only to the client that initiated the
	drag and the client is expected to handle the data passing
	internally.

	The origin surface is the surface where the drag originates and
	the client must have an active implicit grab that matches the
	serial.

	The icon surface is an optional (can be nil) surface that
	provides an icon to be moved around with the cursor.  Initially,
	the top-left corner of the icon surface is placed at the cursor
356
357
358
359
	hotspot, but subsequent wl_surface.attach request can move the
	relative position. Attach requests must be confirmed with
	wl_surface.commit as usual.

360
	The current and pending input regions of the icon wl_surface are
361
	cleared, and wl_surface.set_input_region is ignored until the
362
363
364
	wl_surface is no longer used as the icon surface. When the use
	as an icon ends, the the current and pending input regions
	become undefined, and the wl_surface is unmapped.
365
      </description>
366
      <arg name="source" type="object" interface="wl_data_source" allow-null="true"/>
367
      <arg name="origin" type="object" interface="wl_surface"/>
368
      <arg name="icon" type="object" interface="wl_surface" allow-null="true"/>
369
      <arg name="serial" type="uint"/>
370
371
372
    </request>

    <request name="set_selection">
373
      <arg name="source" type="object" interface="wl_data_source" allow-null="true"/>
374
      <arg name="serial" type="uint"/>
375
376
377
    </request>

    <event name="data_offer">
378
379
380
381
382
383
384
385
386
387
      <description summary="introduce a new wl_data_offer">
	The data_offer event introduces a new wl_data_offer object,
	which will subsequently be used in either the
	data_device.enter event (for drag and drop) or the
	data_device.selection event (for selections).  Immediately
	following the data_device_data_offer event, the new data_offer
	object will send out data_offer.offer events to describe the
	mime-types it offers.
      </description>

388
389
390
391
      <arg name="id" type="new_id" interface="wl_data_offer"/>
    </event>

    <event name="enter">
392
      <arg name="serial" type="uint"/>
393
      <arg name="surface" type="object" interface="wl_surface"/>
394
395
      <arg name="x" type="fixed"/>
      <arg name="y" type="fixed"/>
396
      <arg name="id" type="object" interface="wl_data_offer" allow-null="true"/>
397
398
399
400
401
402
    </event>

    <event name="leave"/>

    <event name="motion">
      <arg name="time" type="uint"/>
403
404
      <arg name="x" type="fixed"/>
      <arg name="y" type="fixed"/>
405
406
407
408
409
    </event>

    <event name="drop"/>

    <event name="selection">
410
411
412
413
414
415
416
417
418
419
420
      <description summary="advertise new selection">
	The selection event is sent out to notify the client of a new
	wl_data_offer for the selection for this device.  The
	data_device.data_offer and the data_offer.offer events are
	sent out immediately before this event to introduce the data
	offer object.  The selection event is sent to a client
	immediately before receiving keyboard focus and when a new
	selection is set while the client has keyboard focus.  The
	data_offer is valid until a new data_offer or NULL is received
	or until the client loses keyboard focus.
      </description>
421
      <arg name="id" type="object" interface="wl_data_offer" allow-null="true"/>
422
423
424
425
426
427
428
429
430
431
    </event>
  </interface>

  <interface name="wl_data_device_manager" version="1">
    <request name="create_data_source">
      <arg name="id" type="new_id" interface="wl_data_source"/>
    </request>

    <request name="get_data_device">
      <arg name="id" type="new_id" interface="wl_data_device"/>
432
      <arg name="seat" type="object" interface="wl_seat"/>
433
434
435
    </request>
  </interface>

436
  <interface name="wl_shell" version="1">
437
438
    <request name="get_shell_surface">
      <arg name="id" type="new_id" interface="wl_shell_surface"/>
439
      <arg name="surface" type="object" interface="wl_surface"/>
440
441
442
443
    </request>
  </interface>

  <interface name="wl_shell_surface" version="1">
444
445
446
447
448
449
450
451

    <description summary="desktop style meta data interface">
      An interface implemented by a wl_surface.  On server side the
      object is automatically destroyed when the related wl_surface is
      destroyed.  On client side, wl_shell_surface_destroy() must be
      called before destroying the wl_surface object.
    </description>

452
453
454
455
456
457
458
459
    <request name="pong">
      <description summary="respond to a ping event">
	A client must respond to a ping event with a pong request or
	the client may be deemed unresponsive.
      </description>
      <arg name="serial" type="uint"/>
    </request>

460
    <request name="move">
461
      <arg name="seat" type="object" interface="wl_seat"/>
462
      <arg name="serial" type="uint"/>
463
464
    </request>

465
466
467
468
469
470
471
472
473
474
475
476
    <enum name="resize">
      <entry name="none" value="0"/>
      <entry name="top" value="1"/>
      <entry name="bottom" value="2"/>
      <entry name="left" value="4"/>
      <entry name="top_left" value="5"/>
      <entry name="bottom_left" value="6"/>
      <entry name="right" value="8"/>
      <entry name="top_right" value="9"/>
      <entry name="bottom_right" value="10"/>
    </enum>

477
    <request name="resize">
478
      <arg name="seat" type="object" interface="wl_seat"/>
479
      <arg name="serial" type="uint"/>
480
481
482
      <arg name="edges" type="uint"/>
    </request>

483
484
485
486
487
488
    <request name="set_toplevel">
      <description summary="make the surface a top level surface">
	Make the surface a toplevel window.
      </description>
    </request>

489
490
491
492
    <enum name="transient">
      <entry name="inactive" value="0x1" summary="do not set keyboard focus"/>
    </enum>

493
    <request name="set_transient">
494
495
496
497
498
499
500
501
502
503
504
      <description summary="make the surface a transient surface">
	Map the surface relative to an existing surface. The x and y
	arguments specify the locations of the upper left corner of
	the surface relative to the upper left corner of the parent
	surface.  The flags argument controls overflow/clipping
	behaviour when the surface would intersect a screen edge,
	panel or such.  And possibly whether the offset only
	determines the initial position or if the surface is locked to
	that relative position during moves.
      </description>

505
      <arg name="parent" type="object" interface="wl_surface"/>
506
507
508
509
510
      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
      <arg name="flags" type="uint"/>
    </request>

511
512
    <request name="set_fullscreen">
      <description summary="make the surface a fullscreen surface">
513
514
515
516
517
518
519
520
521
522
523
524
        Map the surface as a fullscreen surface. If an output parameter is
        given then the surface will be made fullscreen on that output. If the
        client does not specify the output then the compositor will apply its
        policy - usually choosing the output on which the surface has the
        biggest surface area.

        The client may specify a method to resolve a size conflict between the
        output size and the surface size - this is provided through the
        fullscreen_method parameter.

        The framerate parameter is used only when the fullscreen_method is set
        to "driver", to indicate the preferred framerate. framerate=0 indicates
525
526
        that the app does not care about framerate.  The framerate is
        specified in mHz, that is framerate of 60000 is 60Hz.
527
528
529

        The compositor must reply to this request with a configure event with
        the dimensions for the output on which the surface will be made fullscreen.
530
      </description>
Juan Zhao's avatar
Juan Zhao committed
531
532
      <arg name="method" type="uint"/>
      <arg name="framerate" type="uint"/>
533
      <arg name="output" type="object" interface="wl_output" allow-null="true"/>
534
535
    </request>

Juan Zhao's avatar
Juan Zhao committed
536
537
    <enum name="fullscreen_method">
      <description summary="different method to set the surface fullscreen">
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
        Hints to indicate compositor how to deal with a conflict between the
        dimensions for the surface and the dimensions of the output. As a hint
        the compositor is free to ignore this parameter.

        "default" The client has no preference on fullscreen behavior,
        policies are determined by compositor.

        "scale" The client prefers scaling by the compositor. Scaling would
        always preserve surface's aspect ratio with surface centered on the
        output

        "driver" The client wants to switch video mode to the smallest mode
        that can fit the client buffer. If the sizes do not match the
        compositor must add black borders.

        "fill" The surface is centered on the output on the screen with no
        scaling. If the surface is of insufficient size the compositor must
        add black borders.
Juan Zhao's avatar
Juan Zhao committed
556
557
558
559
560
561
562
      </description>
      <entry name="default" value="0"/>
      <entry name="scale" value="1"/>
      <entry name="driver" value="2"/>
      <entry name="fill" value="3"/>
    </enum>

563
    <request name="set_popup">
564
565
566
567
568
569
570
571
572
573
574
575
576
577
      <description summary="make the surface a popup surface">
	Popup surfaces.  Will switch an implicit grab into
	owner-events mode, and grab will continue after the implicit
	grab ends (button released).  Once the implicit grab is over,
	the popup grab continues until the window is destroyed or a
	mouse button is pressed in any other clients window.  A click
	in any of the clients surfaces is reported as normal, however,
	clicks in other clients surfaces will be discarded and trigger
	the callback.

	TODO: Grab keyboard too, maybe just terminate on any click
	inside or outside the surface?
      </description>

578
      <arg name="seat" type="object" interface="wl_seat"/>
579
      <arg name="serial" type="uint"/>
580
      <arg name="parent" type="object" interface="wl_surface"/>
581
582
583
584
585
      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
      <arg name="flags" type="uint"/>
    </request>

Juan Zhao's avatar
Juan Zhao committed
586
587
588
589
590
591
592
593
594
595
    <request name="set_maximized">
      <description summary="make the surface a maximized surface">
	A request from the client to notify the compositor the maximized
	operation. The compositor will reply with a configure event telling
        the expected new surface size. The operation is completed on the
        next buffer attach to this surface.
        A maximized client will fill the fullscreen of the output it is bound
        to, except the panel area. This is the main difference between
        a maximized shell surface and a fullscreen shell surface.
      </description>
596
      <arg name="output" type="object" interface="wl_output" allow-null="true"/>
Juan Zhao's avatar
Juan Zhao committed
597
598
    </request>

599
600
601
602
603
604
605
606
607
608
609
610
611
    <request name="set_title">
      <description summary="set surface title">
      </description>
      <arg name="title" type="string"/>
    </request>

    <request name="set_class">
      <description summary="set surface class">
	The surface class identifies the general class of applications
	to which the surface belongs.  The class is the file name of
	the applications .desktop file (absolute path if non-standard
	location). 
      </description>
612
      <arg name="class_" type="string"/>
613
614
    </request>

615
616
617
618
619
620
621
622
    <event name="ping">
      <description summary="ping client">
	Ping a client to check if it is receiving events and sending
	requests. A client is expected to reply with a pong request.
      </description>
      <arg name="serial" type="uint"/>
    </event>

623
    <event name="configure">
624
625
626
627
      <description summary="suggest resize">
	The configure event asks the client to resize its surface.
	The size is a hint, in the sense that the client is free to
	ignore it if it doesn't resize, pick a smaller size (to
Diego Viola's avatar
Diego Viola committed
628
	satisfy aspect ratio or resize in steps of NxM pixels).  The
629
630
631
632
	client is free to dismiss all but the last configure event it
	received.
      </description>

633
      <arg name="edges" type="uint"/>
634
635
636
      <arg name="width" type="int"/>
      <arg name="height" type="int"/>
    </event>
637

638
639
640
641
642
643
644
    <event name="popup_done">
      <description summary="popup interaction is done">
	The popup_done event is sent out when a popup grab is broken,
	that is, when the users clicks a surface that doesn't belong
	to the client owning the popup surface.
      </description>
    </event>
645
  </interface>
646

647
  <interface name="wl_surface" version="1">
648
649
650
651
652
653
654
655
656
657
    <description summary="an onscreen surface">
      A surface.  This is an image that is displayed on the screen.
      It has a location, size and pixel contents.
    </description>

    <request name="destroy" type="destructor">
      <description summary="delete surface">
	Deletes the surface and invalidates its object id.
      </description>
    </request>
658
659

    <request name="attach">
660
      <description summary="set the surface contents">
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
	Set the contents of a buffer into this surface. The x and y
	arguments specify the location of the new pending buffer's upper
	left corner, relative to the current buffer's upper left corner. In
	other words, the x and y, and the width and height of the wl_buffer
	together define in which directions the surface's size changes.

	Surface contents are double-buffered state, see wl_surface.commit.

	The initial surface contents are void; there is no content.
	wl_surface.attach assigns the given wl_buffer as the pending wl_buffer.
	wl_surface.commit applies the pending wl_buffer as the new
	surface contents, and the size of the surface becomes the size of
	the wl_buffer. The wl_buffer is also kept as pending, until
	changed by wl_surface.attach or the wl_buffer is destroyed.

	Committing a pending wl_buffer allows the compositor to read the
	pixels in the wl_buffer. The compositor may access the pixels at any
	time after the wl_surface.commit request. When the compositor will
	not access the pixels anymore, it will send the wl_buffer.release
	event. Only after receiving wl_buffer.release, the client may re-use
681
682
683
	the wl_buffer. A wl_buffer, that has been attached and then replaced
	by another attach instead of committed, will not receive a release
	event, and is not used by the compositor.
684
685
686
687
688
689
690
691
692
693

	Destroying the wl_buffer after wl_buffer.release does not change the
	surface contents, even if the wl_buffer is still pending for the
	next commit. In such case, the next commit does not change the
	surface contents. However, if the client destroys the wl_buffer
	before receiving wl_buffer.release, the surface contents become
	undefined immediately.

	Only if wl_surface.attach is sent with a nil wl_buffer, the
	following wl_surface.commit will remove the surface content.
694
695
      </description>

696
      <arg name="buffer" type="object" interface="wl_buffer" allow-null="true"/>
697
698
699
700
701
      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
    </request>

    <request name="damage">
702
      <description summary="mark part of the surface damaged">
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
	This request is used to describe the regions where the pending
	buffer (or if pending buffer is none, the current buffer as updated
	in-place) on the next wl_surface.commit will be different from the
	current buffer, and needs to be repainted. The pending buffer can be
	set by wl_surface.attach. The compositor ignores the parts of the
	damage that fall outside of the surface.

	Damage is double-buffered state, see wl_surface.commit.

	The initial value for pending damage is empty: no damage.
	wl_surface.damage adds pending damage: the new pending damage is the
	union of old pending damage and the given rectangle.
	wl_surface.commit assigns pending damage as the current damage, and
	clears pending damage. The server will clear the current damage as
	it repaints the surface.
718
719
      </description>

720
721
722
723
724
      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
      <arg name="width" type="int"/>
      <arg name="height" type="int"/>
    </request>
725
726

    <request name="frame">
727
      <description summary="request repaint feedback">
728
	Request notification when the next frame is displayed. Useful
729
	for throttling redrawing operations, and driving animations.
730
	The frame request will take effect on the next wl_surface.commit.
731
732
	The notification will only be posted for one frame unless
	requested again.
733
734
735
736
737
738
739
740
741

	A server should avoid signalling the frame callbacks if the
	surface is not visible in any way, e.g. the surface is off-screen,
	or completely obscured by other opaque surfaces.

	A client can request a frame callback even without an attach,
	damage, or any other state changes. wl_surface.commit triggers a
	repaint, so the callback event will arrive after the next output
	refresh where the surface is visible.
742
743
      </description>

744
745
746
      <arg name="callback" type="new_id" interface="wl_callback"/>
    </request>

747
748
    <request name="set_opaque_region">
      <description summary="set opaque region">
749
	This request sets the region of the surface that contains
750
751
752
753
754
	opaque content.  The opaque region is an optimization hint for
	the compositor that lets it optimize out redrawing of content
	behind opaque regions.  Setting an opaque region is not
	required for correct behaviour, but marking transparent
	content as opaque will result in repaint artifacts.
755
756
757
758
759
760
761
762
	The compositor ignores the parts of the opaque region that fall
	outside of the surface.

	Opaque region is double-buffered state, see wl_surface.commit.

	wl_surface.set_opaque_region changes the pending opaque region.
	wl_surface.commit copies the pending region to the current region.
	Otherwise the pending and current regions are never changed.
763

764
765
766
767
	The initial value for opaque region is empty. Setting the pending
	opaque region has copy semantics, and the wl_region object can be
	destroyed immediately. A nil wl_region causes the pending opaque
	region to be set to empty.
768
769
      </description>

770
      <arg name="region" type="object" interface="wl_region" allow-null="true"/>
771
772
773
774
    </request>

    <request name="set_input_region">
      <description summary="set input region">
775
776
777
778
779
780
781
782
783
784
	This request sets the region of the surface that can receive
	pointer and touch events. Input events happening outside of
	this region will try the next surface in the server surface
	stack. The compositor ignores the parts of the input region that
	fall outside of the surface.

	Input region is double-buffered state, see wl_surface.commit.

	wl_surface.set_input_region changes the pending input region.
	wl_surface.commit copies the pending region to the current region.
785
786
787
	Otherwise the pending and current regions are never changed,
	except cursor and icon surfaces are special cases, see
	wl_pointer.set_cursor and wl_data_device.start_drag.
788
789
790
791
792

	The initial value for input region is infinite. That means the whole
	surface will accept input. Setting the pending input region has copy
	semantics, and the wl_region object can be destroyed immediately. A
	nil wl_region causes the input region to be set to infinite.
793
794
      </description>

795
      <arg name="region" type="object" interface="wl_region" allow-null="true"/>
796
    </request>
797

798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
    <request name="commit">
      <description summary="commit pending surface state">
	Surface state (input, opaque, and damage regions, attached buffers,
	etc.) is double-buffered. Protocol requests modify the pending
	state, as opposed to current state in use by the compositor. Commit
	request atomically applies all pending state, replacing the current
	state. After commit, the new pending state is as documented for each
	related request.

	On commit, a pending wl_buffer is applied first, all other state
	second. This means that all coordinates in double-buffered state are
	relative to the new wl_buffer coming into use, except for
	wl_surface.attach itself. If the pending wl_buffer is none, the
	coordinates are relative to the current surface contents.

	All requests that need a commit to become effective are documented
	to affect double-buffered state.

	Other interfaces may add further double-buffered surface state.
      </description>
    </request>

820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
    <event name="enter">
      <description summary="surface enters an output">
        This is emitted whenever a surface's creation, movement, or resizing
        results in some part of it being within the scanout region of an
        output.
      </description>
      <arg name="output" type="object" interface="wl_output"/>
    </event>

    <event name="leave">
      <description summary="surface leaves an output">
        This is emitted whenever a surface's creation, movement, or resizing
        results in it no longer having any part of it within the scanout region
        of an output.
      </description>
      <arg name="output" type="object" interface="wl_output"/>
    </event>
837
838
  </interface>

839
840
841
842
843
844
  <interface name="wl_seat" version="1">
    <description summary="seat">
      A group of keyboards, pointer (mice, for example) and touch
      devices . This object is published as a global during start up,
      or when such a device is hot plugged.  A seat typically has a
      pointer and maintains a keyboard_focus and a pointer_focus.
845
846
    </description>

847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
    <enum name="capability">
      <description summary="seat capability bitmask">
        This is a bitmask of capabilities this seat has; if a member is
	set, then it is present on the seat.
      </description>
      <entry name="pointer" value="1" summary="wl_pointer"/>
      <entry name="keyboard" value="2" summary="wl_keyboard"/>
      <entry name="touch" value="4" summary="wl_touch"/>
    </enum>


    <event name="capabilities">
      <description summary="seat capabilities changed">
        This is emitted whenever a seat gains or loses the pointer,
	keyboard or touch capabilities.  The argument is a wl_seat_caps_mask
	enum containing the complete set of capabilities this seat has.
      </description>
      <arg name="capabilities" type="uint"/>
    </event>

    <request name="get_pointer">
      <description summary="return pointer object">
        The ID provided will be initialized to the wl_pointer interface
	for this seat.
      </description>
      <arg name="id" type="new_id" interface="wl_pointer"/>
    </request>

    <request name="get_keyboard">
      <description summary="return pointer object">
        The ID provided will be initialized to the wl_keyboard interface
	for this seat.
      </description>
      <arg name="id" type="new_id" interface="wl_keyboard"/>
    </request>

    <request name="get_touch">
      <description summary="return pointer object">
        The ID provided will be initialized to the wl_touch interface
	for this seat.
      </description>
      <arg name="id" type="new_id" interface="wl_touch"/>
    </request>
  </interface>

  <interface name="wl_pointer" version="1">
893
894
895
    <request name="set_cursor">
      <description summary="set the pointer surface">
	Set the pointer surface, i.e., the surface that contains the
896
897
	pointer image (cursor). This request only takes effect if the pointer
	focus for this device is one of the requesting client's surfaces
898
899
	or the surface parameter is the current pointer surface. If
	there was a previous surface set with this request it is
900
901
902
903
904
905
906
907
908
	replaced. If surface is NULL, the pointer image is hidden.

	The parameters hotspot_x and hotspot_y define the position of
	the pointer surface relative to the pointer location. Its
	top-left corner is always at (x, y) - (hotspot_x, hotspot_y),
	where (x, y) are the coordinates of the pointer location.

	On surface.attach requests to the pointer surface, hotspot_x
	and hotspot_y are decremented by the x and y parameters
909
910
	passed to the request. Attach must be confirmed by
	wl_surface.commit as usual.
911

912
	The hotspot can also be updated by passing the currently set
913
	pointer surface to this request with new values for hotspot_x
914
	and hotspot_y.
915
916
917

	The current and pending input regions of the wl_surface are
	cleared, and wl_surface.set_input_region is ignored until the
918
919
920
	wl_surface is no longer used as the cursor. When the use as a
	cursor ends, the current and pending input regions become
	undefined, and the wl_surface is unmapped.
921
922
      </description>

923
      <arg name="serial" type="uint"/>
924
      <arg name="surface" type="object" interface="wl_surface" allow-null="true"/>
925
926
927
928
      <arg name="hotspot_x" type="int"/>
      <arg name="hotspot_y" type="int"/>
    </request>

929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
    <event name="enter">
      <description summary="enter event">
	Notification that this seat's pointer is focused on a certain
	surface. When an seat's focus enters a surface, the pointer image
	is undefined and a client should respond to this event by setting
	an appropriate pointer image.
      </description>

      <arg name="serial" type="uint"/>
      <arg name="surface" type="object" interface="wl_surface"/>
      <arg name="surface_x" type="fixed"/>
      <arg name="surface_y" type="fixed"/>
    </event>

    <event name="leave">
      <description summary="leave event">
      </description>
      <arg name="serial" type="uint"/>
      <arg name="surface" type="object" interface="wl_surface"/>
    </event>

950
    <event name="motion">
951
      <description summary="pointer motion event">
952
953
	Notification of pointer location change. The arguments surface_[xy]
	are the location relative to the focused surface.
954
955
      </description>

956
      <arg name="time" type="uint"/>
957
958
      <arg name="surface_x" type="fixed"/>
      <arg name="surface_y" type="fixed"/>
959
960
    </event>

961
962
963
964
965
966
967
968
969
    <enum name="button_state">
      <description summary="physical button state">
        Describes the physical state of a button which provoked the button
	event.
      </description>
      <entry name="released" value="0" summary="button is not pressed"/>
      <entry name="pressed" value="1" summary="button is pressed"/>
    </enum>

970
    <event name="button">
971
972
973
974
975
      <description summary="pointer button event">
	Mouse button click and release notifications.  The location
	of the click is given by the last motion or pointer_focus event.
      </description>

976
      <arg name="serial" type="uint"/>
977
978
979
980
981
      <arg name="time" type="uint"/>
      <arg name="button" type="uint"/>
      <arg name="state" type="uint"/>
    </event>

Scott Moreau's avatar
Scott Moreau committed
982
983
984
985
986
987
988
989
990
991
992
993
994
    <enum name="axis">
      <description summary="axis types"/>
      <entry name="vertical_scroll" value="0"/>
      <entry name="horizontal_scroll" value="1"/>
    </enum>

    <event name="axis">
      <description summary="axis event">
	Scroll and other axis notifications.
      </description>

      <arg name="time" type="uint"/>
      <arg name="axis" type="uint"/>
995
      <arg name="value" type="fixed"/>
Scott Moreau's avatar
Scott Moreau committed
996
    </event>
997
  </interface>
Scott Moreau's avatar
Scott Moreau committed
998

999
1000
1001
  <interface name="wl_keyboard" version="1">
    <description summary="keyboard input device">
    </description>
1002

Daniel Stone's avatar
Daniel Stone committed
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
    <enum name="keymap_format">
      <description summary="keyboard mapping format">
        This enum specifies the format of the keymap provided to the client
	with the wl_keyboard::keymap event.
      </description>
      <entry name="xkb_v1" value="1" description="libxkbcommon compatible"/>
    </enum>

    <event name="keymap">
      <description summary="keyboard mapping">
        This event provides a file descriptor to the client which can be
	memory-mapped to provide a keyboard mapping description.
      </description>
      <arg name="format" type="uint"/>
      <arg name="fd" type="fd"/>
      <arg name="size" type="uint"/>
    </event>

1021
    <event name="enter">
1022
      <arg name="serial" type="uint"/>
1023
1024
      <arg name="surface" type="object" interface="wl_surface"/>
      <arg name="keys" type="array"/>
1025
1026
    </event>

1027
    <event name="leave">
1028
      <arg name="serial" type="uint"/>
1029
      <arg name="surface" type="object" interface="wl_surface"/>
1030
1031
    </event>

1032
1033
1034
1035
1036
1037
1038
1039
    <enum name="key_state">
      <description summary="physical key state">
        Describes the physical state of a key which provoked the key event.
      </description>
      <entry name="released" value="0" summary="key is not pressed"/>
      <entry name="pressed" value="1" summary="key is pressed"/>
    </enum>

1040
1041
1042
    <event name="key">
      <description summary="key event">
	A key was pressed or released.
1043
1044
      </description>

1045
      <arg name="serial" type="uint"/>
1046
1047
1048
      <arg name="time" type="uint"/>
      <arg name="key" type="uint"/>
      <arg name="state" type="uint"/>
1049
    </event>
Daniel Stone's avatar
Daniel Stone committed
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062

    <event name="modifiers">
      <description summary="modifier and group state">
        Notifies clients that the modifier and/or group state has
	changed, and it should update its local state.
      </description>

      <arg name="serial" type="uint"/>
      <arg name="mods_depressed" type="uint"/>
      <arg name="mods_latched" type="uint"/>
      <arg name="mods_locked" type="uint"/>
      <arg name="group" type="uint"/>
    </event>
1063
  </interface>
Laszlo Agocs's avatar
Laszlo Agocs committed
1064

1065
1066
1067
  <interface name="wl_touch" version="1">
    <description summary="touch screen input device">
    </description>
1068

1069
    <event name="down">
1070
      <arg name="serial" type="uint"/>
Laszlo Agocs's avatar
Laszlo Agocs committed
1071
      <arg name="time" type="uint"/>
1072
      <arg name="surface" type="object" interface="wl_surface"/>
Laszlo Agocs's avatar
Laszlo Agocs committed
1073
      <arg name="id" type="int" />
1074
1075
      <arg name="x" type="fixed" />
      <arg name="y" type="fixed" />
Laszlo Agocs's avatar
Laszlo Agocs committed
1076
1077
    </event>

1078
    <event name="up">
1079
      <arg name="serial" type="uint"/>
Laszlo Agocs's avatar
Laszlo Agocs committed
1080
1081
1082
1083
      <arg name="time" type="uint"/>
      <arg name="id" type="int" />
    </event>

1084
    <event name="motion">
Laszlo Agocs's avatar
Laszlo Agocs committed
1085
1086
      <arg name="time" type="uint"/>
      <arg name="id" type="int" />
1087
1088
      <arg name="x" type="fixed" />
      <arg name="y" type="fixed" />
Laszlo Agocs's avatar
Laszlo Agocs committed
1089
1090
    </event>

1091
    <event name="frame">
1092
1093
1094
1095
      <description summary="end of touch frame event">
	Indicates the end of a contact point list.
      </description>
    </event>
Laszlo Agocs's avatar
Laszlo Agocs committed
1096

1097
    <event name="cancel">
1098
1099
1100
1101
1102
1103
      <description summary="touch session cancelled">
	Sent if the compositor decides the touch stream is a global
	gesture. No further events are sent to the clients from that
	particular gesture.
      </description>
    </event>
1104
1105
  </interface>

1106

1107
  <interface name="wl_output" version="1">
Tiago Vignatti's avatar
Tiago Vignatti committed
1108
    <description summary="compositor output region">
1109
1110
1111
1112
1113
1114
1115
      An output describes part of the compositor geometry.  The
      compositor work in the 'compositor coordinate system' and an
      output corresponds to rectangular area in that space that is
      actually visible.  This typically corresponds to a monitor that
      displays part of the compositor space.  This object is published
      as global during start up, or when a screen is hot plugged.
    </description>
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125

    <enum name="subpixel">
      <entry name="unknown" value="0"/>
      <entry name="none" value="1"/>
      <entry name="horizontal_rgb" value="2"/>
      <entry name="horizontal_bgr" value="3"/>
      <entry name="vertical_rgb" value="4"/>
      <entry name="vertical_bgr" value="5"/>
    </enum>

1126
1127
1128
1129
1130
1131
1132
    <enum name="transform">
      <description summary="transform from framebuffer to output">
	This describes the transform that a compositor will apply to a
	surface to compensate for the rotation or mirroring of an
	output device.

	The flipped values correspond to an initial flip around a
Scott Moreau's avatar
Scott Moreau committed
1133
	vertical axis followed by rotation.
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150

	The purpose is mainly to allow clients render accordingly and
	tell the compositor, so that for fullscreen surfaces, the
	compositor will still be able to scan out directly from client
	surfaces.
      </description>

      <entry name="normal" value="0"/>
      <entry name="90" value="1"/>
      <entry name="180" value="2"/>
      <entry name="270" value="3"/>
      <entry name="flipped" value="4"/>
      <entry name="flipped_90" value="5"/>
      <entry name="flipped_180" value="6"/>
      <entry name="flipped_270" value="7"/>
    </enum>

1151
    <event name="geometry">
1152
1153
1154
1155
1156
1157
      <description summary="properties of the output"/>
      <arg name="x" type="int"
	   summary="x position within the global compositor space"/>
      <arg name="y" type="int"
	   summary="y position within the global compositor space"/>
      <arg name="physical_width" type="int"
1158
	   summary="width in millimeters of the output"/>
1159
      <arg name="physical_height" type="int"
1160
	   summary="height in millimeters of the output"/>
1161
1162
1163
1164
1165
1166
      <arg name="subpixel" type="int"
	   summary="subpixel orientation of the output"/>
      <arg name="make" type="string"
	   summary="textual description of the manufacturer"/>
      <arg name="model" type="string"
	   summary="textual description of the model"/>
1167
1168
      <arg name="transform" type="int"
	   summary="transform that maps framebuffer to output"/>
1169
1170
1171
    </event>

    <enum name="mode">
1172
      <description summary="values for the flags bitfield in the mode event"/>
1173
1174
1175
1176
      <entry name="current" value="0x1"
	     summary="indicates this is the current mode"/>
      <entry name="preferred" value="0x2"
	     summary="indicates this is the preferred mode"/>
1177
1178
1179
    </enum>
      
    <event name="mode">
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
      <description summary="advertise available modes for the output">
	The mode event describes an available mode for the output.
	The event is sent when binding to the output object and there
	will always be one mode, the current mode.  The event is sent
	again if an output changes mode, for the mode that is now
	current.  In other words, the current mode is always the last
	mode that was received with the current flag set.
      </description>
      <arg name="flags" type="uint" summary="mask of wl_output_mode flags"/>
      <arg name="width" type="int" summary="width of the mode in pixels"/>
      <arg name="height" type="int" summary="height of the mode in pixels"/>
      <arg name="refresh" type="int" summary="vertical refresh rate in mHz"/>
1192
1193
1194
    </event>
  </interface>

1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
  <interface name="wl_region" version="1">
    <description summary="region interface">
      Region.
    </description>

    <request name="destroy" type="destructor">
      <description summary="destroy region">
	Destroy the region.  This will invalidate the object id.
      </description>
    </request>

    <request name="add">
      <description summary="add rectangle to region">
	Add the specified rectangle to the region
      </description>

      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
      <arg name="width" type="int"/>
      <arg name="height" type="int"/>
    </request>

    <request name="subtract">
      <description summary="subtract rectangle from region">
	Subtract the specified rectangle from the region
      </description>

      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
      <arg name="width" type="int"/>
      <arg name="height" type="int"/>
    </request>

  </interface>

1230
</protocol>