2010-11-29 21:05:26 +02:00
<?xml version="1.0" encoding="UTF-8"?>
2010-09-14 15:52:43 -04:00
<protocol name= "wayland" >
2010-08-03 09:26:44 -04:00
2011-07-25 18:14:20 -07:00
<copyright >
Copyright © 2008-2011 Kristian Høgsberg
Copyright © 2010-2011 Intel Corporation
protocol: add sub-surfaces to the core
The sub-surface protocol was originally committed into Weston on May
10th, 2013, in commit 2396aec6842c709a714f3825dbad9fd88478f2e6. The
design for the protocol had started in the beginning of December 2012. I
think it is high time to move this into the core now.
This patch copies the sub-surface protocol as it was in Weston on Nov
15th, 2013, into Wayland. Weston gets a patch to remove the protocol from
there.
Sub-surface is a wl_surface role. You create a wl_surface as usual, and
assign it the sub-surface role and a parent wl_surface. Sub-surfaces are
an integral part of the parent surface, and stay glued to the parent.
For window management, a window is the union of the top-level
wl_surface and all its sub-surfaces. Sub-surfaces are not clipped to the
parent, and the union of the surface tree can be larger than the
(top-level) wl_surface at its root.
The representative use case for sub-surfaces is a video player window.
When the video content is given its own wl_surface, there is no need to
modify the video frame contents after decoding or copy them into a whole
window sized buffer before submitting it to the compositor. This allows
efficient, zero-copy video presentation paths, where video decoding
hardware produces a (YUV) buffer, which eventually ends up in a
(YUV-capable) hardware overlay and is scanned out directly.
This can also be used for zero-copy presentation of windowed OpenGL
content, where the OpenGL rendering engine does not need to draw or
avoid window decorations.
Sub-surfaces allow mixing different buffer types into the same window,
e.g. software-rendered decorations in wl_shm buffers, and live content
in EGL-based buffers.
However, the sub-surface extension does not offer clipping or scaling
facilities, or accurate presentation timing. Those are topics for
additional extensions.
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2013-11-15 16:09:45 +02:00
Copyright © 2012-2013 Collabora, Ltd.
2011-07-25 18:14:20 -07:00
Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
2012-01-24 17:49:28 +02:00
without fee, provided that the above copyright notice appear in
2011-07-25 18:14:20 -07:00
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>
2011-04-18 10:24:11 -04:00
<interface name= "wl_display" version= "1" >
scanner: Support documentation elements
On Wed, 18 Jan 2012 12:29:37 -0800
"Kristensen, Kristian H" <kristian.h.kristensen@intel.com> wrote:
> Yeah, that looks good. I was thinking of a separate <description> tag
> to avoid stuffing too much into an attribute.
How does this look? It adds a summary attribute to atomic elements,
and a <description> tag with a summary for others. Spits out enum
documentation like this:
/**
* wl_display_error - global error values
* @WL_DISPLAY_ERROR_INVALID_OBJECT: server couldn't find object
* @WL_DISPLAY_ERROR_INVALID_METHOD: method doesn't exist on the specified interface
* @WL_DISPLAY_ERROR_NO_MEMORY: server is out of memory
*
* These errors are global and can be emitted in response to any server request.
*/
enum wl_display_error {
WL_DISPLAY_ERROR_INVALID_OBJECT = 0,
WL_DISPLAY_ERROR_INVALID_METHOD = 1,
WL_DISPLAY_ERROR_NO_MEMORY = 2,
};
and structure documentation like this:
/**
* wl_display - core global object
* @bind: bind an object to the display
* @sync: (none)
*
* The core global object. This is a special singleton object. It is used for
* internal wayland protocol features.
*/
struct wl_display_interface {
void (*bind)(struct wl_client *client,
struct wl_resource *resource,
uint32_t name,
const char *interface,
uint32_t version,
uint32_t id);
void (*sync)(struct wl_client *client,
struct wl_resource *resource,
uint32_t callback);
};
2012-01-18 14:09:47 -08:00
<description summary= "core global object" >
2012-01-18 19:17:23 -05:00
The core global object. This is a special singleton object. It
2012-10-08 18:40:00 +03:00
is used for internal Wayland protocol features.
scanner: Support documentation elements
On Wed, 18 Jan 2012 12:29:37 -0800
"Kristensen, Kristian H" <kristian.h.kristensen@intel.com> wrote:
> Yeah, that looks good. I was thinking of a separate <description> tag
> to avoid stuffing too much into an attribute.
How does this look? It adds a summary attribute to atomic elements,
and a <description> tag with a summary for others. Spits out enum
documentation like this:
/**
* wl_display_error - global error values
* @WL_DISPLAY_ERROR_INVALID_OBJECT: server couldn't find object
* @WL_DISPLAY_ERROR_INVALID_METHOD: method doesn't exist on the specified interface
* @WL_DISPLAY_ERROR_NO_MEMORY: server is out of memory
*
* These errors are global and can be emitted in response to any server request.
*/
enum wl_display_error {
WL_DISPLAY_ERROR_INVALID_OBJECT = 0,
WL_DISPLAY_ERROR_INVALID_METHOD = 1,
WL_DISPLAY_ERROR_NO_MEMORY = 2,
};
and structure documentation like this:
/**
* wl_display - core global object
* @bind: bind an object to the display
* @sync: (none)
*
* The core global object. This is a special singleton object. It is used for
* internal wayland protocol features.
*/
struct wl_display_interface {
void (*bind)(struct wl_client *client,
struct wl_resource *resource,
uint32_t name,
const char *interface,
uint32_t version,
uint32_t id);
void (*sync)(struct wl_client *client,
struct wl_resource *resource,
uint32_t callback);
};
2012-01-18 14:09:47 -08:00
</description>
2011-04-14 10:38:44 -04:00
2010-09-03 14:46:38 -04:00
<request name= "sync" >
2012-01-18 19:17:23 -05:00
<description summary= "asynchronous roundtrip" >
2012-09-25 12:19:57 +03:00
The sync request asks the server to emit the 'done' event
2013-03-30 01:11:33 -04:00
on the returned wl_callback object. Since requests are
handled in-order and events are delivered in-order, this can
2013-10-11 09:14:25 +02:00
be used as a barrier to ensure all previous requests and the
2013-03-30 01:11:33 -04:00
resulting events have been handled.
2013-04-17 18:28:42 +01:00
The object returned by this request will be destroyed by the
compositor after the callback is fired and as such the client must not
attempt to use it after that point.
2014-01-31 15:55:48 -05:00
2014-01-31 16:29:37 -05:00
The callback_data passed in the callback is the event serial.
2012-01-18 19:17:23 -05:00
</description>
2011-07-29 19:51:22 -07:00
<arg name= "callback" type= "new_id" interface= "wl_callback" />
2010-09-03 14:46:38 -04:00
</request>
2012-10-08 13:53:47 -04:00
<request name= "get_registry" >
2012-10-21 22:08:08 -04:00
<description summary= "get global registry object" >
This request creates a registry object that allows the client
to list and bind the global objects available from the
compositor.
</description>
2014-01-31 15:38:07 -05:00
<arg name= "registry" type= "new_id" interface= "wl_registry" />
2012-10-08 13:53:47 -04:00
</request>
2011-05-11 10:57:06 -04:00
<event name= "error" >
2012-01-18 19:17:23 -05:00
<description summary= "fatal error event" >
The error event is sent out when a fatal (non-recoverable)
2013-03-30 01:11:33 -04:00
error has occurred. The object_id argument is the object
2012-10-21 22:08:08 -04:00
where the error occurred, most often in response to a request
2013-03-30 01:11:33 -04:00
to that object. The code identifies the error and is defined
2012-10-21 22:08:08 -04:00
by the object interface. As such, each interface defines its
2013-03-30 01:11:33 -04:00
own set of error codes. The message is an brief description
2012-10-21 22:08:08 -04:00
of the error, for (debugging) convenience.
2012-01-18 19:17:23 -05:00
</description>
2012-10-08 13:21:55 -04:00
<arg name= "object_id" type= "object" />
2011-05-11 10:57:06 -04:00
<arg name= "code" type= "uint" />
<arg name= "message" type= "string" />
2010-08-03 09:26:44 -04:00
</event>
2011-05-11 10:57:06 -04:00
<enum name= "error" >
scanner: Support documentation elements
On Wed, 18 Jan 2012 12:29:37 -0800
"Kristensen, Kristian H" <kristian.h.kristensen@intel.com> wrote:
> Yeah, that looks good. I was thinking of a separate <description> tag
> to avoid stuffing too much into an attribute.
How does this look? It adds a summary attribute to atomic elements,
and a <description> tag with a summary for others. Spits out enum
documentation like this:
/**
* wl_display_error - global error values
* @WL_DISPLAY_ERROR_INVALID_OBJECT: server couldn't find object
* @WL_DISPLAY_ERROR_INVALID_METHOD: method doesn't exist on the specified interface
* @WL_DISPLAY_ERROR_NO_MEMORY: server is out of memory
*
* These errors are global and can be emitted in response to any server request.
*/
enum wl_display_error {
WL_DISPLAY_ERROR_INVALID_OBJECT = 0,
WL_DISPLAY_ERROR_INVALID_METHOD = 1,
WL_DISPLAY_ERROR_NO_MEMORY = 2,
};
and structure documentation like this:
/**
* wl_display - core global object
* @bind: bind an object to the display
* @sync: (none)
*
* The core global object. This is a special singleton object. It is used for
* internal wayland protocol features.
*/
struct wl_display_interface {
void (*bind)(struct wl_client *client,
struct wl_resource *resource,
uint32_t name,
const char *interface,
uint32_t version,
uint32_t id);
void (*sync)(struct wl_client *client,
struct wl_resource *resource,
uint32_t callback);
};
2012-01-18 14:09:47 -08:00
<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"/>
2011-05-11 10:57:06 -04:00
</enum>
2010-08-03 09:26:44 -04:00
2012-10-08 13:53:47 -04:00
<event name= "delete_id" >
2013-03-30 01:11:33 -04:00
<description summary= "acknowledge object ID deletion" >
2012-10-21 22:08:08 -04:00
This event is used internally by the object ID management
logic. When a client deletes an object, the server will send
this event to acknowledge that it has seen the delete request.
When the client receive this event, it will know that it can
2013-03-30 01:11:33 -04:00
safely reuse the object ID.
2012-10-08 13:53:47 -04:00
</description>
<arg name= "id" type= "uint" />
</event>
</interface>
<interface name= "wl_registry" version= "1" >
2012-10-21 22:08:08 -04:00
<description summary= "global registry object" >
The global registry object. The server has a number of global
objects that are available to all clients. These objects
typically represent an actual object in the server (for example,
2013-03-30 01:11:34 -04:00
an input device) or they are singleton objects that provide
2012-10-21 22:08:08 -04:00
extension functionality.
When a client creates a registry object, the registry object
will emit a global event for each global currently in the
2013-03-30 01:11:34 -04:00
registry. Globals come and go as a result of device or
monitor hotplugs, reconfiguration or other events, and the
registry will send out global and global_remove events to
keep the client up to date with the changes. To mark the end
of the initial burst of events, the client can use the
wl_display.sync request immediately after calling
wl_display.get_registry.
A client can bind to a global object by using the bind
request. This creates a client-side handle that lets the object
2012-10-21 22:08:08 -04:00
emit events to the client and lets the client invoke requests on
the object.
</description>
2012-10-08 13:53:47 -04:00
<request name= "bind" >
<description summary= "bind an object to the display" >
2013-03-30 01:11:34 -04:00
Binds a new, client-created object to the server using the
specified name as the identifier.
2012-10-08 13:53:47 -04:00
</description>
2013-03-30 01:11:34 -04:00
<arg name= "name" type= "uint" summary= "unique name for the object" />
2012-10-08 13:53:47 -04:00
<arg name= "id" type= "new_id" />
</request>
2010-08-03 09:26:44 -04:00
<event name= "global" >
2012-01-18 19:17:23 -05:00
<description summary= "announce global object" >
2013-03-30 01:11:34 -04:00
Notify the client of global objects.
The event notifies the client that a global object with
the given name is now available, and it implements the
given version of the given interface.
2012-01-18 19:17:23 -05:00
</description>
2011-10-24 16:04:09 -04:00
<arg name= "name" type= "uint" />
2011-08-19 16:57:48 -04:00
<arg name= "interface" type= "string" />
2010-08-03 09:26:44 -04:00
<arg name= "version" type= "uint" />
</event>
2011-06-14 10:35:46 +02:00
<event name= "global_remove" >
2012-01-18 19:17:23 -05:00
<description summary= "announce removal of global object" >
2013-03-30 01:11:34 -04:00
Notify the client of removed global objects.
This event notifies the client that the global identified
by name is no longer available. If the client bound to
the global using the bind request, the client should now
destroy that object.
2012-10-21 22:08:08 -04:00
The object remains valid and requests to the object will be
ignored until the client destroys it, to avoid races between
the global going away and a client sending a request to it.
2012-01-18 19:17:23 -05:00
</description>
<arg name= "name" type= "uint" />
2011-06-14 10:35:46 +02:00
</event>
2011-07-29 19:51:22 -07:00
</interface>
2010-08-03 09:26:44 -04:00
2011-07-29 19:51:22 -07:00
<interface name= "wl_callback" version= "1" >
2013-03-30 01:11:35 -04:00
<description summary= "callback object" >
Clients can handle the 'done' event to get notified when
the related request is done.
</description>
2011-07-29 19:51:22 -07:00
<event name= "done" >
2013-03-30 01:11:35 -04:00
<description summary= "done event" >
Notify the client when the related request is done.
</description>
2014-01-31 16:29:37 -05:00
<arg name= "callback_data" type= "uint" summary= "request-specific data for the wl_callback" />
2010-08-03 09:26:44 -04:00
</event>
</interface>
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
<interface name= "wl_compositor" version= "3" >
2012-01-18 19:17:23 -05:00
<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>
2010-09-03 14:46:38 -04:00
<request name= "create_surface" >
2012-01-18 19:17:23 -05:00
<description summary= "create new surface" >
Ask the compositor to create a new surface.
</description>
2011-04-18 10:24:11 -04:00
<arg name= "id" type= "new_id" interface= "wl_surface" />
2010-09-03 14:46:38 -04:00
</request>
2012-02-23 14:50:06 -05:00
<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>
2010-09-03 14:46:38 -04:00
</interface>
2012-04-03 12:08:50 -04:00
<interface name= "wl_shm_pool" version= "1" >
<description summary= "a shared memory pool" >
The wl_shm_pool object encapsulates a piece of memory shared
2012-10-08 18:40:00 +03:00
between the compositor and client. Through the wl_shm_pool
2012-04-03 12:08:50 -04:00
object, the client can allocate shared memory wl_buffer objects.
2013-03-30 01:11:36 -04:00
All objects created through the same pool 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.
2012-04-03 12:08:50 -04:00
</description>
<request name= "create_buffer" >
2013-03-30 01:11:36 -04:00
<description summary= "create a buffer from the pool" >
Create a wl_buffer object from the pool.
The buffer is created 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.
2012-04-03 12:08:50 -04:00
A buffer will keep a reference to the pool it was created from
2012-10-08 18:40:00 +03:00
so it is valid to destroy the pool immediately after creating
2012-04-03 12:08:50 -04:00
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" >
2013-03-30 01:11:36 -04:00
Destroy the shared memory pool.
The mmapped memory will be released when all
buffers that have been created from this pool
are gone.
2012-04-03 12:08:50 -04:00
</description>
</request>
2012-05-22 15:39:40 +03:00
<request name= "resize" >
<description summary= "change the size of the pool mapping" >
This request will cause the server to remap the backing memory
2013-03-30 01:11:36 -04:00
for the pool from the file descriptor passed when the pool was
2014-04-07 14:42:20 -07:00
created, but using the new size. This request can only be
used to make the pool bigger.
2012-05-22 15:39:40 +03:00
</description>
<arg name= "size" type= "int" />
</request>
2012-04-03 12:08:50 -04:00
</interface>
2011-04-18 10:24:11 -04:00
<interface name= "wl_shm" version= "1" >
2012-01-18 19:17:23 -05:00
<description summary= "shared memory support" >
2013-03-30 01:11:36 -04:00
A global singleton object that provides support for shared
memory.
Clients can create wl_shm_pool objects using the create_pool
request.
At connection setup time, the wl_shm object emits one or more
format events to inform clients about the valid pixel formats
that can be used for buffers.
2012-01-18 19:17:23 -05:00
</description>
2011-05-11 11:00:40 -04:00
<enum name= "error" >
2013-03-30 01:11:36 -04:00
<description summary= "wl_shm error values" >
These errors can be emitted in response to wl_shm requests.
</description>
<entry name= "invalid_format" value= "0" summary= "buffer format is not known" />
<entry name= "invalid_stride" value= "1" summary= "invalid size or stride during pool or buffer creation" />
<entry name= "invalid_fd" value= "2" summary= "mmapping the file descriptor failed" />
2011-05-11 11:00:40 -04:00
</enum>
2011-08-30 21:26:19 -04:00
<enum name= "format" >
2013-03-30 01:11:36 -04:00
<description summary= "pixel formats" >
2013-07-11 16:08:20 +02:00
This describes the memory layout of an individual pixel.
All renderers should support argb8888 and xrgb8888 but any other
formats are optional and may not be supported by the particular
renderer in use.
2013-03-30 01:11:36 -04:00
</description>
<entry name= "argb8888" value= "0" summary= "32-bit ARGB format" />
<entry name= "xrgb8888" value= "1" summary= "32-bit RGB format" />
2013-07-11 16:08:20 +02:00
<!-- The drm format codes match the #defines in drm_fourcc.h.
The formats actually supported by the compositor will be
reported by the format event. -->
<entry name= "c8" value= "0x20203843" />
<entry name= "rgb332" value= "0x38424752" />
<entry name= "bgr233" value= "0x38524742" />
<entry name= "xrgb4444" value= "0x32315258" />
<entry name= "xbgr4444" value= "0x32314258" />
<entry name= "rgbx4444" value= "0x32315852" />
<entry name= "bgrx4444" value= "0x32315842" />
<entry name= "argb4444" value= "0x32315241" />
<entry name= "abgr4444" value= "0x32314241" />
<entry name= "rgba4444" value= "0x32314152" />
<entry name= "bgra4444" value= "0x32314142" />
<entry name= "xrgb1555" value= "0x35315258" />
<entry name= "xbgr1555" value= "0x35314258" />
<entry name= "rgbx5551" value= "0x35315852" />
<entry name= "bgrx5551" value= "0x35315842" />
<entry name= "argb1555" value= "0x35315241" />
<entry name= "abgr1555" value= "0x35314241" />
<entry name= "rgba5551" value= "0x35314152" />
<entry name= "bgra5551" value= "0x35314142" />
<entry name= "rgb565" value= "0x36314752" />
<entry name= "bgr565" value= "0x36314742" />
<entry name= "rgb888" value= "0x34324752" />
<entry name= "bgr888" value= "0x34324742" />
<entry name= "xbgr8888" value= "0x34324258" />
<entry name= "rgbx8888" value= "0x34325852" />
<entry name= "bgrx8888" value= "0x34325842" />
<entry name= "abgr8888" value= "0x34324241" />
<entry name= "rgba8888" value= "0x34324152" />
<entry name= "bgra8888" value= "0x34324142" />
<entry name= "xrgb2101010" value= "0x30335258" />
<entry name= "xbgr2101010" value= "0x30334258" />
<entry name= "rgbx1010102" value= "0x30335852" />
<entry name= "bgrx1010102" value= "0x30335842" />
<entry name= "argb2101010" value= "0x30335241" />
<entry name= "abgr2101010" value= "0x30334241" />
<entry name= "rgba1010102" value= "0x30334152" />
<entry name= "bgra1010102" value= "0x30334142" />
<entry name= "yuyv" value= "0x56595559" />
<entry name= "yvyu" value= "0x55595659" />
<entry name= "uyvy" value= "0x59565955" />
<entry name= "vyuy" value= "0x59555956" />
<entry name= "ayuv" value= "0x56555941" />
<entry name= "nv12" value= "0x3231564e" />
<entry name= "nv21" value= "0x3132564e" />
<entry name= "nv16" value= "0x3631564e" />
<entry name= "nv61" value= "0x3136564e" />
<entry name= "yuv410" value= "0x39565559" />
<entry name= "yvu410" value= "0x39555659" />
<entry name= "yuv411" value= "0x31315559" />
<entry name= "yvu411" value= "0x31315659" />
<entry name= "yuv420" value= "0x32315559" />
<entry name= "yvu420" value= "0x32315659" />
<entry name= "yuv422" value= "0x36315559" />
<entry name= "yvu422" value= "0x36315659" />
<entry name= "yuv444" value= "0x34325559" />
<entry name= "yvu444" value= "0x34325659" />
2011-08-30 21:26:19 -04:00
</enum>
2012-04-03 12:08:50 -04:00
<request name= "create_pool" >
<description summary= "create a shm pool" >
2013-03-30 01:11:36 -04:00
Create a new wl_shm_pool object.
The pool can be used to create shared memory based buffer
objects. The server will mmap size bytes of the passed file
descriptor, to use as backing memory for the pool.
2012-01-18 19:17:23 -05:00
</description>
2012-04-03 12:08:50 -04:00
<arg name= "id" type= "new_id" interface= "wl_shm_pool" />
2010-10-06 21:17:40 -04:00
<arg name= "fd" type= "fd" />
2012-04-03 12:08:50 -04:00
<arg name= "size" type= "int" />
2010-10-06 21:17:40 -04:00
</request>
2011-08-30 21:26:19 -04:00
<event name= "format" >
2013-03-30 01:11:36 -04:00
<description summary= "pixel format description" >
Informs the client about a valid pixel format that
can be used for buffers. Known formats include
argb8888 and xrgb8888.
</description>
2011-08-30 21:26:19 -04:00
<arg name= "format" type= "uint" />
</event>
2010-10-06 21:17:40 -04:00
</interface>
2011-04-18 10:24:11 -04:00
<interface name= "wl_buffer" version= "1" >
2012-01-18 19:17:23 -05:00
<description summary= "content for a wl_surface" >
2012-10-12 14:29:01 +03:00
A buffer provides the content for a wl_surface. Buffers are
2012-01-18 19:17:23 -05:00
created through factory interfaces such as wl_drm, wl_shm or
2012-10-12 14:29:01 +03:00
similar. It has a width and a height and can be attached to a
2012-01-24 17:49:28 +02:00
wl_surface, but the mechanism by which a client provides and
2012-10-12 14:29:01 +03:00
updates the contents is defined by the buffer factory interface.
2012-01-18 19:17:23 -05:00
</description>
<request name= "destroy" type= "destructor" >
<description summary= "destroy a buffer" >
2012-10-12 14:29:01 +03:00
Destroy a buffer. If and how you need to release the backing
storage is defined by the buffer factory interface.
2012-10-10 12:47:50 +03:00
For possible side-effects to a surface, see wl_surface.attach.
2012-01-18 19:17:23 -05:00
</description>
</request>
2011-05-09 17:35:58 +02:00
2012-01-18 19:17:23 -05:00
<event name= "release" >
2012-01-24 17:49:28 +02:00
<description summary= "compositor releases buffer" >
2012-10-10 12:47:50 +03:00
Sent when this wl_buffer is no longer used by the compositor.
2012-10-12 14:29:01 +03:00
The client is now free to re-use or destroy this buffer and its
backing storage.
If a client receives 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 is immediately free to
re-use the buffer and its backing storage, and does not need a
second buffer for the next surface content update. Typically
2012-10-10 12:47:50 +03:00
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.
2012-01-18 19:17:23 -05:00
</description>
</event>
2010-08-09 14:43:33 -04:00
</interface>
2011-11-15 08:58:34 -05:00
<interface name= "wl_data_offer" version= "1" >
2012-10-21 22:08:08 -04:00
<description summary= "offer to transfer data" >
A wl_data_offer represents a piece of data offered for transfer
by another client (the source client). It is used by the
copy-and-paste and drag-and-drop mechanisms. The offer
describes the different mime types that the data can be
converted to and provides the mechanism for transferring the
data directly from the source client.
</description>
2011-11-15 08:58:34 -05:00
<request name= "accept" >
2013-03-30 01:11:37 -04:00
<description summary= "accept one of the offered mime types" >
Indicate that the client can accept the given mime type, or
NULL for not accepted.
Used for feedback during drag-and-drop.
2012-01-18 19:17:23 -05:00
</description>
Switch protocol to using serial numbers for ordering events and requests
The wayland protocol, as X, uses timestamps to match up certain
requests with input events. The problem is that sometimes we need to
send out an event that doesn't have a corresponding timestamped input
event. For example, the pointer focus surface goes away and new
surface needs to receive a pointer enter event. These events are
normally timestamped with the evdev event timestamp, but in this case,
we don't have a evdev timestamp. So we have to go to gettimeofday (or
clock_gettime()) and then we don't know if it's coming from the same
time source etc.
However for all these cases we don't need a real time timestamp, we
just need a serial number that encodes the order of events inside the
server. So we introduce a serial number mechanism that we can use to
order events. We still need real-time timestamps for actual input
device events (motion, buttons, keys, touch), to be able to reason
about double-click speed and movement speed so events that correspond to user input carry both a serial number and a timestamp.
The serial number also give us a mechanism to key together events that
are "logically the same" such as a unicode event and a keycode event,
or a motion event and a relative event from a raw device.
2012-04-11 22:25:51 -04:00
<arg name= "serial" type= "uint" />
2013-03-30 01:11:37 -04:00
<arg name= "mime_type" type= "string" allow-null= "true" />
2011-11-15 08:58:34 -05:00
</request>
<request name= "receive" >
2012-10-21 22:08:08 -04:00
<description summary= "request that the data is transferred" >
To transfer the offered data, the client issues this request
2013-03-30 01:11:37 -04:00
and indicates the mime type it wants to receive. The transfer
happens through the passed file descriptor (typically created
with the pipe system call). The source client writes the data
in the mime type representation requested and then closes the
file descriptor.
2012-10-21 22:08:08 -04:00
The receiving client reads from the read end of the pipe until
EOF and the closes its end, at which point the transfer is
complete.
</description>
2011-11-15 08:58:34 -05:00
<arg name= "mime_type" type= "string" />
<arg name= "fd" type= "fd" />
</request>
2013-03-30 01:11:37 -04:00
<request name= "destroy" type= "destructor" >
<description summary= "destroy data offer" >
Destroy the data offer.
</description>
</request>
2011-11-15 08:58:34 -05:00
<event name= "offer" >
2013-03-30 01:11:37 -04:00
<description summary= "advertise offered mime type" >
2012-01-18 19:17:23 -05:00
Sent immediately after creating the wl_data_offer object. One
event per offered mime type.
</description>
2013-03-30 01:11:37 -04:00
<arg name= "mime_type" type= "string" />
2011-11-15 08:58:34 -05:00
</event>
</interface>
<interface name= "wl_data_source" version= "1" >
2012-10-21 22:08:08 -04:00
<description summary= "offer to transfer data" >
The wl_data_source object is the source side of a wl_data_offer.
It is created by the source client in a data transfer and
provides a way to describe the offered data and a way to respond
to requests to transfer the data.
</description>
2011-11-15 08:58:34 -05:00
<request name= "offer" >
2012-01-18 19:17:23 -05:00
<description summary= "add an offered mime type" >
2013-03-30 01:11:37 -04:00
This request adds a mime type to the set of mime types
2012-01-18 19:17:23 -05:00
advertised to targets. Can be called several times to offer
multiple types.
</description>
2013-03-30 01:11:37 -04:00
<arg name= "mime_type" type= "string" />
2011-11-15 08:58:34 -05:00
</request>
2012-01-18 19:17:23 -05:00
<request name= "destroy" type= "destructor" >
<description summary= "destroy the data source" >
Destroy the data source.
</description>
</request>
2011-11-15 08:58:34 -05:00
<event name= "target" >
2013-03-30 01:11:37 -04:00
<description summary= "a target accepts an offered mime type" >
2012-01-18 19:17:23 -05:00
Sent when a target accepts pointer_focus or motion events. If
a target does not accept any of the offered types, type is NULL.
2013-03-30 01:11:37 -04:00
Used for feedback during drag-and-drop.
2012-01-18 19:17:23 -05:00
</description>
2012-07-02 20:03:31 +10:00
<arg name= "mime_type" type= "string" allow-null= "true" />
2011-11-15 08:58:34 -05:00
</event>
<event name= "send" >
2012-01-18 19:17:23 -05:00
<description summary= "send the data" >
2013-03-30 01:11:37 -04:00
Request for data from the client. Send the data as the
specified mime type over the passed file descriptor, then
close it.
2012-01-18 19:17:23 -05:00
</description>
2011-11-15 08:58:34 -05:00
<arg name= "mime_type" type= "string" />
<arg name= "fd" type= "fd" />
</event>
2012-01-18 19:17:23 -05:00
<event name= "cancelled" >
<description summary= "selection was cancelled" >
2012-10-21 22:08:08 -04:00
This data source has been replaced by another data source.
The client should clean up and destroy this data source.
2012-01-18 19:17:23 -05:00
</description>
</event>
2011-11-15 08:58:34 -05:00
</interface>
2014-10-13 10:34:26 +05:30
<interface name= "wl_data_device" version= "2" >
2013-03-30 01:11:37 -04:00
<description summary= "data transfer device" >
There is one wl_data_device per seat which can be obtained
from the global wl_data_device_manager singleton.
A wl_data_device provides access to inter-client data transfer
mechanisms such as copy-and-paste and drag-and-drop.
</description>
2014-10-01 12:52:22 +03:00
<enum name= "error" >
<entry name= "role" value= "0" summary= "given wl_surface has another role" />
</enum>
2011-11-15 08:58:34 -05:00
<request name= "start_drag" >
2013-03-30 01:11:37 -04:00
<description summary= "start drag-and-drop operation" >
This request asks the compositor to start a drag-and-drop
2012-05-29 10:58:26 +03:00
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.
2013-03-30 01:11:37 -04:00
The icon surface is an optional (can be NULL) surface that
2012-05-29 10:58:26 +03:00
provides an icon to be moved around with the cursor. Initially,
the top-left corner of the icon surface is placed at the cursor
2012-10-10 12:47:48 +03:00
hotspot, but subsequent wl_surface.attach request can move the
relative position. Attach requests must be confirmed with
2014-08-21 12:38:18 +03:00
wl_surface.commit as usual. The icon surface is given the role of
2014-10-01 12:52:22 +03:00
a drag-and-drop icon. If the icon surface already has another role,
it raises a protocol error.
2012-10-10 12:47:48 +03:00
2012-10-11 13:58:45 +03:00
The current and pending input regions of the icon wl_surface are
2012-10-10 12:47:48 +03:00
cleared, and wl_surface.set_input_region is ignored until the
2012-10-11 13:58:45 +03:00
wl_surface is no longer used as the icon surface. When the use
2014-05-23 07:26:56 +02:00
as an icon ends, the current and pending input regions become
undefined, and the wl_surface is unmapped.
2012-02-15 17:02:52 +02:00
</description>
2012-07-02 20:03:31 +10:00
<arg name= "source" type= "object" interface= "wl_data_source" allow-null= "true" />
2012-02-15 17:02:52 +02:00
<arg name= "origin" type= "object" interface= "wl_surface" />
2012-07-02 20:03:31 +10:00
<arg name= "icon" type= "object" interface= "wl_surface" allow-null= "true" />
2013-03-30 01:11:37 -04:00
<arg name= "serial" type= "uint" summary= "serial of the implicit grab on the origin" />
2011-11-15 08:58:34 -05:00
</request>
<request name= "set_selection" >
2013-03-30 01:11:37 -04:00
<description summary= "copy data to the selection" >
This request asks the compositor to set the selection
to the data from the source on behalf of the client.
To unset the selection, set the source to NULL.
</description>
2012-07-02 14:34:48 -04:00
<arg name= "source" type= "object" interface= "wl_data_source" allow-null= "true" />
2013-03-30 01:11:37 -04:00
<arg name= "serial" type= "uint" summary= "serial of the event that triggered this request" />
2011-11-15 08:58:34 -05:00
</request>
<event name= "data_offer" >
2012-01-18 19:17:23 -05:00
<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
2013-03-30 01:11:37 -04:00
data_device.enter event (for drag-and-drop) or the
2012-01-18 19:17:23 -05:00
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
2013-03-30 01:11:37 -04:00
mime types it offers.
2012-01-18 19:17:23 -05:00
</description>
2011-11-15 08:58:34 -05:00
<arg name= "id" type= "new_id" interface= "wl_data_offer" />
</event>
<event name= "enter" >
2013-03-30 01:11:37 -04:00
<description summary= "initiate drag-and-drop session" >
2012-10-21 22:08:08 -04:00
This event is sent when an active drag-and-drop pointer enters
a surface owned by the client. The position of the pointer at
2013-08-09 01:47:07 +00:00
enter time is provided by the x and y arguments, in surface
2012-10-21 22:08:08 -04:00
local coordinates.
</description>
Switch protocol to using serial numbers for ordering events and requests
The wayland protocol, as X, uses timestamps to match up certain
requests with input events. The problem is that sometimes we need to
send out an event that doesn't have a corresponding timestamped input
event. For example, the pointer focus surface goes away and new
surface needs to receive a pointer enter event. These events are
normally timestamped with the evdev event timestamp, but in this case,
we don't have a evdev timestamp. So we have to go to gettimeofday (or
clock_gettime()) and then we don't know if it's coming from the same
time source etc.
However for all these cases we don't need a real time timestamp, we
just need a serial number that encodes the order of events inside the
server. So we introduce a serial number mechanism that we can use to
order events. We still need real-time timestamps for actual input
device events (motion, buttons, keys, touch), to be able to reason
about double-click speed and movement speed so events that correspond to user input carry both a serial number and a timestamp.
The serial number also give us a mechanism to key together events that
are "logically the same" such as a unicode event and a keycode event,
or a motion event and a relative event from a raw device.
2012-04-11 22:25:51 -04:00
<arg name= "serial" type= "uint" />
2011-11-15 08:58:34 -05:00
<arg name= "surface" type= "object" interface= "wl_surface" />
2012-05-08 17:17:26 +01:00
<arg name= "x" type= "fixed" />
<arg name= "y" type= "fixed" />
2012-07-09 13:15:20 +03:00
<arg name= "id" type= "object" interface= "wl_data_offer" allow-null= "true" />
2011-11-15 08:58:34 -05:00
</event>
2012-10-21 22:08:08 -04:00
<event name= "leave" >
2013-03-30 01:11:37 -04:00
<description summary= "end drag-and-drop session" >
2012-10-21 22:08:08 -04:00
This event is sent when the drag-and-drop pointer leaves the
surface and the session ends. The client must destroy the
wl_data_offer introduced at enter time at this point.
</description>
</event>
2011-11-15 08:58:34 -05:00
<event name= "motion" >
2013-03-30 01:11:37 -04:00
<description summary= "drag-and-drop session motion" >
2012-10-21 22:08:08 -04:00
This event is sent when the drag-and-drop pointer moves within
the currently focused surface. The new position of the pointer
2013-08-09 01:47:07 +00:00
is provided by the x and y arguments, in surface local
2012-10-21 22:08:08 -04:00
coordinates.
</description>
2013-03-30 14:09:24 -04:00
<arg name= "time" type= "uint" summary= "timestamp with millisecond granularity" />
2012-05-08 17:17:26 +01:00
<arg name= "x" type= "fixed" />
<arg name= "y" type= "fixed" />
2011-11-15 08:58:34 -05:00
</event>
2013-03-30 01:11:37 -04:00
<event name= "drop" >
<description summary= "end drag-and-drag session successfully" >
The event is sent when a drag-and-drop operation is ended
because the implicit grab is removed.
</description>
</event>
2011-11-15 08:58:34 -05:00
<event name= "selection" >
2012-01-18 19:17:23 -05:00
<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>
2012-07-02 20:03:31 +10:00
<arg name= "id" type= "object" interface= "wl_data_offer" allow-null= "true" />
2011-11-15 08:58:34 -05:00
</event>
2014-10-13 10:34:26 +05:30
<!-- Version 2 additions -->
<request name= "release" type= "destructor" since= "2" >
<description summary= "destroy data device" >
This request destroys the data device.
</description>
</request>
2011-11-15 08:58:34 -05:00
</interface>
2014-10-13 10:34:26 +05:30
<interface name= "wl_data_device_manager" version= "2" >
2012-11-19 15:44:14 -05:00
<description summary= "data transfer interface" >
2013-08-09 01:47:07 +00:00
The wl_data_device_manager is a singleton global object that
2012-11-19 15:02:45 -05:00
provides access to inter-client data transfer mechanisms such as
2013-03-30 01:11:37 -04:00
copy-and-paste and drag-and-drop. These mechanisms are tied to
2012-11-19 15:02:45 -05:00
a wl_seat and this interface lets a client get a wl_data_device
corresponding to a wl_seat.
</description>
2011-11-15 08:58:34 -05:00
<request name= "create_data_source" >
2013-03-30 01:11:37 -04:00
<description summary= "create a new data source" >
Create a new data source.
</description>
2011-11-15 08:58:34 -05:00
<arg name= "id" type= "new_id" interface= "wl_data_source" />
</request>
<request name= "get_data_device" >
2013-03-30 01:11:37 -04:00
<description summary= "create a new data device" >
Create a new data device for a given seat.
</description>
2011-11-15 08:58:34 -05:00
<arg name= "id" type= "new_id" interface= "wl_data_device" />
2012-05-16 18:44:40 +01:00
<arg name= "seat" type= "object" interface= "wl_seat" />
2011-11-15 08:58:34 -05:00
</request>
</interface>
2011-04-18 10:24:11 -04:00
<interface name= "wl_shell" version= "1" >
2013-03-30 01:11:38 -04:00
<description summary= "create desktop-style surfaces" >
This interface is implemented by servers that provide
desktop-style user interfaces.
It allows clients to associate a wl_shell_surface with
a basic surface.
</description>
2014-10-01 12:52:22 +03:00
<enum name= "error" >
<entry name= "role" value= "0" summary= "given wl_surface has another role" />
</enum>
2011-11-24 16:19:03 +02:00
<request name= "get_shell_surface" >
2013-03-30 01:11:38 -04:00
<description summary= "create a shell surface from a surface" >
2014-08-21 12:50:50 +03:00
Create a shell surface for an existing surface. This gives
2014-10-01 12:52:22 +03:00
the wl_surface the role of a shell surface. If the wl_surface
already has another role, it raises a protocol error.
2013-03-30 01:11:38 -04:00
Only one shell surface can be associated with a given surface.
</description>
2011-11-24 16:19:03 +02:00
<arg name= "id" type= "new_id" interface= "wl_shell_surface" />
2011-04-18 10:24:11 -04:00
<arg name= "surface" type= "object" interface= "wl_surface" />
2011-11-24 16:19:03 +02:00
</request>
</interface>
<interface name= "wl_shell_surface" version= "1" >
2012-01-18 19:17:23 -05:00
2013-03-30 01:11:38 -04:00
<description summary= "desktop-style metadata interface" >
An interface that may be implemented by a wl_surface, for
implementations that provide a desktop-style user interface.
It provides requests to treat surfaces like toplevel, fullscreen
or popup windows, move, resize or maximize them, associate
metadata like title and class, etc.
On the 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.
2012-01-18 19:17:23 -05:00
</description>
2012-04-16 11:25:39 -06:00
<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>
2013-03-30 01:11:38 -04:00
<arg name= "serial" type= "uint" summary= "serial of the ping event" />
2012-04-16 11:25:39 -06:00
</request>
2011-11-24 16:19:03 +02:00
<request name= "move" >
2013-03-30 01:11:38 -04:00
<description summary= "start an interactive move" >
Start a pointer-driven move of the surface.
This request must be used in response to a button press event.
The server may ignore move requests depending on the state of
the surface (e.g. fullscreen or maximized).
</description>
<arg name= "seat" type= "object" interface= "wl_seat" summary= "the wl_seat whose pointer is used" />
<arg name= "serial" type= "uint" summary= "serial of the implicit grab on the pointer" />
2010-08-03 09:26:44 -04:00
</request>
2011-01-21 21:57:55 -05:00
<enum name= "resize" >
2013-03-30 01:11:38 -04:00
<description summary= "edge values for resizing" >
These values are used to indicate which edge of a surface
is being dragged in a resize operation. The server may
use this information to adapt its behavior, e.g. choose
an appropriate cursor image.
</description>
2011-01-21 21:57:55 -05:00
<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>
2010-08-03 09:26:44 -04:00
<request name= "resize" >
2013-03-30 01:11:38 -04:00
<description summary= "start an interactive resize" >
Start a pointer-driven resizing of the surface.
This request must be used in response to a button press event.
The server may ignore resize requests depending on the state of
the surface (e.g. fullscreen or maximized).
</description>
<arg name= "seat" type= "object" interface= "wl_seat" summary= "the wl_seat whose pointer is used" />
<arg name= "serial" type= "uint" summary= "serial of the implicit grab on the pointer" />
<arg name= "edges" type= "uint" summary= "which edge or corner is being dragged" />
2010-08-03 09:26:44 -04:00
</request>
2012-01-18 19:17:23 -05:00
<request name= "set_toplevel" >
2013-03-30 01:11:38 -04:00
<description summary= "make the surface a toplevel surface" >
Map the surface as a toplevel surface.
A toplevel surface is not fullscreen, maximized or transient.
2012-01-18 19:17:23 -05:00
</description>
</request>
2012-05-21 16:47:44 +03:00
<enum name= "transient" >
2013-03-30 01:11:38 -04:00
<description summary= "details of transient behaviour" >
These flags specify details of the expected behaviour
of transient surfaces. Used in the set_transient request.
</description>
2012-05-21 16:47:44 +03:00
<entry name= "inactive" value= "0x1" summary= "do not set keyboard focus" />
</enum>
2011-06-18 08:17:40 -04:00
<request name= "set_transient" >
2012-01-18 19:17:23 -05:00
<description summary= "make the surface a transient surface" >
2013-03-30 01:11:38 -04:00
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
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
parent surface, in surface local coordinates.
2013-03-30 01:11:38 -04:00
The flags argument controls details of the transient behaviour.
2012-01-18 19:17:23 -05:00
</description>
2012-06-27 10:30:08 -04:00
<arg name= "parent" type= "object" interface= "wl_surface" />
2011-06-18 08:17:40 -04:00
<arg name= "x" type= "int" />
<arg name= "y" type= "int" />
<arg name= "flags" type= "uint" />
</request>
2013-03-30 01:11:38 -04:00
<enum name= "fullscreen_method" >
<description summary= "different method to set the surface fullscreen" >
Hints to indicate to the compositor how to deal with a conflict
between the dimensions of the surface and the dimensions of the
output. The compositor is free to ignore this parameter.
</description>
<entry name= "default" value= "0" summary= "no preference, apply default policy" />
<entry name= "scale" value= "1" summary= "scale, preserve the surface's aspect ratio and center on output" />
<entry name= "driver" value= "2" summary= "switch output mode to the smallest mode that can fit the surface, add black borders to compensate size mismatch" />
2013-05-28 16:20:52 +02:00
<entry name= "fill" value= "3" summary= "no upscaling, center on output and add black borders to compensate size mismatch" />
2013-03-30 01:11:38 -04:00
</enum>
2012-01-18 19:17:23 -05:00
<request name= "set_fullscreen" >
<description summary= "make the surface a fullscreen surface" >
2013-03-30 01:11:38 -04:00
Map the surface as a fullscreen surface.
2012-02-28 16:48:26 +00:00
2013-03-30 01:11:38 -04:00
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.
2012-02-28 16:48:26 +00:00
2013-03-30 01:11:38 -04:00
The client may specify a method to resolve a size conflict
between the output size and the surface size - this is provided
through the method parameter.
2012-02-28 16:48:26 +00:00
2013-03-30 01:11:38 -04:00
The framerate parameter is used only when the method is set
to "driver", to indicate the preferred framerate. A value of 0
indicates that the app does not care about framerate. The
framerate is specified in mHz, that is framerate of 60000 is 60Hz.
2013-05-28 16:20:52 +02:00
A method of "scale" or "driver" implies a scaling operation of
the surface, either via a direct scaling operation or a change of
the output mode. This will override any kind of output scaling, so
that mapping a surface with a buffer size equal to the mode can
fill the screen independent of buffer_scale.
A method of "fill" means we don't scale up the buffer, however
any output scale is applied. This means that you may run into
an edge case where the application maps a buffer with the same
size of the output mode but buffer_scale 1 (thus making a
surface larger than the output). In this case it is allowed to
downscale the results to fit the screen.
2013-03-30 01:11:38 -04:00
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.
2012-01-18 19:17:23 -05:00
</description>
2012-02-07 13:39:36 +08:00
<arg name= "method" type= "uint" />
<arg name= "framerate" type= "uint" />
2012-07-02 20:03:31 +10:00
<arg name= "output" type= "object" interface= "wl_output" allow-null= "true" />
2012-01-18 19:17:23 -05:00
</request>
2013-03-30 01:11:38 -04:00
<request name= "set_popup" >
<description summary= "make the surface a popup surface" >
Map the surface as a popup.
2012-02-28 16:48:26 +00:00
2013-03-30 01:11:38 -04:00
A popup surface is a transient surface with an added pointer
grab.
2012-02-28 16:48:26 +00:00
2013-03-30 01:11:38 -04:00
An existing implicit grab will be changed to owner-events mode,
and the popup grab will continue after the implicit grab ends
(i.e. releasing the mouse button does not cause the popup to
be unmapped).
2012-02-28 16:48:26 +00:00
2013-03-30 01:11:38 -04:00
The popup grab continues until the window is destroyed or a
mouse button is pressed in any other clients window. A click
2012-01-18 19:17:23 -05:00
in any of the clients surfaces is reported as normal, however,
clicks in other clients surfaces will be discarded and trigger
the callback.
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
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, in surface local coordinates.
2012-01-18 19:17:23 -05:00
</description>
2013-03-30 01:11:38 -04:00
<arg name= "seat" type= "object" interface= "wl_seat" summary= "the wl_seat whose pointer is used" />
<arg name= "serial" type= "uint" summary= "serial of the implicit grab on the pointer" />
2012-06-27 10:30:08 -04:00
<arg name= "parent" type= "object" interface= "wl_surface" />
2012-01-05 08:50:25 -05:00
<arg name= "x" type= "int" />
<arg name= "y" type= "int" />
<arg name= "flags" type= "uint" />
</request>
2012-02-07 09:38:10 +08:00
<request name= "set_maximized" >
<description summary= "make the surface a maximized surface" >
2013-03-30 01:11:38 -04:00
Map the surface as a maximized surface.
If an output parameter is given then the surface will be
maximized 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 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 surface typically fills the entire output it is
bound to, except for desktop element such as panels. This is
the main difference between a maximized shell surface and a
fullscreen shell surface.
The details depend on the compositor implementation.
2012-02-07 09:38:10 +08:00
</description>
2012-07-02 20:03:31 +10:00
<arg name= "output" type= "object" interface= "wl_output" allow-null= "true" />
2012-02-07 09:38:10 +08:00
</request>
2012-05-02 09:39:17 -04:00
<request name= "set_title" >
<description summary= "set surface title" >
2013-03-30 01:11:38 -04:00
Set a short title for the surface.
This string may be used to identify the surface in a task bar,
window list, or other user interface elements provided by the
compositor.
The string must be encoded in UTF-8.
2012-05-02 09:39:17 -04:00
</description>
<arg name= "title" type= "string" />
</request>
<request name= "set_class" >
<description summary= "set surface class" >
2013-03-30 01:11:38 -04:00
Set a class for the surface.
2012-05-02 09:39:17 -04:00
The surface class identifies the general class of applications
2013-08-09 01:47:07 +00:00
to which the surface belongs. A common convention is to use the
file name (or the full path if it is a non-standard location) of
the application's .desktop file as the class.
2012-05-02 09:39:17 -04:00
</description>
2012-05-03 15:41:50 -04:00
<arg name= "class_" type= "string" />
2012-05-02 09:39:17 -04:00
</request>
2012-05-01 13:50:23 -04:00
<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>
2010-08-03 09:26:44 -04:00
<event name= "configure" >
2012-01-18 19:17:23 -05:00
<description summary= "suggest resize" >
The configure event asks the client to resize its surface.
2013-03-30 01:11:38 -04:00
2012-01-18 19:17:23 -05:00
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
2013-03-30 01:11:38 -04:00
satisfy aspect ratio or resize in steps of NxM pixels).
The edges parameter provides a hint about how the surface
was resized. The client may use this information to decide
how to adjust its content to the new size (e.g. a scrolling
area might adjust its content position to leave the viewable
content unmoved).
The client is free to dismiss all but the last configure
event it received.
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
The width and height arguments specify the size of the window
in surface local coordinates.
2012-01-18 19:17:23 -05:00
</description>
2010-12-17 09:53:12 -05:00
<arg name= "edges" type= "uint" />
2010-08-03 09:26:44 -04:00
<arg name= "width" type= "int" />
<arg name= "height" type= "int" />
</event>
2012-01-05 08:50:25 -05:00
2012-01-18 19:17:23 -05:00
<event name= "popup_done" >
<description summary= "popup interaction is done" >
The popup_done event is sent out when a popup grab is broken,
2013-08-09 01:47:07 +00:00
that is, when the user clicks a surface that doesn't belong
2012-01-18 19:17:23 -05:00
to the client owning the popup surface.
</description>
</event>
2010-08-03 09:26:44 -04:00
</interface>
2010-08-17 21:23:10 -04:00
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
<interface name= "wl_surface" version= "3" >
2012-01-18 19:17:23 -05:00
<description summary= "an onscreen surface" >
2013-03-30 01:11:39 -04:00
A surface is a rectangular area that is displayed on the screen.
2012-01-18 19:17:23 -05:00
It has a location, size and pixel contents.
2013-03-30 01:11:39 -04:00
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
The size of a surface (and relative positions on it) is described
in surface local coordinates, which may differ from the buffer
local coordinates of the pixel content, in case a buffer_transform
or a buffer_scale is used.
2014-08-18 17:07:34 +03:00
A surface without a "role" is fairly useless, a compositor does
not know where, when or how to present it. The role is the
purpose of a wl_surface. Examples of roles are a cursor for a
pointer (as set by wl_pointer.set_cursor), a drag icon
(wl_data_device.start_drag), a sub-surface
(wl_subcompositor.get_subsurface), and a window as defined by a
shell protocol (e.g. wl_shell.get_shell_surface).
A surface can have only one role at a time. Initially a
wl_surface does not have a role. Once a wl_surface is given a
role, it is set permanently for the whole lifetime of the
wl_surface object. Giving the current role again is allowed,
unless explicitly forbidden by the relevant interface
specification.
Surface roles are given by requests in other interfaces such as
wl_pointer.set_cursor. The request should explicitly mention
that this request gives a role to a wl_surface. Often, this
request also creates a new protocol object that represents the
role and adds additional functionality to wl_surface. When a
client wants to destroy a wl_surface, they must destroy this 'role
object' before the wl_surface.
Destroying the role object does not remove the role from the
wl_surface, but it may stop the wl_surface from "playing the role".
For instance, if a wl_subsurface object is destroyed, the wl_surface
it was created for will be unmapped and forget its position and
z-order. It is allowed to create a wl_subsurface for the same
wl_surface again, but it is not allowed to use the wl_surface as
a cursor (cursor is a different role than sub-surface, and role
switching is not allowed).
2012-01-18 19:17:23 -05:00
</description>
2014-05-30 12:08:16 +02:00
<enum name= "error" >
<description summary= "wl_surface error values" >
These errors can be emitted in response to wl_surface requests.
</description>
<entry name= "invalid_scale" value= "0" summary= "buffer scale value is invalid" />
<entry name= "invalid_transform" value= "1" summary= "buffer transform value is invalid" />
</enum>
2012-01-18 19:17:23 -05:00
<request name= "destroy" type= "destructor" >
<description summary= "delete surface" >
2013-03-30 01:11:39 -04:00
Deletes the surface and invalidates its object ID.
2012-01-18 19:17:23 -05:00
</description>
</request>
2010-08-03 09:26:44 -04:00
<request name= "attach" >
2012-01-18 19:17:23 -05:00
<description summary= "set the surface contents" >
2013-03-30 01:11:39 -04:00
Set a buffer as the content of this surface.
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
The new size of the surface is calculated based on the buffer
size transformed by the inverse buffer_transform and the
inverse buffer_scale. This means that the supplied buffer
must be an integer multiple of the buffer_scale.
2013-03-30 01:11:39 -04:00
The x and y arguments specify the location of the new pending
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
buffer's upper left corner, relative to the current buffer's upper
left corner, in surface local coordinates. In other words, the
x and y, combined with the new surface size define in which
directions the surface's size changes.
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
Surface contents are double-buffered state, see wl_surface.commit.
The initial surface contents are void; there is no content.
2013-03-30 01:11:39 -04:00
wl_surface.attach assigns the given wl_buffer as the pending
wl_buffer. wl_surface.commit makes the pending wl_buffer the new
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
surface contents, and the size of the surface becomes the size
calculated from the wl_buffer, as described above. After commit,
there is no pending buffer until the next attach.
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
Committing a pending wl_buffer allows the compositor to read the
2013-03-30 01:11:39 -04:00
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 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.
Destroying the wl_buffer after wl_buffer.release does not change
the surface contents. However, if the client destroys the
2013-08-09 17:44:59 +00:00
wl_buffer before receiving the wl_buffer.release event, the surface
2013-03-30 01:11:39 -04:00
contents become undefined immediately.
2013-08-09 17:44:59 +00:00
If wl_surface.attach is sent with a NULL wl_buffer, the
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
following wl_surface.commit will remove the surface content.
2012-01-18 19:17:23 -05:00
</description>
2012-07-02 14:34:48 -04:00
<arg name= "buffer" type= "object" interface= "wl_buffer" allow-null= "true" />
2010-08-03 09:26:44 -04:00
<arg name= "x" type= "int" />
<arg name= "y" type= "int" />
</request>
<request name= "damage" >
2012-01-18 19:17:23 -05:00
<description summary= "mark part of the surface damaged" >
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
This request is used to describe the regions where the pending
2013-03-07 13:10:01 +02:00
buffer is different from the current surface contents, and where
2013-03-30 01:11:39 -04:00
the surface therefore needs to be repainted. The pending buffer
must be set by wl_surface.attach before sending damage. The
compositor ignores the parts of the damage that fall outside of
the surface.
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
Damage is double-buffered state, see wl_surface.commit.
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
The damage rectangle is specified in surface local coordinates.
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
The initial value for pending damage is empty: no damage.
2013-03-30 01:11:39 -04:00
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.
2012-01-18 19:17:23 -05:00
</description>
2010-08-03 09:26:44 -04:00
<arg name= "x" type= "int" />
<arg name= "y" type= "int" />
<arg name= "width" type= "int" />
<arg name= "height" type= "int" />
</request>
2011-07-29 19:51:22 -07:00
<request name= "frame" >
2014-02-24 10:00:33 +02:00
<description summary= "request a frame throttling hint" >
Request a notification when it is a good time start drawing a new
frame, by creating a frame callback. This is useful for throttling
redrawing operations, and driving animations.
When a client is animating on a wl_surface, it can use the 'frame'
request to get notified when it is a good time to draw and commit the
next frame of animation. If the client commits an update earlier than
that, it is likely that some updates will not make it to the display,
and the client is wasting resources by drawing too often.
2012-10-10 12:47:49 +03:00
The frame request will take effect on the next wl_surface.commit.
2012-01-18 19:17:23 -05:00
The notification will only be posted for one frame unless
2014-02-24 10:00:33 +02:00
requested again. For a wl_surface, the notifications are posted in
the order the frame requests were committed.
The server must send the notifications so that a client
will not send excessive updates, while still allowing
the highest possible update rate for clients that wait for the reply
before drawing again. The server should give some time for the client
to draw and commit after sending the frame callback events to let them
hit the next output refresh.
2012-10-10 12:47:49 +03:00
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.
2013-04-17 18:28:42 +01:00
The object returned by this request will be destroyed by the
compositor after the callback is fired and as such the client must not
attempt to use it after that point.
2014-01-31 15:55:48 -05:00
2014-01-31 16:29:37 -05:00
The callback_data passed in the callback is the current time, in
2014-08-21 00:25:36 +09:00
milliseconds, with an undefined base.
2012-01-18 19:17:23 -05:00
</description>
2011-07-29 19:51:22 -07:00
<arg name= "callback" type= "new_id" interface= "wl_callback" />
</request>
2012-02-23 14:50:06 -05:00
<request name= "set_opaque_region" >
<description summary= "set opaque region" >
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
This request sets the region of the surface that contains
2013-03-30 01:11:39 -04:00
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.
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
The opaque region is specified in surface local coordinates.
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
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.
2013-03-30 01:11:39 -04:00
Otherwise, the pending and current regions are never changed.
2012-02-23 14:50:06 -05:00
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
The initial value for opaque region is empty. Setting the pending
opaque region has copy semantics, and the wl_region object can be
2013-03-30 01:11:39 -04:00
destroyed immediately. A NULL wl_region causes the pending opaque
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
region to be set to empty.
2012-02-23 14:50:06 -05:00
</description>
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
<arg name= "region" type= "object" interface= "wl_region" allow-null= "true" />
2012-02-23 14:50:06 -05:00
</request>
<request name= "set_input_region" >
<description summary= "set input region" >
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
This request sets the region of the surface that can receive
2013-03-30 01:11:39 -04:00
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.
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
The input region is specified in surface local coordinates.
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
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.
2012-10-10 12:47:48 +03:00
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.
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
2013-03-30 01:11:39 -04:00
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 NULL wl_region causes the input region to be set
to infinite.
2012-02-23 14:50:06 -05:00
</description>
2012-07-02 20:03:31 +10:00
<arg name= "region" type= "object" interface= "wl_region" allow-null= "true" />
2012-02-23 14:50:06 -05:00
</request>
2012-04-17 17:22:45 -04:00
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
<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
2013-03-07 13:10:01 +02:00
wl_surface.attach itself. If there is no pending wl_buffer, the
protocol: double-buffered state for wl_surface
This change breaks the protocol.
The current protocol is racy in that updates to surface content and
surface state (e.g. damage, input and opaque regions) are not guaranteed
to happen at the same time. Due to protocol buffering and handling
practices, the issues are very hard to trigger.
Committing damage to a surface at arbitrary times makes it hard to
track when the wl_buffer is being read by the server, and when it is
safe to overwrite (the case of wl_shm with a single buffer reused
constantly).
This protocol change introduces the concept of double-buffered state.
Such state is accumulated and cached in the server, unused, until the
final commit request. The surface will receive its new content and apply
its new state atomically.
A wl_surface.commit request is added to the protocol. This is thought to
be more clear, than having wl_surface.attach committing implicitly, and
then having another request to commit without attaching, as would be
required for a GL app that wants to change e.g. input region without
redrawing.
When these changes are implemented, clients do not have to worry about
ordering damage vs. input region vs. attach vs. ... anymore. Clients set
the state in any order they want, and kick it all in with a commit.
The interactions between wl_surface.attach, (wl_surface.commit,)
wl_buffer.release, and wl_buffer.destroy have been undocumented. Only
careful inspection of the compositor code has told when a wl_buffer is
free for re-use, especially for wl_shm and wrt. wl_surface.damage.
Try to clarify how it all should work, and what happens if the wl_buffer
gets destroyed.
An additional minor fix: allow NULL argument to
wl_surface.set_opaque_region. The wording in the documentation already
implied that a nil region is allowed.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-10 12:47:47 +03:00
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>
2012-04-17 17:22:45 -04:00
<event name= "enter" >
<description summary= "surface enters an output" >
2013-03-30 01:11:39 -04:00
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.
Note that a surface may be overlapping with zero or more outputs.
2012-04-17 17:22:45 -04:00
</description>
<arg name= "output" type= "object" interface= "wl_output" />
</event>
<event name= "leave" >
<description summary= "surface leaves an output" >
2013-03-30 01:11:39 -04:00
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.
2012-04-17 17:22:45 -04:00
</description>
<arg name= "output" type= "object" interface= "wl_output" />
</event>
2012-11-27 17:03:41 +02:00
<!-- Version 2 additions -->
<request name= "set_buffer_transform" since= "2" >
<description summary= "sets the buffer transformation" >
This request sets an optional transformation on how the compositor
interprets the contents of the buffer attached to the surface. The
accepted values for the transform parameter are the values for
wl_output.transform.
Buffer transform is double-buffered state, see wl_surface.commit.
A newly created surface has its buffer transformation set to normal.
2014-02-07 11:13:01 +02:00
wl_surface.set_buffer_transform changes the pending buffer
transformation. wl_surface.commit copies the pending buffer
transformation to the current one. Otherwise, the pending and current
values are never changed.
2012-11-27 17:03:41 +02:00
The purpose of this request is to allow clients to render content
according to the output transform, thus permiting the compositor to
use certain optimizations even if the display is rotated. Using
hardware overlays and scanning out a client buffer for fullscreen
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
surfaces are examples of such optimizations. Those optimizations are
2012-11-27 17:03:41 +02:00
highly dependent on the compositor implementation, so the use of this
request should be considered on a case-by-case basis.
Note that if the transform value includes 90 or 270 degree rotation,
the width of the buffer will become the surface height and the height
of the buffer will become the surface width.
2014-05-30 12:08:16 +02:00
If transform is not one of the values from the
wl_output.transform enum the invalid_transform protocol error
is raised.
2012-11-27 17:03:41 +02:00
</description>
<arg name= "transform" type= "int" />
</request>
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
<!-- Version 3 additions -->
<request name= "set_buffer_scale" since= "3" >
<description summary= "sets the buffer scaling factor" >
This request sets an optional scaling factor on how the compositor
interprets the contents of the buffer attached to the window.
Buffer scale is double-buffered state, see wl_surface.commit.
A newly created surface has its buffer scale set to 1.
2014-02-07 11:13:01 +02:00
wl_surface.set_buffer_scale changes the pending buffer scale.
wl_surface.commit copies the pending buffer scale to the current one.
Otherwise, the pending and current values are never changed.
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
The purpose of this request is to allow clients to supply higher
resolution buffer data for use on high resolution outputs. Its
intended that you pick the same buffer scale as the scale of the
output that the surface is displayed on.This means the compositor
can avoid scaling when rendering the surface on that output.
Note that if the scale is larger than 1, then you have to attach
a buffer that is larger (by a factor of scale in each dimension)
than the desired surface size.
2014-05-30 12:08:16 +02:00
If scale is not positive the invalid_scale protocol error is
raised.
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
</description>
2013-05-24 13:08:41 +02:00
<arg name= "scale" type= "int" />
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
</request>
2012-11-27 17:03:41 +02:00
</interface>
2010-08-03 09:26:44 -04:00
2014-07-22 17:39:18 +01:00
<interface name= "wl_seat" version= "4" >
2013-03-30 01:11:40 -04:00
<description summary= "group of input devices" >
2013-04-03 15:27:43 -04:00
A seat is a group of keyboards, pointer 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.
2012-01-18 19:17:23 -05:00
</description>
2012-05-16 18:44:40 +01:00
<enum name= "capability" >
<description summary= "seat capability bitmask" >
This is a bitmask of capabilities this seat has; if a member is
2013-03-30 01:11:40 -04:00
set, then it is present on the seat.
2012-05-16 18:44:40 +01:00
</description>
2013-03-30 01:11:40 -04:00
<entry name= "pointer" value= "1" summary= "The seat has pointer devices" />
<entry name= "keyboard" value= "2" summary= "The seat has one or more keyboards" />
<entry name= "touch" value= "4" summary= "The seat has touch devices" />
2012-05-16 18:44:40 +01:00
</enum>
<event name= "capabilities" >
<description summary= "seat capabilities changed" >
This is emitted whenever a seat gains or loses the pointer,
2013-03-30 01:11:40 -04:00
keyboard or touch capabilities. The argument is a capability
2012-05-16 18:44:40 +01:00
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.
2013-03-30 01:11:40 -04:00
This request only takes effect if the seat has the pointer
capability.
2012-05-16 18:44:40 +01:00
</description>
<arg name= "id" type= "new_id" interface= "wl_pointer" />
</request>
<request name= "get_keyboard" >
2013-03-30 01:11:40 -04:00
<description summary= "return keyboard object" >
2012-05-16 18:44:40 +01:00
The ID provided will be initialized to the wl_keyboard interface
for this seat.
2013-03-30 01:11:40 -04:00
This request only takes effect if the seat has the keyboard
capability.
2012-05-16 18:44:40 +01:00
</description>
<arg name= "id" type= "new_id" interface= "wl_keyboard" />
</request>
<request name= "get_touch" >
2013-03-30 01:11:40 -04:00
<description summary= "return touch object" >
2012-05-16 18:44:40 +01:00
The ID provided will be initialized to the wl_touch interface
for this seat.
2013-03-30 01:11:40 -04:00
This request only takes effect if the seat has the touch
capability.
2012-05-16 18:44:40 +01:00
</description>
<arg name= "id" type= "new_id" interface= "wl_touch" />
</request>
2013-06-05 01:07:28 -04:00
<!-- Version 2 of additions -->
2013-06-12 18:17:45 +01:00
<event name= "name" since= "2" >
2013-06-05 01:07:28 -04:00
<description summary= "unique identifier for this seat" >
In a multiseat configuration this can be used by the client to help
identify which physical devices the seat represents. Based on
the seat configuration used by the compositor.
</description>
<arg name= "name" type= "string" />
</event>
2012-05-16 18:44:40 +01:00
</interface>
2013-08-13 20:06:29 +01:00
<interface name= "wl_pointer" version= "3" >
2013-03-30 01:11:41 -04:00
<description summary= "pointer input device" >
The wl_pointer interface represents one or more input devices,
such as mice, which control the pointer location and pointer_focus
of a seat.
The wl_pointer interface generates motion, enter and leave
events for the surfaces that the pointer is located over,
and button and axis events for button presses, button releases
and scrolling.
</description>
2014-10-01 12:52:22 +03:00
<enum name= "error" >
<entry name= "role" value= "0" summary= "given wl_surface has another role" />
</enum>
2012-06-15 17:27:32 +03:00
<request name= "set_cursor" >
<description summary= "set the pointer surface" >
Set the pointer surface, i.e., the surface that contains the
2014-08-21 12:32:56 +03:00
pointer image (cursor). This request gives the surface the role
2014-10-01 12:52:22 +03:00
of a cursor. If the surface already has another role, it raises
a protocol error.
2014-08-21 12:32:56 +03:00
The cursor actually changes only if the pointer
2012-10-11 13:58:45 +03:00
focus for this device is one of the requesting client's surfaces
2012-06-28 18:08:03 +03:00
or the surface parameter is the current pointer surface. If
there was a previous surface set with this request it is
2012-06-15 17:27:32 +03:00
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),
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
where (x, y) are the coordinates of the pointer location, in surface
local coordinates.
2012-06-15 17:27:32 +03:00
On surface.attach requests to the pointer surface, hotspot_x
and hotspot_y are decremented by the x and y parameters
2012-10-10 12:47:48 +03:00
passed to the request. Attach must be confirmed by
wl_surface.commit as usual.
2012-06-15 17:27:32 +03:00
2012-10-11 13:58:45 +03:00
The hotspot can also be updated by passing the currently set
2012-06-15 17:27:32 +03:00
pointer surface to this request with new values for hotspot_x
2012-10-11 13:58:45 +03:00
and hotspot_y.
2012-10-10 12:47:48 +03:00
The current and pending input regions of the wl_surface are
cleared, and wl_surface.set_input_region is ignored until the
2012-10-11 13:58:45 +03:00
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.
2012-01-18 19:17:23 -05:00
</description>
2013-03-30 01:11:41 -04:00
<arg name= "serial" type= "uint" summary= "serial of the enter event" />
2012-07-02 20:03:31 +10:00
<arg name= "surface" type= "object" interface= "wl_surface" allow-null= "true" />
2013-04-18 06:33:01 +10:00
<arg name= "hotspot_x" type= "int" summary= "x coordinate in surface-relative coordinates" />
<arg name= "hotspot_y" type= "int" summary= "y coordinate in surface-relative coordinates" />
2010-08-16 10:38:29 -04:00
</request>
2012-05-16 18:44:40 +01:00
<event name= "enter" >
<description summary= "enter event" >
Notification that this seat's pointer is focused on a certain
2013-03-30 01:11:41 -04:00
surface.
When an seat's focus enters a surface, the pointer image
2012-05-16 18:44:40 +01:00
is undefined and a client should respond to this event by setting
2013-03-30 01:11:41 -04:00
an appropriate pointer image with the set_cursor request.
2012-05-16 18:44:40 +01:00
</description>
<arg name= "serial" type= "uint" />
<arg name= "surface" type= "object" interface= "wl_surface" />
2013-04-02 09:58:17 +10:00
<arg name= "surface_x" type= "fixed" summary= "x coordinate in surface-relative coordinates" />
<arg name= "surface_y" type= "fixed" summary= "y coordinate in surface-relative coordinates" />
2012-05-16 18:44:40 +01:00
</event>
<event name= "leave" >
<description summary= "leave event" >
2013-03-30 01:11:41 -04:00
Notification that this seat's pointer is no longer focused on
a certain surface.
The leave notification is sent before the enter notification
for the new focus.
2012-05-16 18:44:40 +01:00
</description>
<arg name= "serial" type= "uint" />
<arg name= "surface" type= "object" interface= "wl_surface" />
</event>
2010-08-03 09:26:44 -04:00
<event name= "motion" >
2012-01-18 19:17:23 -05:00
<description summary= "pointer motion event" >
2013-03-30 01:11:41 -04:00
Notification of pointer location change. The arguments
surface_x and surface_y are the location relative to the
focused surface.
2012-01-18 19:17:23 -05:00
</description>
2013-03-30 14:09:24 -04:00
<arg name= "time" type= "uint" summary= "timestamp with millisecond granularity" />
2013-04-02 09:58:17 +10:00
<arg name= "surface_x" type= "fixed" summary= "x coordinate in surface-relative coordinates" />
<arg name= "surface_y" type= "fixed" summary= "y coordinate in surface-relative coordinates" />
2010-08-03 09:26:44 -04:00
</event>
2012-05-30 16:31:48 +01:00
<enum name= "button_state" >
<description summary= "physical button state" >
Describes the physical state of a button which provoked the button
event.
</description>
2013-03-30 01:11:41 -04:00
<entry name= "released" value= "0" summary= "The button is not pressed" />
<entry name= "pressed" value= "1" summary= "The button is pressed" />
2012-05-30 16:31:48 +01:00
</enum>
2010-08-03 09:26:44 -04:00
<event name= "button" >
2012-01-18 19:17:23 -05:00
<description summary= "pointer button event" >
2013-03-30 01:11:41 -04:00
Mouse button click and release notifications.
The location of the click is given by the last motion or
enter event.
2013-03-30 14:09:24 -04:00
The time argument is a timestamp with millisecond
granularity, with an undefined base.
2012-01-18 19:17:23 -05:00
</description>
Switch protocol to using serial numbers for ordering events and requests
The wayland protocol, as X, uses timestamps to match up certain
requests with input events. The problem is that sometimes we need to
send out an event that doesn't have a corresponding timestamped input
event. For example, the pointer focus surface goes away and new
surface needs to receive a pointer enter event. These events are
normally timestamped with the evdev event timestamp, but in this case,
we don't have a evdev timestamp. So we have to go to gettimeofday (or
clock_gettime()) and then we don't know if it's coming from the same
time source etc.
However for all these cases we don't need a real time timestamp, we
just need a serial number that encodes the order of events inside the
server. So we introduce a serial number mechanism that we can use to
order events. We still need real-time timestamps for actual input
device events (motion, buttons, keys, touch), to be able to reason
about double-click speed and movement speed so events that correspond to user input carry both a serial number and a timestamp.
The serial number also give us a mechanism to key together events that
are "logically the same" such as a unicode event and a keycode event,
or a motion event and a relative event from a raw device.
2012-04-11 22:25:51 -04:00
<arg name= "serial" type= "uint" />
2013-03-30 14:09:24 -04:00
<arg name= "time" type= "uint" summary= "timestamp with millisecond granularity" />
2010-08-03 09:26:44 -04:00
<arg name= "button" type= "uint" />
<arg name= "state" type= "uint" />
</event>
2012-03-20 09:10:18 -06:00
<enum name= "axis" >
2013-03-30 01:11:41 -04:00
<description summary= "axis types" >
Describes the axis types of scroll events.
</description>
2012-03-20 09:10:18 -06:00
<entry name= "vertical_scroll" value= "0" />
<entry name= "horizontal_scroll" value= "1" />
</enum>
<event name= "axis" >
<description summary= "axis event" >
2012-10-03 22:50:55 +02:00
Scroll and other axis notifications.
For scroll events (vertical and horizontal scroll axes), the
value parameter is the length of a vector along the specified
axis in a coordinate space identical to those of motion events,
representing a relative movement along the specified axis.
For devices that support movements non-parallel to axes multiple
axis events will be emitted.
When applicable, for example for touch pads, the server can
choose to emit scroll events where the motion vector is
equivalent to a motion event vector.
When applicable, clients can transform its view relative to the
scroll distance.
2012-03-20 09:10:18 -06:00
</description>
2013-03-30 14:09:24 -04:00
<arg name= "time" type= "uint" summary= "timestamp with millisecond granularity" />
2012-03-20 09:10:18 -06:00
<arg name= "axis" type= "uint" />
2012-05-30 16:31:49 +01:00
<arg name= "value" type= "fixed" />
2012-03-20 09:10:18 -06:00
</event>
2014-05-09 18:10:32 +02:00
<!-- Version 3 additions -->
<request name= "release" type= "destructor" since= "3" >
<description summary= "release the pointer object" />
</request>
2012-05-16 18:44:40 +01:00
</interface>
2012-03-20 09:10:18 -06:00
2014-07-22 17:39:18 +01:00
<interface name= "wl_keyboard" version= "4" >
2012-05-16 18:44:40 +01:00
<description summary= "keyboard input device" >
2013-03-30 01:11:42 -04:00
The wl_keyboard interface represents one or more keyboards
associated with a seat.
2012-05-16 18:44:40 +01:00
</description>
2012-01-18 19:17:23 -05:00
2012-06-01 12:13:37 +01:00
<enum name= "keymap_format" >
<description summary= "keyboard mapping format" >
2013-03-30 01:11:42 -04:00
This specifies the format of the keymap provided to the
client with the wl_keyboard.keymap event.
2012-06-01 12:13:37 +01:00
</description>
2013-06-24 16:50:41 +01:00
<entry name= "no_keymap" value= "0"
summary="no keymap; client must understand how to interpret the raw keycode"/>
2014-03-25 16:35:39 +01:00
<entry name= "xkb_v1" value= "1"
summary="libxkbcommon compatible; to determine the xkb keycode, clients must add 8 to the key event keycode"/>
2012-06-01 12:13:37 +01:00
</enum>
<event name= "keymap" >
<description summary= "keyboard mapping" >
2013-03-30 01:11:42 -04:00
This event provides a file descriptor to the client which can be
2012-06-01 12:13:37 +01:00
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>
2012-05-16 18:44:40 +01:00
<event name= "enter" >
2013-03-30 01:11:42 -04:00
<description summary= "enter event" >
Notification that this seat's keyboard focus is on a certain
surface.
</description>
Switch protocol to using serial numbers for ordering events and requests
The wayland protocol, as X, uses timestamps to match up certain
requests with input events. The problem is that sometimes we need to
send out an event that doesn't have a corresponding timestamped input
event. For example, the pointer focus surface goes away and new
surface needs to receive a pointer enter event. These events are
normally timestamped with the evdev event timestamp, but in this case,
we don't have a evdev timestamp. So we have to go to gettimeofday (or
clock_gettime()) and then we don't know if it's coming from the same
time source etc.
However for all these cases we don't need a real time timestamp, we
just need a serial number that encodes the order of events inside the
server. So we introduce a serial number mechanism that we can use to
order events. We still need real-time timestamps for actual input
device events (motion, buttons, keys, touch), to be able to reason
about double-click speed and movement speed so events that correspond to user input carry both a serial number and a timestamp.
The serial number also give us a mechanism to key together events that
are "logically the same" such as a unicode event and a keycode event,
or a motion event and a relative event from a raw device.
2012-04-11 22:25:51 -04:00
<arg name= "serial" type= "uint" />
2012-05-16 18:44:40 +01:00
<arg name= "surface" type= "object" interface= "wl_surface" />
2013-03-30 01:11:42 -04:00
<arg name= "keys" type= "array" summary= "the currently pressed keys" />
2010-08-03 09:26:44 -04:00
</event>
2012-05-16 18:44:40 +01:00
<event name= "leave" >
2013-03-30 01:11:42 -04:00
<description summary= "leave event" >
Notification that this seat's keyboard focus is no longer on
a certain surface.
The leave notification is sent before the enter notification
for the new focus.
</description>
Switch protocol to using serial numbers for ordering events and requests
The wayland protocol, as X, uses timestamps to match up certain
requests with input events. The problem is that sometimes we need to
send out an event that doesn't have a corresponding timestamped input
event. For example, the pointer focus surface goes away and new
surface needs to receive a pointer enter event. These events are
normally timestamped with the evdev event timestamp, but in this case,
we don't have a evdev timestamp. So we have to go to gettimeofday (or
clock_gettime()) and then we don't know if it's coming from the same
time source etc.
However for all these cases we don't need a real time timestamp, we
just need a serial number that encodes the order of events inside the
server. So we introduce a serial number mechanism that we can use to
order events. We still need real-time timestamps for actual input
device events (motion, buttons, keys, touch), to be able to reason
about double-click speed and movement speed so events that correspond to user input carry both a serial number and a timestamp.
The serial number also give us a mechanism to key together events that
are "logically the same" such as a unicode event and a keycode event,
or a motion event and a relative event from a raw device.
2012-04-11 22:25:51 -04:00
<arg name= "serial" type= "uint" />
2011-04-18 10:24:11 -04:00
<arg name= "surface" type= "object" interface= "wl_surface" />
2010-08-03 09:26:44 -04:00
</event>
2012-05-30 16:31:48 +01:00
<enum name= "key_state" >
<description summary= "physical key state" >
2013-03-30 01:11:42 -04:00
Describes the physical state of a key which provoked the key event.
2012-05-30 16:31:48 +01:00
</description>
<entry name= "released" value= "0" summary= "key is not pressed" />
<entry name= "pressed" value= "1" summary= "key is pressed" />
</enum>
2012-05-16 18:44:40 +01:00
<event name= "key" >
<description summary= "key event" >
A key was pressed or released.
2013-03-30 14:09:24 -04:00
The time argument is a timestamp with millisecond
granularity, with an undefined base.
2012-02-18 01:25:44 -05:00
</description>
Switch protocol to using serial numbers for ordering events and requests
The wayland protocol, as X, uses timestamps to match up certain
requests with input events. The problem is that sometimes we need to
send out an event that doesn't have a corresponding timestamped input
event. For example, the pointer focus surface goes away and new
surface needs to receive a pointer enter event. These events are
normally timestamped with the evdev event timestamp, but in this case,
we don't have a evdev timestamp. So we have to go to gettimeofday (or
clock_gettime()) and then we don't know if it's coming from the same
time source etc.
However for all these cases we don't need a real time timestamp, we
just need a serial number that encodes the order of events inside the
server. So we introduce a serial number mechanism that we can use to
order events. We still need real-time timestamps for actual input
device events (motion, buttons, keys, touch), to be able to reason
about double-click speed and movement speed so events that correspond to user input carry both a serial number and a timestamp.
The serial number also give us a mechanism to key together events that
are "logically the same" such as a unicode event and a keycode event,
or a motion event and a relative event from a raw device.
2012-04-11 22:25:51 -04:00
<arg name= "serial" type= "uint" />
2013-03-30 14:09:24 -04:00
<arg name= "time" type= "uint" summary= "timestamp with millisecond granularity" />
2012-05-16 18:44:40 +01:00
<arg name= "key" type= "uint" />
<arg name= "state" type= "uint" />
2010-08-03 09:26:44 -04:00
</event>
2012-05-30 16:31:47 +01:00
<event name= "modifiers" >
<description summary= "modifier and group state" >
2013-03-30 01:11:42 -04:00
Notifies clients that the modifier and/or group state has
2012-05-30 16:31:47 +01:00
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>
2014-05-09 18:10:32 +02:00
<!-- Version 3 additions -->
<request name= "release" type= "destructor" since= "3" >
<description summary= "release the keyboard object" />
</request>
2014-07-22 17:39:18 +01:00
<!-- Version 4 additions -->
<event name= "repeat_info" since= "4" >
<description summary= "repeat rate and delay" >
Informs the client about the keyboard's repeat rate and delay.
This event is sent as soon as the wl_keyboard object has been created,
and is guaranteed to be received by the client before any key press
event.
Negative values for either rate or delay are illegal. A rate of zero
will disable any repeating (regardless of the value of delay).
This event can be sent later on as well with a new value if necessary,
so clients should continue listening for the event past the creation
of wl_keyboard.
</description>
<arg name= "rate" type= "int"
summary="the rate of repeating keys in characters per second"/>
<arg name= "delay" type= "int"
summary="delay in milliseconds since key down until repeating starts"/>
</event>
2012-05-16 18:44:40 +01:00
</interface>
2011-06-29 17:54:11 +03:00
2013-08-13 20:06:29 +01:00
<interface name= "wl_touch" version= "3" >
2013-03-30 01:11:43 -04:00
<description summary= "touchscreen input device" >
The wl_touch interface represents a touchscreen
associated with a seat.
Touch interactions can consist of one or more contacts.
For each contact, a series of events is generated, starting
2013-04-04 11:06:02 +10:00
with a down event, followed by zero or more motion events,
and ending with an up event. Events relating to the same
2013-03-30 01:11:43 -04:00
contact point can be identified by the ID of the sequence.
2012-05-16 18:44:40 +01:00
</description>
2012-02-18 01:25:44 -05:00
2012-05-16 18:44:40 +01:00
<event name= "down" >
2013-04-04 11:06:02 +10:00
<description summary= "touch down event and beginning of a touch sequence" >
2013-04-02 09:58:17 +10:00
A new touch point has appeared on the surface. This touch point is
assigned a unique @id. Future events from this touchpoint reference
this ID. The ID ceases to be valid after a touch up event and may be
re-used in the future.
2013-03-30 01:11:43 -04:00
</description>
Switch protocol to using serial numbers for ordering events and requests
The wayland protocol, as X, uses timestamps to match up certain
requests with input events. The problem is that sometimes we need to
send out an event that doesn't have a corresponding timestamped input
event. For example, the pointer focus surface goes away and new
surface needs to receive a pointer enter event. These events are
normally timestamped with the evdev event timestamp, but in this case,
we don't have a evdev timestamp. So we have to go to gettimeofday (or
clock_gettime()) and then we don't know if it's coming from the same
time source etc.
However for all these cases we don't need a real time timestamp, we
just need a serial number that encodes the order of events inside the
server. So we introduce a serial number mechanism that we can use to
order events. We still need real-time timestamps for actual input
device events (motion, buttons, keys, touch), to be able to reason
about double-click speed and movement speed so events that correspond to user input carry both a serial number and a timestamp.
The serial number also give us a mechanism to key together events that
are "logically the same" such as a unicode event and a keycode event,
or a motion event and a relative event from a raw device.
2012-04-11 22:25:51 -04:00
<arg name= "serial" type= "uint" />
2013-03-30 14:09:24 -04:00
<arg name= "time" type= "uint" summary= "timestamp with millisecond granularity" />
2011-12-21 19:34:08 +02:00
<arg name= "surface" type= "object" interface= "wl_surface" />
2013-04-02 09:58:17 +10:00
<arg name= "id" type= "int" summary= "the unique ID of this touch point" />
<arg name= "x" type= "fixed" summary= "x coordinate in surface-relative coordinates" />
<arg name= "y" type= "fixed" summary= "y coordinate in surface-relative coordinates" />
2011-06-29 17:54:11 +03:00
</event>
2012-05-16 18:44:40 +01:00
<event name= "up" >
2013-04-02 09:58:17 +10:00
<description summary= "end of a touch event sequence" >
The touch point has disappeared. No further events will be sent for
this touchpoint and the touch point's ID is released and may be
re-used in a future touch down event.
2013-03-30 01:11:43 -04:00
</description>
Switch protocol to using serial numbers for ordering events and requests
The wayland protocol, as X, uses timestamps to match up certain
requests with input events. The problem is that sometimes we need to
send out an event that doesn't have a corresponding timestamped input
event. For example, the pointer focus surface goes away and new
surface needs to receive a pointer enter event. These events are
normally timestamped with the evdev event timestamp, but in this case,
we don't have a evdev timestamp. So we have to go to gettimeofday (or
clock_gettime()) and then we don't know if it's coming from the same
time source etc.
However for all these cases we don't need a real time timestamp, we
just need a serial number that encodes the order of events inside the
server. So we introduce a serial number mechanism that we can use to
order events. We still need real-time timestamps for actual input
device events (motion, buttons, keys, touch), to be able to reason
about double-click speed and movement speed so events that correspond to user input carry both a serial number and a timestamp.
The serial number also give us a mechanism to key together events that
are "logically the same" such as a unicode event and a keycode event,
or a motion event and a relative event from a raw device.
2012-04-11 22:25:51 -04:00
<arg name= "serial" type= "uint" />
2013-03-30 14:09:24 -04:00
<arg name= "time" type= "uint" summary= "timestamp with millisecond granularity" />
2013-04-02 09:58:17 +10:00
<arg name= "id" type= "int" summary= "the unique ID of this touch point" />
2011-06-29 17:54:11 +03:00
</event>
2012-05-16 18:44:40 +01:00
<event name= "motion" >
2013-04-04 11:06:02 +10:00
<description summary= "update of touch point coordinates" >
2013-04-02 09:58:17 +10:00
A touchpoint has changed coordinates.
2013-03-30 01:11:43 -04:00
</description>
2013-03-30 14:09:24 -04:00
<arg name= "time" type= "uint" summary= "timestamp with millisecond granularity" />
2013-04-02 09:58:17 +10:00
<arg name= "id" type= "int" summary= "the unique ID of this touch point" />
<arg name= "x" type= "fixed" summary= "x coordinate in surface-relative coordinates" />
<arg name= "y" type= "fixed" summary= "y coordinate in surface-relative coordinates" />
2011-06-29 17:54:11 +03:00
</event>
2012-05-16 18:44:40 +01:00
<event name= "frame" >
2012-01-18 19:17:23 -05:00
<description summary= "end of touch frame event" >
Indicates the end of a contact point list.
</description>
</event>
2011-06-29 17:54:11 +03:00
2012-05-16 18:44:40 +01:00
<event name= "cancel" >
2012-01-18 19:17:23 -05:00
<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
2013-04-02 09:58:17 +10:00
particular gesture. Touch cancellation applies to all touch points
currently active on this client's surface. The client is
responsible for finalizing the touch points, future touch points on
this surface may re-use the touch point ID.
2012-01-18 19:17:23 -05:00
</description>
</event>
2014-05-09 18:10:32 +02:00
<!-- Version 3 additions -->
<request name= "release" type= "destructor" since= "3" >
<description summary= "release the touch object" />
</request>
2010-08-03 09:26:44 -04:00
</interface>
2013-05-16 15:49:35 +02:00
<interface name= "wl_output" version= "2" >
2012-01-24 17:49:28 +02:00
<description summary= "compositor output region" >
2012-01-18 19:17:23 -05:00
An output describes part of the compositor geometry. The
2013-03-30 01:11:44 -04:00
compositor works in the 'compositor coordinate system' and an
2012-01-18 19:17:23 -05:00
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
2013-03-30 01:11:44 -04:00
as global during start up, or when a monitor is hotplugged.
2012-01-18 19:17:23 -05:00
</description>
2011-06-20 20:34:55 -04:00
<enum name= "subpixel" >
2013-03-30 01:11:44 -04:00
<description summary= "subpixel geometry information" >
This enumeration describes how the physical
pixels on an output are layed out.
</description>
2011-06-20 20:34:55 -04:00
<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>
2012-07-22 15:46:16 -04:00
<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
2012-08-16 00:04:27 -06:00
vertical axis followed by rotation.
2012-07-22 15:46:16 -04:00
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>
2010-08-03 09:26:44 -04:00
<event name= "geometry" >
2013-03-30 01:11:44 -04:00
<description summary= "properties of the output" >
The geometry event describes geometric properties of the output.
The event is sent when binding to the output object and whenever
any of the properties change.
</description>
2012-05-10 11:56:39 -04:00
<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"
2012-07-09 15:50:39 +02:00
summary="width in millimeters of the output"/>
2012-05-10 11:56:39 -04:00
<arg name= "physical_height" type= "int"
2012-07-09 15:50:39 +02:00
summary="height in millimeters of the output"/>
2012-05-10 11:56:39 -04:00
<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"/>
2012-07-22 15:46:16 -04:00
<arg name= "transform" type= "int"
summary="transform that maps framebuffer to output"/>
2011-06-20 20:34:55 -04:00
</event>
<enum name= "mode" >
2013-03-30 01:11:44 -04:00
<description summary= "mode information" >
These flags describe properties of an output mode.
They are used in the flags bitfield of the mode event.
</description>
2012-05-10 11:56:39 -04:00
<entry name= "current" value= "0x1"
summary="indicates this is the current mode"/>
<entry name= "preferred" value= "0x2"
summary="indicates this is the preferred mode"/>
2011-06-20 20:34:55 -04:00
</enum>
2013-03-30 01:11:44 -04:00
2011-06-20 20:34:55 -04:00
<event name= "mode" >
2012-05-10 11:56:39 -04:00
<description summary= "advertise available modes for the output" >
The mode event describes an available mode for the output.
2013-03-30 01:11:44 -04:00
2012-05-10 11:56:39 -04:00
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.
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
2013-05-28 16:20:52 +02:00
The size of a mode is given in physical hardware units of
the output device. This is not necessarily the same as
the output size in the global compositor space. For instance,
the output may be scaled, as described in wl_output.scale,
or transformed , as described in wl_output.transform.
2012-05-10 11:56:39 -04:00
</description>
2013-03-30 01:11:44 -04:00
<arg name= "flags" type= "uint" summary= "bitfield of mode flags" />
2013-05-28 16:20:52 +02:00
<arg name= "width" type= "int" summary= "width of the mode in hardware units" />
<arg name= "height" type= "int" summary= "height of the mode in hardware units" />
2012-05-10 11:56:39 -04:00
<arg name= "refresh" type= "int" summary= "vertical refresh rate in mHz" />
2010-08-03 09:26:44 -04:00
</event>
2013-05-16 15:49:35 +02:00
<event name= "done" since= "2" >
<description summary= "sent all information about output" >
This event is sent after all other properties has been
sent after binding to the output object and after any
other property changes done after that. This allows
changes to the output properties to be seen as
atomic, even if they happen via multiple events.
</description>
</event>
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
<event name= "scale" since= "2" >
<description summary= "output scaling properties" >
This event contains scaling geometry information
that is not in the geometry event. It may be sent after
binding the output object or if the output scale changes
later. If it is not sent, the client should assume a
scale of 1.
A scale larger than 1 means that the compositor will
automatically scale surface buffers by this amount
when rendering. This is used for very high resolution
displays where applications rendering at the native
resolution would be too small to be legible.
It is intended that scaling aware clients track the
current output of a surface, and if it is on a scaled
output it should use wl_surface.set_buffer_scale with
the scale of the output. That way the compositor can
avoid scaling the surface, and the client can supply
a higher detail image.
</description>
2013-05-24 13:08:41 +02:00
<arg name= "factor" type= "int" summary= "scaling factor of output" />
protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.
It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.
Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.
Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.
It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.
This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.
This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-16 15:49:36 +02:00
</event>
2010-08-03 09:26:44 -04:00
</interface>
2012-02-23 14:50:06 -05:00
<interface name= "wl_region" version= "1" >
<description summary= "region interface" >
2013-03-30 01:11:45 -04:00
A region object describes an area.
Region objects are used to describe the opaque and input
regions of a surface.
2012-02-23 14:50:06 -05:00
</description>
<request name= "destroy" type= "destructor" >
<description summary= "destroy region" >
2013-03-30 01:11:45 -04:00
Destroy the region. This will invalidate the object ID.
2012-02-23 14:50:06 -05:00
</description>
</request>
<request name= "add" >
<description summary= "add rectangle to region" >
2013-03-30 01:11:45 -04:00
Add the specified rectangle to the region.
2012-02-23 14:50:06 -05:00
</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" >
2013-03-30 01:11:45 -04:00
Subtract the specified rectangle from the region.
2012-02-23 14:50:06 -05:00
</description>
<arg name= "x" type= "int" />
<arg name= "y" type= "int" />
<arg name= "width" type= "int" />
<arg name= "height" type= "int" />
</request>
</interface>
protocol: add sub-surfaces to the core
The sub-surface protocol was originally committed into Weston on May
10th, 2013, in commit 2396aec6842c709a714f3825dbad9fd88478f2e6. The
design for the protocol had started in the beginning of December 2012. I
think it is high time to move this into the core now.
This patch copies the sub-surface protocol as it was in Weston on Nov
15th, 2013, into Wayland. Weston gets a patch to remove the protocol from
there.
Sub-surface is a wl_surface role. You create a wl_surface as usual, and
assign it the sub-surface role and a parent wl_surface. Sub-surfaces are
an integral part of the parent surface, and stay glued to the parent.
For window management, a window is the union of the top-level
wl_surface and all its sub-surfaces. Sub-surfaces are not clipped to the
parent, and the union of the surface tree can be larger than the
(top-level) wl_surface at its root.
The representative use case for sub-surfaces is a video player window.
When the video content is given its own wl_surface, there is no need to
modify the video frame contents after decoding or copy them into a whole
window sized buffer before submitting it to the compositor. This allows
efficient, zero-copy video presentation paths, where video decoding
hardware produces a (YUV) buffer, which eventually ends up in a
(YUV-capable) hardware overlay and is scanned out directly.
This can also be used for zero-copy presentation of windowed OpenGL
content, where the OpenGL rendering engine does not need to draw or
avoid window decorations.
Sub-surfaces allow mixing different buffer types into the same window,
e.g. software-rendered decorations in wl_shm buffers, and live content
in EGL-based buffers.
However, the sub-surface extension does not offer clipping or scaling
facilities, or accurate presentation timing. Those are topics for
additional extensions.
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2013-11-15 16:09:45 +02:00
<interface name= "wl_subcompositor" version= "1" >
<description summary= "sub-surface compositing" >
The global interface exposing sub-surface compositing capabilities.
A wl_surface, that has sub-surfaces associated, is called the
parent surface. Sub-surfaces can be arbitrarily nested and create
a tree of sub-surfaces.
The root surface in a tree of sub-surfaces is the main
surface. The main surface cannot be a sub-surface, because
sub-surfaces must always have a parent.
A main surface with its sub-surfaces forms a (compound) window.
For window management purposes, this set of wl_surface objects is
to be considered as a single window, and it should also behave as
such.
The aim of sub-surfaces is to offload some of the compositing work
within a window from clients to the compositor. A prime example is
a video player with decorations and video in separate wl_surface
objects. This should allow the compositor to pass YUV video buffer
processing to dedicated overlay hardware when possible.
</description>
<request name= "destroy" type= "destructor" >
<description summary= "unbind from the subcompositor interface" >
Informs the server that the client will not be using this
protocol object anymore. This does not affect any other
objects, wl_subsurface objects included.
</description>
</request>
<enum name= "error" >
<entry name= "bad_surface" value= "0"
summary="the to-be sub-surface is invalid"/>
</enum>
<request name= "get_subsurface" >
<description summary= "give a surface the role sub-surface" >
Create a sub-surface interface for the given surface, and
associate it with the given parent surface. This turns a
plain wl_surface into a sub-surface.
2014-08-21 12:42:50 +03:00
The to-be sub-surface must not already have another role, and it
must not have an existing wl_subsurface object. Otherwise a protocol
error is raised.
protocol: add sub-surfaces to the core
The sub-surface protocol was originally committed into Weston on May
10th, 2013, in commit 2396aec6842c709a714f3825dbad9fd88478f2e6. The
design for the protocol had started in the beginning of December 2012. I
think it is high time to move this into the core now.
This patch copies the sub-surface protocol as it was in Weston on Nov
15th, 2013, into Wayland. Weston gets a patch to remove the protocol from
there.
Sub-surface is a wl_surface role. You create a wl_surface as usual, and
assign it the sub-surface role and a parent wl_surface. Sub-surfaces are
an integral part of the parent surface, and stay glued to the parent.
For window management, a window is the union of the top-level
wl_surface and all its sub-surfaces. Sub-surfaces are not clipped to the
parent, and the union of the surface tree can be larger than the
(top-level) wl_surface at its root.
The representative use case for sub-surfaces is a video player window.
When the video content is given its own wl_surface, there is no need to
modify the video frame contents after decoding or copy them into a whole
window sized buffer before submitting it to the compositor. This allows
efficient, zero-copy video presentation paths, where video decoding
hardware produces a (YUV) buffer, which eventually ends up in a
(YUV-capable) hardware overlay and is scanned out directly.
This can also be used for zero-copy presentation of windowed OpenGL
content, where the OpenGL rendering engine does not need to draw or
avoid window decorations.
Sub-surfaces allow mixing different buffer types into the same window,
e.g. software-rendered decorations in wl_shm buffers, and live content
in EGL-based buffers.
However, the sub-surface extension does not offer clipping or scaling
facilities, or accurate presentation timing. Those are topics for
additional extensions.
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2013-11-15 16:09:45 +02:00
</description>
<arg name= "id" type= "new_id" interface= "wl_subsurface"
summary="the new subsurface object id"/>
<arg name= "surface" type= "object" interface= "wl_surface"
summary="the surface to be turned into a sub-surface"/>
<arg name= "parent" type= "object" interface= "wl_surface"
summary="the parent surface"/>
</request>
</interface>
<interface name= "wl_subsurface" version= "1" >
<description summary= "sub-surface interface to a wl_surface" >
An additional interface to a wl_surface object, which has been
made a sub-surface. A sub-surface has one parent surface. A
sub-surface's size and position are not limited to that of the parent.
Particularly, a sub-surface is not automatically clipped to its
parent's area.
A sub-surface becomes mapped, when a non-NULL wl_buffer is applied
and the parent surface is mapped. The order of which one happens
first is irrelevant. A sub-surface is hidden if the parent becomes
hidden, or if a NULL wl_buffer is applied. These rules apply
recursively through the tree of surfaces.
The behaviour of wl_surface.commit request on a sub-surface
depends on the sub-surface's mode. The possible modes are
synchronized and desynchronized, see methods
wl_subsurface.set_sync and wl_subsurface.set_desync. Synchronized
mode caches the wl_surface state to be applied when the parent's
state gets applied, and desynchronized mode applies the pending
wl_surface state directly. A sub-surface is initially in the
synchronized mode.
Sub-surfaces have also other kind of state, which is managed by
wl_subsurface requests, as opposed to wl_surface requests. This
state includes the sub-surface position relative to the parent
surface (wl_subsurface.set_position), and the stacking order of
the parent and its sub-surfaces (wl_subsurface.place_above and
.place_below). This state is applied when the parent surface's
wl_surface state is applied, regardless of the sub-surface's mode.
As the exception, set_sync and set_desync are effective immediately.
The main surface can be thought to be always in desynchronized mode,
since it does not have a parent in the sub-surfaces sense.
Even if a sub-surface is in desynchronized mode, it will behave as
in synchronized mode, if its parent surface behaves as in
synchronized mode. This rule is applied recursively throughout the
tree of surfaces. This means, that one can set a sub-surface into
synchronized mode, and then assume that all its child and grand-child
sub-surfaces are synchronized, too, without explicitly setting them.
If the wl_surface associated with the wl_subsurface is destroyed, the
wl_subsurface object becomes inert. Note, that destroying either object
takes effect immediately. If you need to synchronize the removal
of a sub-surface to the parent surface update, unmap the sub-surface
first by attaching a NULL wl_buffer, update parent, and then destroy
the sub-surface.
If the parent wl_surface object is destroyed, the sub-surface is
unmapped.
</description>
<request name= "destroy" type= "destructor" >
<description summary= "remove sub-surface interface" >
The sub-surface interface is removed from the wl_surface object
that was turned into a sub-surface with
wl_subcompositor.get_subsurface request. The wl_surface's association
to the parent is deleted, and the wl_surface loses its role as
a sub-surface. The wl_surface is unmapped.
</description>
</request>
<enum name= "error" >
<entry name= "bad_surface" value= "0"
summary="wl_surface is not a sibling or the parent"/>
</enum>
<request name= "set_position" >
<description summary= "reposition the sub-surface" >
This schedules a sub-surface position change.
The sub-surface will be moved so, that its origin (top-left
corner pixel) will be at the location x, y of the parent surface
coordinate system. The coordinates are not restricted to the parent
surface area. Negative values are allowed.
The next wl_surface.commit on the parent surface will reset
the sub-surface's position to the scheduled coordinates.
2014-01-19 10:32:11 +01:00
If more than one set_position request is invoked by the client before
the commit of the parent surface, the position of a new request always
replaces the scheduled position from any previous request.
protocol: add sub-surfaces to the core
The sub-surface protocol was originally committed into Weston on May
10th, 2013, in commit 2396aec6842c709a714f3825dbad9fd88478f2e6. The
design for the protocol had started in the beginning of December 2012. I
think it is high time to move this into the core now.
This patch copies the sub-surface protocol as it was in Weston on Nov
15th, 2013, into Wayland. Weston gets a patch to remove the protocol from
there.
Sub-surface is a wl_surface role. You create a wl_surface as usual, and
assign it the sub-surface role and a parent wl_surface. Sub-surfaces are
an integral part of the parent surface, and stay glued to the parent.
For window management, a window is the union of the top-level
wl_surface and all its sub-surfaces. Sub-surfaces are not clipped to the
parent, and the union of the surface tree can be larger than the
(top-level) wl_surface at its root.
The representative use case for sub-surfaces is a video player window.
When the video content is given its own wl_surface, there is no need to
modify the video frame contents after decoding or copy them into a whole
window sized buffer before submitting it to the compositor. This allows
efficient, zero-copy video presentation paths, where video decoding
hardware produces a (YUV) buffer, which eventually ends up in a
(YUV-capable) hardware overlay and is scanned out directly.
This can also be used for zero-copy presentation of windowed OpenGL
content, where the OpenGL rendering engine does not need to draw or
avoid window decorations.
Sub-surfaces allow mixing different buffer types into the same window,
e.g. software-rendered decorations in wl_shm buffers, and live content
in EGL-based buffers.
However, the sub-surface extension does not offer clipping or scaling
facilities, or accurate presentation timing. Those are topics for
additional extensions.
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2013-11-15 16:09:45 +02:00
The initial position is 0, 0.
</description>
<arg name= "x" type= "int" summary= "coordinate in the parent surface" />
<arg name= "y" type= "int" summary= "coordinate in the parent surface" />
</request>
<request name= "place_above" >
<description summary= "restack the sub-surface" >
This sub-surface is taken from the stack, and put back just
above the reference surface, changing the z-order of the sub-surfaces.
The reference surface must be one of the sibling surfaces, or the
parent surface. Using any other surface, including this sub-surface,
will cause a protocol error.
2014-01-19 10:32:10 +01:00
The z-order is double-buffered. Requests are handled in order and
applied immediately to a pending state, then committed to the active
state on the next commit of the parent surface.
protocol: add sub-surfaces to the core
The sub-surface protocol was originally committed into Weston on May
10th, 2013, in commit 2396aec6842c709a714f3825dbad9fd88478f2e6. The
design for the protocol had started in the beginning of December 2012. I
think it is high time to move this into the core now.
This patch copies the sub-surface protocol as it was in Weston on Nov
15th, 2013, into Wayland. Weston gets a patch to remove the protocol from
there.
Sub-surface is a wl_surface role. You create a wl_surface as usual, and
assign it the sub-surface role and a parent wl_surface. Sub-surfaces are
an integral part of the parent surface, and stay glued to the parent.
For window management, a window is the union of the top-level
wl_surface and all its sub-surfaces. Sub-surfaces are not clipped to the
parent, and the union of the surface tree can be larger than the
(top-level) wl_surface at its root.
The representative use case for sub-surfaces is a video player window.
When the video content is given its own wl_surface, there is no need to
modify the video frame contents after decoding or copy them into a whole
window sized buffer before submitting it to the compositor. This allows
efficient, zero-copy video presentation paths, where video decoding
hardware produces a (YUV) buffer, which eventually ends up in a
(YUV-capable) hardware overlay and is scanned out directly.
This can also be used for zero-copy presentation of windowed OpenGL
content, where the OpenGL rendering engine does not need to draw or
avoid window decorations.
Sub-surfaces allow mixing different buffer types into the same window,
e.g. software-rendered decorations in wl_shm buffers, and live content
in EGL-based buffers.
However, the sub-surface extension does not offer clipping or scaling
facilities, or accurate presentation timing. Those are topics for
additional extensions.
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2013-11-15 16:09:45 +02:00
See wl_surface.commit and wl_subcompositor.get_subsurface.
A new sub-surface is initially added as the top-most in the stack
of its siblings and parent.
</description>
<arg name= "sibling" type= "object" interface= "wl_surface"
summary="the reference surface"/>
</request>
<request name= "place_below" >
<description summary= "restack the sub-surface" >
The sub-surface is placed just below of the reference surface.
See wl_subsurface.place_above.
</description>
<arg name= "sibling" type= "object" interface= "wl_surface"
summary="the reference surface"/>
</request>
<request name= "set_sync" >
<description summary= "set sub-surface to synchronized mode" >
Change the commit behaviour of the sub-surface to synchronized
mode, also described as the parent dependant mode.
In synchronized mode, wl_surface.commit on a sub-surface will
accumulate the committed state in a cache, but the state will
not be applied and hence will not change the compositor output.
The cached state is applied to the sub-surface immediately after
the parent surface's state is applied. This ensures atomic
updates of the parent and all its synchronized sub-surfaces.
Applying the cached state will invalidate the cache, so further
parent surface commits do not (re-)apply old state.
See wl_subsurface for the recursive effect of this mode.
</description>
</request>
<request name= "set_desync" >
<description summary= "set sub-surface to desynchronized mode" >
Change the commit behaviour of the sub-surface to desynchronized
mode, also described as independent or freely running mode.
In desynchronized mode, wl_surface.commit on a sub-surface will
apply the pending state directly, without caching, as happens
normally with a wl_surface. Calling wl_surface.commit on the
parent surface has no effect on the sub-surface's wl_surface
state. This mode allows a sub-surface to be updated on its own.
If cached state exists when wl_surface.commit is called in
desynchronized mode, the pending state is added to the cached
state, and applied as whole. This invalidates the cache.
Note: even if a sub-surface is set to desynchronized, a parent
sub-surface may override it to behave as synchronized. For details,
see wl_subsurface.
If a surface's parent surface behaves as desynchronized, then
the cached state is applied on set_desync.
</description>
</request>
</interface>
2010-11-29 21:05:26 +02:00
</protocol>
