wayland.xml 33.6 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
33
      The core global object.  This is a special singleton object.  It
      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
42
      <arg name="interface" type="string"/>
      <arg name="version" type="uint"/>
43
      <arg name="id" type="new_id" interface="wl_object"/>
44
45
    </request>

46
    <request name="sync">
47
48
49
50
51
52
      <description summary="asynchronous roundtrip">
	The sync request asks the server to invoke the 'done' request
	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>
53
      <arg name="callback" type="new_id" interface="wl_callback"/>
54
55
    </request>

Kristian Høgsberg's avatar
Kristian Høgsberg committed
56
    <event name="error">
57
58
59
60
      <description summary="fatal error event">
	The error event is sent out when a fatal (non-recoverable)
	error has occurred.
      </description>
Kristian Høgsberg's avatar
Kristian Høgsberg committed
61
62
63
      <arg name="object_id" type="object" interface="wl_object"/>
      <arg name="code" type="uint"/>
      <arg name="message" type="string"/>
64
65
    </event>

Kristian Høgsberg's avatar
Kristian Høgsberg committed
66
    <enum name="error">
67
68
69
70
71
72
73
74
75
76
      <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
77
    </enum>
78
79

    <event name="global">
80
81
82
83
84
85
86
87
88
89
      <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>
90
      <arg name="name" type="uint"/>
91
      <arg name="interface" type="string"/>
92
93
94
      <arg name="version" type="uint"/>
    </event>

Laszlo Agocs's avatar
Laszlo Agocs committed
95
    <event name="global_remove">
96
97
98
99
      <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
100
101
    </event>

102
    <event name="delete_id">
103
104
105
      <description summary="acknowledge object id deletion">
	Server has deleted the id and client can now reuse it.
      </description>
106
107
      <arg name="id" type="uint" />
    </event>
108
  </interface>
109

110
111
  <interface name="wl_callback" version="1">
    <event name="done">
112
      <arg name="serial" type="uint"/>
113
114
115
    </event>
  </interface>

116
  <interface name="wl_compositor" version="1">
117
118
119
120
121
122
    <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>

123
    <request name="create_surface">
124
125
126
      <description summary="create new surface">
	Ask the compositor to create a new surface.
      </description>
127
      <arg name="id" type="new_id" interface="wl_surface"/>
128
    </request>
129
130
131
132
133
134
135

    <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>
136
137
  </interface>

138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
  <interface name="wl_shm_pool" version="1">
    <description summary="a shared memory pool">
      The wl_shm_pool object encapsulates a piece of memory shared
      between the compsitor and client.  Through the wl_shm_pool
      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
	so it is valid to destroy the pool immediatedly after creating
	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>
  </interface>

178
  <interface name="wl_shm" version="1">
179
180
181
182
    <description summary="shared memory support">
      Support for shared memory buffers.
    </description>

183
    <enum name="error">
184
      <entry name="invalid_format" value="0"/>
185
186
187
188
      <entry name="invalid_stride" value="1"/>
      <entry name="invalid_fd" value="2"/>
    </enum>

189
    <enum name="format">
190
191
      <entry name="argb8888" value="0"/>
      <entry name="xrgb8888" value="1"/>
192
193
    </enum>

194
195
196
197
198
199
    <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.
200
201
      </description>

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
208
209

    <event name="format">
      <arg name="format" type="uint"/>
    </event>
210
211
  </interface>

212
  <interface name="wl_buffer" version="1">
213
214
215
216
    <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
217
      wl_surface, but the mechanism by which a client provides and
218
219
220
221
222
223
224
225
      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.
      </description>
    </request>
Benjamin Franzke's avatar
Benjamin Franzke committed
226

227
    <event name="release">
Tiago Vignatti's avatar
Tiago Vignatti committed
228
      <description summary="compositor releases buffer">
229
230
231
	Sent when an attached buffer is no longer used by the compositor.
      </description>
    </event>
232
233
  </interface>

234
235
236

  <interface name="wl_data_offer" version="1">
    <request name="accept">
237
238
239
240
241
      <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>

242
      <arg name="serial" type="uint"/>
243
244
245
246
247
248
249
250
251
252
253
      <arg name="type" type="string"/>
    </request>

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

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

    <event name="offer">
254
255
256
257
258
      <description summary="advertise offered mime-type">
	Sent immediately after creating the wl_data_offer object.  One
	event per offered mime type.
      </description>

259
260
261
262
263
264
      <arg name="type" type="string"/>
    </event>
  </interface>

  <interface name="wl_data_source" version="1">
    <request name="offer">
265
266
267
268
269
      <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>
270
271
272
      <arg name="type" type="string"/>
    </request>

273
274
275
276
277
    <request name="destroy" type="destructor">
      <description summary="destroy the data source">
	Destroy the data source.
      </description>
    </request>
278
279

    <event name="target">
280
281
282
283
284
      <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>

285
286
287
288
      <arg name="mime_type" type="string"/>
    </event>

    <event name="send">
289
290
291
292
293
      <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>

294
295
296
297
      <arg name="mime_type" type="string"/>
      <arg name="fd" type="fd"/>
    </event>

298
299
300
301
302
303
    <event name="cancelled">
      <description summary="selection was cancelled">
	Another selection became active.
      </description>
    </event>

304
305
306
307
  </interface>

  <interface name="wl_data_device" version="1">
    <request name="start_drag">
308
309
310
311
312
313
      <description summary="start drag and drop operation">
	This request asks the compositor to start a drag and drop
	operation on behalf of the client.  The source argument is the
	data source that provides the data for the eventual data
	transfer.  The origin surface is the surface where the drag
	originates and the client must have an active implicit grab
314
	that matches the serial.  The icon surface is an optional
315
316
317
318
319
	(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 hotspot, but subsequent
	surface.attach request can move the relative position.
      </description>
320
      <arg name="source" type="object" interface="wl_data_source"/>
321
322
      <arg name="origin" type="object" interface="wl_surface"/>
      <arg name="icon" type="object" interface="wl_surface"/>
323
      <arg name="serial" type="uint"/>
324
325
326
327
    </request>

    <request name="set_selection">
      <arg name="source" type="object" interface="wl_data_source"/>
328
      <arg name="serial" type="uint"/>
329
330
331
    </request>

    <event name="data_offer">
332
333
334
335
336
337
338
339
340
341
      <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>

342
343
344
345
      <arg name="id" type="new_id" interface="wl_data_offer"/>
    </event>

    <event name="enter">
346
      <arg name="serial" type="uint"/>
347
      <arg name="surface" type="object" interface="wl_surface"/>
348
349
      <arg name="x" type="fixed"/>
      <arg name="y" type="fixed"/>
350
351
352
353
354
355
356
      <arg name="id" type="object" interface="wl_data_offer"/>
    </event>

    <event name="leave"/>

    <event name="motion">
      <arg name="time" type="uint"/>
357
358
      <arg name="x" type="fixed"/>
      <arg name="y" type="fixed"/>
359
360
361
362
363
    </event>

    <event name="drop"/>

    <event name="selection">
364
365
366
367
368
369
370
371
372
373
374
      <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>
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
      <arg name="id" type="object" interface="wl_data_offer"/>
    </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"/>
      <arg name="input_device" type="object" interface="wl_input_device"/>
    </request>
  </interface>

390
  <interface name="wl_shell" version="1">
391
392
    <request name="get_shell_surface">
      <arg name="id" type="new_id" interface="wl_shell_surface"/>
393
      <arg name="surface" type="object" interface="wl_surface"/>
394
395
396
397
    </request>
  </interface>

  <interface name="wl_shell_surface" version="1">
398
399
400
401
402
403
404
405

    <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>

406
407
408
409
410
411
412
413
    <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>

414
    <request name="move">
415
      <arg name="input_device" type="object" interface="wl_input_device"/>
416
      <arg name="serial" type="uint"/>
417
418
    </request>

419
420
421
422
423
424
425
426
427
428
429
430
    <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>

431
    <request name="resize">
432
      <arg name="input_device" type="object" interface="wl_input_device"/>
433
      <arg name="serial" type="uint"/>
434
435
436
      <arg name="edges" type="uint"/>
    </request>

437
438
439
440
441
442
    <request name="set_toplevel">
      <description summary="make the surface a top level surface">
	Make the surface a toplevel window.
      </description>
    </request>

443
    <request name="set_transient">
444
445
446
447
448
449
450
451
452
453
454
      <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>

455
      <arg name="parent" type="object" interface="wl_shell_surface"/>
456
457
458
459
460
      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
      <arg name="flags" type="uint"/>
    </request>

461
462
    <request name="set_fullscreen">
      <description summary="make the surface a fullscreen surface">
463
464
465
466
467
468
469
470
471
472
473
474
        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
475
476
        that the app does not care about framerate.  The framerate is
        specified in mHz, that is framerate of 60000 is 60Hz.
477
478
479

        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.
480
      </description>
Juan Zhao's avatar
Juan Zhao committed
481
482
483
      <arg name="method" type="uint"/>
      <arg name="framerate" type="uint"/>
      <arg name="output" type="object" interface="wl_output"/>
484
485
    </request>

Juan Zhao's avatar
Juan Zhao committed
486
487
    <enum name="fullscreen_method">
      <description summary="different method to set the surface fullscreen">
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
        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
506
507
508
509
510
511
512
      </description>
      <entry name="default" value="0"/>
      <entry name="scale" value="1"/>
      <entry name="driver" value="2"/>
      <entry name="fill" value="3"/>
    </enum>

513
    <request name="set_popup">
514
515
516
517
518
519
520
521
522
523
524
525
526
527
      <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>

528
      <arg name="input_device" type="object" interface="wl_input_device"/>
529
      <arg name="serial" type="uint"/>
530
531
532
533
534
535
      <arg name="parent" type="object" interface="wl_shell_surface"/>
      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
      <arg name="flags" type="uint"/>
    </request>

Juan Zhao's avatar
Juan Zhao committed
536
537
538
539
540
541
542
543
544
545
546
547
548
    <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>
      <arg name="output" type="object" interface="wl_output"/>
    </request>

549
550
551
552
553
554
555
556
557
558
559
560
561
    <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>
562
      <arg name="class_" type="string"/>
563
564
    </request>

565
566
567
568
569
570
571
572
    <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>

573
    <event name="configure">
574
575
576
577
578
579
580
581
582
      <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
	satisfy aspect ration or resize in steps of NxM pixels).  The
	client is free to dismiss all but the last configure event it
	received.
      </description>

583
      <arg name="edges" type="uint"/>
584
585
586
      <arg name="width" type="int"/>
      <arg name="height" type="int"/>
    </event>
587

588
589
590
591
592
593
594
    <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>
595
  </interface>
596

597
  <interface name="wl_surface" version="1">
598
599
600
601
602
603
604
605
606
607
    <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>
608
609

    <request name="attach">
610
611
612
613
614
615
      <description summary="set the surface contents">
	Copy the contents of a buffer into this surface. The x and y
	arguments specify the location of the new buffers upper left
	corner, relative to the old buffers upper left corner.
      </description>

616
      <arg name="buffer" type="object" interface="wl_buffer"/>
617
618
619
620
621
      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
    </request>

    <request name="damage">
622
623
624
625
626
627
628
      <description summary="mark part of the surface damaged">
	After attaching a new buffer, this request is used to describe
	the regions where the new buffer is different from the
	previous buffer and needs to be repainted.  Coordinates are
	relative to the new buffer.
      </description>

629
630
631
632
633
      <arg name="x" type="int"/>
      <arg name="y" type="int"/>
      <arg name="width" type="int"/>
      <arg name="height" type="int"/>
    </request>
634
635

    <request name="frame">
636
637
638
639
640
641
642
      <description summary="request repaint feedback">
	Request notification when the next frame is displayed.  Useful
	for throttling redrawing operations, and driving animations.
	The notification will only be posted for one frame unless
	requested again.
      </description>

643
644
645
      <arg name="callback" type="new_id" interface="wl_callback"/>
    </request>

646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
    <request name="set_opaque_region">
      <description summary="set opaque region">
	This requests sets the region of the surface that contain
	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.

	The region will be clipped to the extents of the current
	surface size.  Setting the region has copy semantics, and the
	region object can be destroyed immediately after setting the
	opaque region.  If a buffer of a different size is attached or
	if a nil region is set, the opaque region will revert back to
	default.  The default opaque region is empty.
      </description>

      <arg name="region" type="object" interface="wl_region"/>
    </request>

    <request name="set_input_region">
      <description summary="set input region">
	This requests sets the region of the surface that can receive
	pointer and touch events.  The region will be clipped to the
	extents of the current surface size.  Setting the region has
	copy semantics, and the region object can be destroyed
	immediately after setting the input region.  If a buffer of a
	different size is attached or if a nil region is passed, the
	input region will revert back to default.  The default input
	region is the entire surface.
      </description>

      <arg name="region" type="object" interface="wl_region"/>
    </request>
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697

    <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>
698
699
  </interface>

700
701
702
703
  <interface name="wl_input_device" version="1">
    <description summary="input device group">
      A group of keyboards and pointer devices (mice, for
      example). This object is published as a global during start up,
704
705
706
707
708
      or when such a device is hot plugged.  A input_device group
      typically has a pointer and maintains a keyboard_focus and a
      pointer_focus.
    </description>

709
    <request name="attach">
710
711
712
713
714
715
      <description summary="set the pointer image">
	Set the pointer's image.  This request only takes effect if
	the pointer focus for this device is one of the requesting
	clients surfaces.
      </description>

716
      <arg name="serial" type="uint"/>
717
      <arg name="buffer" type="object" interface="wl_buffer"/>
718
719
720
721
      <arg name="hotspot_x" type="int"/>
      <arg name="hotspot_y" type="int"/>
    </request>

722
    <event name="motion">
723
      <description summary="pointer motion event">
724
725
	Notification of pointer location change. The arguments surface_[xy]
	are the location relative to the focused surface.
726
727
      </description>

728
      <arg name="time" type="uint"/>
729
730
      <arg name="surface_x" type="fixed"/>
      <arg name="surface_y" type="fixed"/>
731
732
733
    </event>

    <event name="button">
734
735
736
737
738
      <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>

739
      <arg name="serial" type="uint"/>
740
741
742
743
744
      <arg name="time" type="uint"/>
      <arg name="button" type="uint"/>
      <arg name="state" type="uint"/>
    </event>

Scott Moreau's avatar
Scott Moreau committed
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
    <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"/>
      <arg name="value" type="int"/>
    </event>

761
762
763
764
    <event name="key">
      <description summary="key event">
	A key was pressed or released.
      </description>
765

766
      <arg name="serial" type="uint"/>
767
768
769
      <arg name="time" type="uint"/>
      <arg name="key" type="uint"/>
      <arg name="state" type="uint"/>
770
771
    </event>

772
773
774
775
776
777
778
779
    <event name="pointer_enter">
      <description summary="pointer enter event">
	Notification that this input device's pointer is focused on
	certain surface. When an input_device enters a surface, the
	pointer image is undefined and a client should respond to this
	event by setting an appropriate pointer image.
      </description>

780
      <arg name="serial" type="uint"/>
781
      <arg name="surface" type="object" interface="wl_surface"/>
782
783
      <arg name="surface_x" type="fixed"/>
      <arg name="surface_y" type="fixed"/>
784
785
    </event>

786
787
    <event name="pointer_leave">
      <description summary="pointer leave event">
788
      </description>
789
790
791
      <arg name="serial" type="uint"/>
      <arg name="surface" type="object" interface="wl_surface"/>
    </event>
792

793
    <event name="keyboard_enter">
794
      <arg name="serial" type="uint"/>
795
796
      <arg name="surface" type="object" interface="wl_surface"/>
      <arg name="keys" type="array"/>
797
    </event>
Laszlo Agocs's avatar
Laszlo Agocs committed
798

799
800
801
802
    <event name="keyboard_leave">
      <arg name="serial" type="uint"/>
      <arg name="surface" type="object" interface="wl_surface"/>
    </event>
803

804
    <event name="touch_down">
805
      <arg name="serial" type="uint"/>
Laszlo Agocs's avatar
Laszlo Agocs committed
806
      <arg name="time" type="uint"/>
807
      <arg name="surface" type="object" interface="wl_surface"/>
Laszlo Agocs's avatar
Laszlo Agocs committed
808
      <arg name="id" type="int" />
809
810
      <arg name="x" type="fixed" />
      <arg name="y" type="fixed" />
Laszlo Agocs's avatar
Laszlo Agocs committed
811
812
    </event>

813
    <event name="touch_up">
814
      <arg name="serial" type="uint"/>
Laszlo Agocs's avatar
Laszlo Agocs committed
815
816
817
818
      <arg name="time" type="uint"/>
      <arg name="id" type="int" />
    </event>

819
    <event name="touch_motion">
Laszlo Agocs's avatar
Laszlo Agocs committed
820
821
      <arg name="time" type="uint"/>
      <arg name="id" type="int" />
822
823
      <arg name="x" type="fixed" />
      <arg name="y" type="fixed" />
Laszlo Agocs's avatar
Laszlo Agocs committed
824
825
    </event>

826
    <event name="touch_frame">
827
828
829
830
      <description summary="end of touch frame event">
	Indicates the end of a contact point list.
      </description>
    </event>
Laszlo Agocs's avatar
Laszlo Agocs committed
831

832
    <event name="touch_cancel">
833
834
835
836
837
838
      <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>
839
840
  </interface>

841

842
  <interface name="wl_output" version="1">
Tiago Vignatti's avatar
Tiago Vignatti committed
843
    <description summary="compositor output region">
844
845
846
847
848
849
850
      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>
851
852
853
854
855
856
857
858
859
860

    <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>

861
    <event name="geometry">
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
      <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"
	   summary="width in milimeters of the output"/>
      <arg name="physical_height" type="int"
	   summary="height in milimeters of the output"/>
      <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"/>
877
878
879
    </event>

    <enum name="mode">
880
      <description summary="values for the flags bitfield in the mode event"/>
881
882
883
884
      <entry name="current" value="0x1"
	     summary="indicates this is the current mode"/>
      <entry name="preferred" value="0x2"
	     summary="indicates this is the preferred mode"/>
885
886
887
    </enum>
      
    <event name="mode">
888
889
890
891
892
893
894
895
896
897
898
899
      <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"/>
900
901
902
    </event>
  </interface>

903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
  <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>

938
</protocol>