{
"name": "wayland",
"copyright": "Copyright © 2008-2011 Kristian Høgsberg\n Copyright © 2010-2011 Intel Corporation\n Copyright © 2012-2013 Collabora, Ltd.\n\n Permission is hereby granted, free of charge, to any person\n obtaining a copy of this software and associated documentation files\n (the \"Software\"), to deal in the Software without restriction,\n including without limitation the rights to use, copy, modify, merge,\n publish, distribute, sublicense, and/or sell copies of the Software,\n and to permit persons to whom the Software is furnished to do so,\n subject to the following conditions:\n\n The above copyright notice and this permission notice (including the\n next paragraph) shall be included in all copies or substantial\n portions of the Software.\n\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS\n BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN\n ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\n CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"description": null,
"interfaces": [
{
"name": "wl_display",
"version": 1,
"description": {
"summary": "core global object",
"body": "The core global object. This is a special singleton object. It\n is used for internal Wayland protocol features."
},
"requests": [
{
"name": "sync",
"destructor": false,
"since": 1,
"description": {
"summary": "asynchronous roundtrip",
"body": "The sync request asks the server to emit the 'done' event\n\ton the returned wl_callback object. Since requests are\n\thandled in-order and events are delivered in-order, this can\n\tbe used as a barrier to ensure all previous requests and the\n\tresulting events have been handled.\n\n\tThe object returned by this request will be destroyed by the\n\tcompositor after the callback is fired and as such the client must not\n\tattempt to use it after that point.\n\n\tThe callback_data passed in the callback is the event serial."
},
"args": [
{
"name": "callback",
"kind": "NewId",
"summary": "callback object for the sync request",
"interface": "wl_callback",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "get_registry",
"destructor": false,
"since": 1,
"description": {
"summary": "get global registry object",
"body": "This request creates a registry object that allows the client\n\tto list and bind the global objects available from the\n\tcompositor.\n\n\tIt should be noted that the server side resources consumed in\n\tresponse to a get_registry request can only be released when the\n\tclient disconnects, not when the client side proxy is destroyed.\n\tTherefore, clients should invoke get_registry as infrequently as\n\tpossible to avoid wasting memory."
},
"args": [
{
"name": "registry",
"kind": "NewId",
"summary": "global registry object",
"interface": "wl_registry",
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [
{
"name": "error",
"since": 1,
"description": {
"summary": "fatal error event",
"body": "The error event is sent out when a fatal (non-recoverable)\n\terror has occurred. The object_id argument is the object\n\twhere the error occurred, most often in response to a request\n\tto that object. The code identifies the error and is defined\n\tby the object interface. As such, each interface defines its\n\town set of error codes. The message is a brief description\n\tof the error, for (debugging) convenience."
},
"args": [
{
"name": "object_id",
"kind": "Object",
"summary": "object where the error occurred",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "code",
"kind": "Uint",
"summary": "error code",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "message",
"kind": "String",
"summary": "error description",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "delete_id",
"since": 1,
"description": {
"summary": "acknowledge object ID deletion",
"body": "This event is used internally by the object ID management\n\tlogic. When a client deletes an object that it had created,\n\tthe server will send this event to acknowledge that it has\n\tseen the delete request. When the client receives this event,\n\tit will know that it can safely reuse the object ID."
},
"args": [
{
"name": "id",
"kind": "Uint",
"summary": "deleted object ID",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": {
"summary": "global error values",
"body": "These errors are global and can be emitted in response to any\n\tserver request."
},
"entries": [
{
"name": "invalid_object",
"value": 0,
"summary": "server couldn't find object",
"since": 1,
"description": null
},
{
"name": "invalid_method",
"value": 1,
"summary": "method doesn't exist on the specified interface or malformed request",
"since": 1,
"description": null
},
{
"name": "no_memory",
"value": 2,
"summary": "server is out of memory",
"since": 1,
"description": null
},
{
"name": "implementation",
"value": 3,
"summary": "implementation error in compositor",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_registry",
"version": 1,
"description": {
"summary": "global registry object",
"body": "The singleton global registry object. The server has a number of\n global objects that are available to all clients. These objects\n typically represent an actual object in the server (for example,\n an input device) or they are singleton objects that provide\n extension functionality.\n\n When a client creates a registry object, the registry object\n will emit a global event for each global currently in the\n registry. Globals come and go as a result of device or\n monitor hotplugs, reconfiguration or other events, and the\n registry will send out global and global_remove events to\n keep the client up to date with the changes. To mark the end\n of the initial burst of events, the client can use the\n wl_display.sync request immediately after calling\n wl_display.get_registry.\n\n A client can bind to a global object by using the bind\n request. This creates a client-side handle that lets the object\n emit events to the client and lets the client invoke requests on\n the object."
},
"requests": [
{
"name": "bind",
"destructor": false,
"since": 1,
"description": {
"summary": "bind an object to the display",
"body": "Binds a new, client-created object to the server using the\n\tspecified name as the identifier."
},
"args": [
{
"name": "name",
"kind": "Uint",
"summary": "unique numeric name of the object",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "id",
"kind": "NewId",
"summary": "bounded object",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [
{
"name": "global",
"since": 1,
"description": {
"summary": "announce global object",
"body": "Notify the client of global objects.\n\n\tThe event notifies the client that a global object with\n\tthe given name is now available, and it implements the\n\tgiven version of the given interface."
},
"args": [
{
"name": "name",
"kind": "Uint",
"summary": "numeric name of the global object",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "interface",
"kind": "String",
"summary": "interface implemented by the object",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "version",
"kind": "Uint",
"summary": "interface version",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "global_remove",
"since": 1,
"description": {
"summary": "announce removal of global object",
"body": "Notify the client of removed global objects.\n\n\tThis event notifies the client that the global identified\n\tby name is no longer available. If the client bound to\n\tthe global using the bind request, the client should now\n\tdestroy that object.\n\n\tThe object remains valid and requests to the object will be\n\tignored until the client destroys it, to avoid races between\n\tthe global going away and a client sending a request to it."
},
"args": [
{
"name": "name",
"kind": "Uint",
"summary": "numeric name of the global object",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"enums": []
},
{
"name": "wl_callback",
"version": 1,
"description": {
"summary": "callback object",
"body": "Clients can handle the 'done' event to get notified when\n the related request is done."
},
"requests": [],
"events": [
{
"name": "done",
"since": 1,
"description": {
"summary": "done event",
"body": "Notify the client when the related request is done."
},
"args": [
{
"name": "callback_data",
"kind": "Uint",
"summary": "request-specific data for the callback",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"enums": []
},
{
"name": "wl_compositor",
"version": 4,
"description": {
"summary": "the compositor singleton",
"body": "A compositor. This object is a singleton global. The\n compositor is in charge of combining the contents of multiple\n surfaces into one displayable output."
},
"requests": [
{
"name": "create_surface",
"destructor": false,
"since": 1,
"description": {
"summary": "create new surface",
"body": "Ask the compositor to create a new surface."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "the new surface",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "create_region",
"destructor": false,
"since": 1,
"description": {
"summary": "create new region",
"body": "Ask the compositor to create a new region."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "the new region",
"interface": "wl_region",
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [],
"enums": []
},
{
"name": "wl_shm_pool",
"version": 1,
"description": {
"summary": "a shared memory pool",
"body": "The wl_shm_pool object encapsulates a piece of memory shared\n between the compositor and client. Through the wl_shm_pool\n object, the client can allocate shared memory wl_buffer objects.\n All objects created through the same pool share the same\n underlying mapped memory. Reusing the mapped memory avoids the\n setup/teardown overhead and is useful when interactively resizing\n a surface or for many small buffers."
},
"requests": [
{
"name": "create_buffer",
"destructor": false,
"since": 1,
"description": {
"summary": "create a buffer from the pool",
"body": "Create a wl_buffer object from the pool.\n\n\tThe buffer is created offset bytes into the pool and has\n\twidth and height as specified. The stride argument specifies\n\tthe number of bytes from the beginning of one row to the beginning\n\tof the next. The format is the pixel format of the buffer and\n\tmust be one of those advertised through the wl_shm.format event.\n\n\tA buffer will keep a reference to the pool it was created from\n\tso it is valid to destroy the pool immediately after creating\n\ta buffer from it."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "buffer to create",
"interface": "wl_buffer",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "offset",
"kind": "Int",
"summary": "buffer byte offset within the pool",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "width",
"kind": "Int",
"summary": "buffer width, in pixels",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "height",
"kind": "Int",
"summary": "buffer height, in pixels",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "stride",
"kind": "Int",
"summary": "number of bytes from the beginning of one row to the beginning of the next row",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "format",
"kind": "Uint",
"summary": "buffer pixel format",
"interface": null,
"allow_null": false,
"enumeration": "wl_shm.format",
"description": null
}
]
},
{
"name": "destroy",
"destructor": true,
"since": 1,
"description": {
"summary": "destroy the pool",
"body": "Destroy the shared memory pool.\n\n\tThe mmapped memory will be released when all\n\tbuffers that have been created from this pool\n\tare gone."
},
"args": []
},
{
"name": "resize",
"destructor": false,
"since": 1,
"description": {
"summary": "change the size of the pool mapping",
"body": "This request will cause the server to remap the backing memory\n\tfor the pool from the file descriptor passed when the pool was\n\tcreated, but using the new size. This request can only be\n\tused to make the pool bigger."
},
"args": [
{
"name": "size",
"kind": "Int",
"summary": "new size of the pool, in bytes",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [],
"enums": []
},
{
"name": "wl_shm",
"version": 1,
"description": {
"summary": "shared memory support",
"body": "A singleton global object that provides support for shared\n memory.\n\n Clients can create wl_shm_pool objects using the create_pool\n request.\n\n At connection setup time, the wl_shm object emits one or more\n format events to inform clients about the valid pixel formats\n that can be used for buffers."
},
"requests": [
{
"name": "create_pool",
"destructor": false,
"since": 1,
"description": {
"summary": "create a shm pool",
"body": "Create a new wl_shm_pool object.\n\n\tThe pool can be used to create shared memory based buffer\n\tobjects. The server will mmap size bytes of the passed file\n\tdescriptor, to use as backing memory for the pool."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "pool to create",
"interface": "wl_shm_pool",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "fd",
"kind": "Fd",
"summary": "file descriptor for the pool",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "size",
"kind": "Int",
"summary": "pool size, in bytes",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [
{
"name": "format",
"since": 1,
"description": {
"summary": "pixel format description",
"body": "Informs the client about a valid pixel format that\n\tcan be used for buffers. Known formats include\n\targb8888 and xrgb8888."
},
"args": [
{
"name": "format",
"kind": "Uint",
"summary": "buffer pixel format",
"interface": null,
"allow_null": false,
"enumeration": "format",
"description": null
}
]
}
],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": {
"summary": "wl_shm error values",
"body": "These errors can be emitted in response to wl_shm requests."
},
"entries": [
{
"name": "invalid_format",
"value": 0,
"summary": "buffer format is not known",
"since": 1,
"description": null
},
{
"name": "invalid_stride",
"value": 1,
"summary": "invalid size or stride during pool or buffer creation",
"since": 1,
"description": null
},
{
"name": "invalid_fd",
"value": 2,
"summary": "mmapping the file descriptor failed",
"since": 1,
"description": null
}
]
},
{
"name": "format",
"since": 1,
"bitfield": false,
"description": {
"summary": "pixel formats",
"body": "This describes the memory layout of an individual pixel.\n\n\tAll renderers should support argb8888 and xrgb8888 but any other\n\tformats are optional and may not be supported by the particular\n\trenderer in use.\n\n\tThe drm format codes match the macros defined in drm_fourcc.h, except\n\targb8888 and xrgb8888. The formats actually supported by the compositor\n\twill be reported by the format event."
},
"entries": [
{
"name": "argb8888",
"value": 0,
"summary": "32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "xrgb8888",
"value": 1,
"summary": "32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "c8",
"value": 538982467,
"summary": "8-bit color index format, [7:0] C",
"since": 1,
"description": null
},
{
"name": "rgb332",
"value": 943867730,
"summary": "8-bit RGB format, [7:0] R:G:B 3:3:2",
"since": 1,
"description": null
},
{
"name": "bgr233",
"value": 944916290,
"summary": "8-bit BGR format, [7:0] B:G:R 2:3:3",
"since": 1,
"description": null
},
{
"name": "xrgb4444",
"value": 842093144,
"summary": "16-bit xRGB format, [15:0] x:R:G:B 4:4:4:4 little endian",
"since": 1,
"description": null
},
{
"name": "xbgr4444",
"value": 842089048,
"summary": "16-bit xBGR format, [15:0] x:B:G:R 4:4:4:4 little endian",
"since": 1,
"description": null
},
{
"name": "rgbx4444",
"value": 842094674,
"summary": "16-bit RGBx format, [15:0] R:G:B:x 4:4:4:4 little endian",
"since": 1,
"description": null
},
{
"name": "bgrx4444",
"value": 842094658,
"summary": "16-bit BGRx format, [15:0] B:G:R:x 4:4:4:4 little endian",
"since": 1,
"description": null
},
{
"name": "argb4444",
"value": 842093121,
"summary": "16-bit ARGB format, [15:0] A:R:G:B 4:4:4:4 little endian",
"since": 1,
"description": null
},
{
"name": "abgr4444",
"value": 842089025,
"summary": "16-bit ABGR format, [15:0] A:B:G:R 4:4:4:4 little endian",
"since": 1,
"description": null
},
{
"name": "rgba4444",
"value": 842088786,
"summary": "16-bit RBGA format, [15:0] R:G:B:A 4:4:4:4 little endian",
"since": 1,
"description": null
},
{
"name": "bgra4444",
"value": 842088770,
"summary": "16-bit BGRA format, [15:0] B:G:R:A 4:4:4:4 little endian",
"since": 1,
"description": null
},
{
"name": "xrgb1555",
"value": 892424792,
"summary": "16-bit xRGB format, [15:0] x:R:G:B 1:5:5:5 little endian",
"since": 1,
"description": null
},
{
"name": "xbgr1555",
"value": 892420696,
"summary": "16-bit xBGR 1555 format, [15:0] x:B:G:R 1:5:5:5 little endian",
"since": 1,
"description": null
},
{
"name": "rgbx5551",
"value": 892426322,
"summary": "16-bit RGBx 5551 format, [15:0] R:G:B:x 5:5:5:1 little endian",
"since": 1,
"description": null
},
{
"name": "bgrx5551",
"value": 892426306,
"summary": "16-bit BGRx 5551 format, [15:0] B:G:R:x 5:5:5:1 little endian",
"since": 1,
"description": null
},
{
"name": "argb1555",
"value": 892424769,
"summary": "16-bit ARGB 1555 format, [15:0] A:R:G:B 1:5:5:5 little endian",
"since": 1,
"description": null
},
{
"name": "abgr1555",
"value": 892420673,
"summary": "16-bit ABGR 1555 format, [15:0] A:B:G:R 1:5:5:5 little endian",
"since": 1,
"description": null
},
{
"name": "rgba5551",
"value": 892420434,
"summary": "16-bit RGBA 5551 format, [15:0] R:G:B:A 5:5:5:1 little endian",
"since": 1,
"description": null
},
{
"name": "bgra5551",
"value": 892420418,
"summary": "16-bit BGRA 5551 format, [15:0] B:G:R:A 5:5:5:1 little endian",
"since": 1,
"description": null
},
{
"name": "rgb565",
"value": 909199186,
"summary": "16-bit RGB 565 format, [15:0] R:G:B 5:6:5 little endian",
"since": 1,
"description": null
},
{
"name": "bgr565",
"value": 909199170,
"summary": "16-bit BGR 565 format, [15:0] B:G:R 5:6:5 little endian",
"since": 1,
"description": null
},
{
"name": "rgb888",
"value": 875710290,
"summary": "24-bit RGB format, [23:0] R:G:B little endian",
"since": 1,
"description": null
},
{
"name": "bgr888",
"value": 875710274,
"summary": "24-bit BGR format, [23:0] B:G:R little endian",
"since": 1,
"description": null
},
{
"name": "xbgr8888",
"value": 875709016,
"summary": "32-bit xBGR format, [31:0] x:B:G:R 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "rgbx8888",
"value": 875714642,
"summary": "32-bit RGBx format, [31:0] R:G:B:x 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "bgrx8888",
"value": 875714626,
"summary": "32-bit BGRx format, [31:0] B:G:R:x 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "abgr8888",
"value": 875708993,
"summary": "32-bit ABGR format, [31:0] A:B:G:R 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "rgba8888",
"value": 875708754,
"summary": "32-bit RGBA format, [31:0] R:G:B:A 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "bgra8888",
"value": 875708738,
"summary": "32-bit BGRA format, [31:0] B:G:R:A 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "xrgb2101010",
"value": 808669784,
"summary": "32-bit xRGB format, [31:0] x:R:G:B 2:10:10:10 little endian",
"since": 1,
"description": null
},
{
"name": "xbgr2101010",
"value": 808665688,
"summary": "32-bit xBGR format, [31:0] x:B:G:R 2:10:10:10 little endian",
"since": 1,
"description": null
},
{
"name": "rgbx1010102",
"value": 808671314,
"summary": "32-bit RGBx format, [31:0] R:G:B:x 10:10:10:2 little endian",
"since": 1,
"description": null
},
{
"name": "bgrx1010102",
"value": 808671298,
"summary": "32-bit BGRx format, [31:0] B:G:R:x 10:10:10:2 little endian",
"since": 1,
"description": null
},
{
"name": "argb2101010",
"value": 808669761,
"summary": "32-bit ARGB format, [31:0] A:R:G:B 2:10:10:10 little endian",
"since": 1,
"description": null
},
{
"name": "abgr2101010",
"value": 808665665,
"summary": "32-bit ABGR format, [31:0] A:B:G:R 2:10:10:10 little endian",
"since": 1,
"description": null
},
{
"name": "rgba1010102",
"value": 808665426,
"summary": "32-bit RGBA format, [31:0] R:G:B:A 10:10:10:2 little endian",
"since": 1,
"description": null
},
{
"name": "bgra1010102",
"value": 808665410,
"summary": "32-bit BGRA format, [31:0] B:G:R:A 10:10:10:2 little endian",
"since": 1,
"description": null
},
{
"name": "yuyv",
"value": 1448695129,
"summary": "packed YCbCr format, [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "yvyu",
"value": 1431918169,
"summary": "packed YCbCr format, [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "uyvy",
"value": 1498831189,
"summary": "packed YCbCr format, [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "vyuy",
"value": 1498765654,
"summary": "packed YCbCr format, [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "ayuv",
"value": 1448433985,
"summary": "packed AYCbCr format, [31:0] A:Y:Cb:Cr 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "nv12",
"value": 842094158,
"summary": "2 plane YCbCr Cr:Cb format, 2x2 subsampled Cr:Cb plane",
"since": 1,
"description": null
},
{
"name": "nv21",
"value": 825382478,
"summary": "2 plane YCbCr Cb:Cr format, 2x2 subsampled Cb:Cr plane",
"since": 1,
"description": null
},
{
"name": "nv16",
"value": 909203022,
"summary": "2 plane YCbCr Cr:Cb format, 2x1 subsampled Cr:Cb plane",
"since": 1,
"description": null
},
{
"name": "nv61",
"value": 825644622,
"summary": "2 plane YCbCr Cb:Cr format, 2x1 subsampled Cb:Cr plane",
"since": 1,
"description": null
},
{
"name": "yuv410",
"value": 961959257,
"summary": "3 plane YCbCr format, 4x4 subsampled Cb (1) and Cr (2) planes",
"since": 1,
"description": null
},
{
"name": "yvu410",
"value": 961893977,
"summary": "3 plane YCbCr format, 4x4 subsampled Cr (1) and Cb (2) planes",
"since": 1,
"description": null
},
{
"name": "yuv411",
"value": 825316697,
"summary": "3 plane YCbCr format, 4x1 subsampled Cb (1) and Cr (2) planes",
"since": 1,
"description": null
},
{
"name": "yvu411",
"value": 825316953,
"summary": "3 plane YCbCr format, 4x1 subsampled Cr (1) and Cb (2) planes",
"since": 1,
"description": null
},
{
"name": "yuv420",
"value": 842093913,
"summary": "3 plane YCbCr format, 2x2 subsampled Cb (1) and Cr (2) planes",
"since": 1,
"description": null
},
{
"name": "yvu420",
"value": 842094169,
"summary": "3 plane YCbCr format, 2x2 subsampled Cr (1) and Cb (2) planes",
"since": 1,
"description": null
},
{
"name": "yuv422",
"value": 909202777,
"summary": "3 plane YCbCr format, 2x1 subsampled Cb (1) and Cr (2) planes",
"since": 1,
"description": null
},
{
"name": "yvu422",
"value": 909203033,
"summary": "3 plane YCbCr format, 2x1 subsampled Cr (1) and Cb (2) planes",
"since": 1,
"description": null
},
{
"name": "yuv444",
"value": 875713881,
"summary": "3 plane YCbCr format, non-subsampled Cb (1) and Cr (2) planes",
"since": 1,
"description": null
},
{
"name": "yvu444",
"value": 875714137,
"summary": "3 plane YCbCr format, non-subsampled Cr (1) and Cb (2) planes",
"since": 1,
"description": null
},
{
"name": "r8",
"value": 538982482,
"summary": "[7:0] R",
"since": 1,
"description": null
},
{
"name": "r16",
"value": 540422482,
"summary": "[15:0] R little endian",
"since": 1,
"description": null
},
{
"name": "rg88",
"value": 943212370,
"summary": "[15:0] R:G 8:8 little endian",
"since": 1,
"description": null
},
{
"name": "gr88",
"value": 943215175,
"summary": "[15:0] G:R 8:8 little endian",
"since": 1,
"description": null
},
{
"name": "rg1616",
"value": 842221394,
"summary": "[31:0] R:G 16:16 little endian",
"since": 1,
"description": null
},
{
"name": "gr1616",
"value": 842224199,
"summary": "[31:0] G:R 16:16 little endian",
"since": 1,
"description": null
},
{
"name": "xrgb16161616f",
"value": 1211388504,
"summary": "[63:0] x:R:G:B 16:16:16:16 little endian",
"since": 1,
"description": null
},
{
"name": "xbgr16161616f",
"value": 1211384408,
"summary": "[63:0] x:B:G:R 16:16:16:16 little endian",
"since": 1,
"description": null
},
{
"name": "argb16161616f",
"value": 1211388481,
"summary": "[63:0] A:R:G:B 16:16:16:16 little endian",
"since": 1,
"description": null
},
{
"name": "abgr16161616f",
"value": 1211384385,
"summary": "[63:0] A:B:G:R 16:16:16:16 little endian",
"since": 1,
"description": null
},
{
"name": "xyuv8888",
"value": 1448434008,
"summary": "[31:0] X:Y:Cb:Cr 8:8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "vuy888",
"value": 875713878,
"summary": "[23:0] Cr:Cb:Y 8:8:8 little endian",
"since": 1,
"description": null
},
{
"name": "vuy101010",
"value": 808670550,
"summary": "Y followed by U then V, 10:10:10. Non-linear modifier only",
"since": 1,
"description": null
},
{
"name": "y210",
"value": 808530521,
"summary": "[63:0] Cr0:0:Y1:0:Cb0:0:Y0:0 10:6:10:6:10:6:10:6 little endian per 2 Y pixels",
"since": 1,
"description": null
},
{
"name": "y212",
"value": 842084953,
"summary": "[63:0] Cr0:0:Y1:0:Cb0:0:Y0:0 12:4:12:4:12:4:12:4 little endian per 2 Y pixels",
"since": 1,
"description": null
},
{
"name": "y216",
"value": 909193817,
"summary": "[63:0] Cr0:Y1:Cb0:Y0 16:16:16:16 little endian per 2 Y pixels",
"since": 1,
"description": null
},
{
"name": "y410",
"value": 808531033,
"summary": "[31:0] A:Cr:Y:Cb 2:10:10:10 little endian",
"since": 1,
"description": null
},
{
"name": "y412",
"value": 842085465,
"summary": "[63:0] A:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian",
"since": 1,
"description": null
},
{
"name": "y416",
"value": 909194329,
"summary": "[63:0] A:Cr:Y:Cb 16:16:16:16 little endian",
"since": 1,
"description": null
},
{
"name": "xvyu2101010",
"value": 808670808,
"summary": "[31:0] X:Cr:Y:Cb 2:10:10:10 little endian",
"since": 1,
"description": null
},
{
"name": "xvyu12_16161616",
"value": 909334104,
"summary": "[63:0] X:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian",
"since": 1,
"description": null
},
{
"name": "xvyu16161616",
"value": 942954072,
"summary": "[63:0] X:Cr:Y:Cb 16:16:16:16 little endian",
"since": 1,
"description": null
},
{
"name": "y0l0",
"value": 810299481,
"summary": "[63:0] A3:A2:Y3:0:Cr0:0:Y2:0:A1:A0:Y1:0:Cb0:0:Y0:0 1:1:8:2:8:2:8:2:1:1:8:2:8:2:8:2 little endian",
"since": 1,
"description": null
},
{
"name": "x0l0",
"value": 810299480,
"summary": "[63:0] X3:X2:Y3:0:Cr0:0:Y2:0:X1:X0:Y1:0:Cb0:0:Y0:0 1:1:8:2:8:2:8:2:1:1:8:2:8:2:8:2 little endian",
"since": 1,
"description": null
},
{
"name": "y0l2",
"value": 843853913,
"summary": "[63:0] A3:A2:Y3:Cr0:Y2:A1:A0:Y1:Cb0:Y0 1:1:10:10:10:1:1:10:10:10 little endian",
"since": 1,
"description": null
},
{
"name": "x0l2",
"value": 843853912,
"summary": "[63:0] X3:X2:Y3:Cr0:Y2:X1:X0:Y1:Cb0:Y0 1:1:10:10:10:1:1:10:10:10 little endian",
"since": 1,
"description": null
},
{
"name": "yuv420_8bit",
"value": 942691673,
"summary": null,
"since": 1,
"description": null
},
{
"name": "yuv420_10bit",
"value": 808539481,
"summary": null,
"since": 1,
"description": null
},
{
"name": "xrgb8888_a8",
"value": 943805016,
"summary": null,
"since": 1,
"description": null
},
{
"name": "xbgr8888_a8",
"value": 943800920,
"summary": null,
"since": 1,
"description": null
},
{
"name": "rgbx8888_a8",
"value": 943806546,
"summary": null,
"since": 1,
"description": null
},
{
"name": "bgrx8888_a8",
"value": 943806530,
"summary": null,
"since": 1,
"description": null
},
{
"name": "rgb888_a8",
"value": 943798354,
"summary": null,
"since": 1,
"description": null
},
{
"name": "bgr888_a8",
"value": 943798338,
"summary": null,
"since": 1,
"description": null
},
{
"name": "rgb565_a8",
"value": 943797586,
"summary": null,
"since": 1,
"description": null
},
{
"name": "bgr565_a8",
"value": 943797570,
"summary": null,
"since": 1,
"description": null
},
{
"name": "nv24",
"value": 875714126,
"summary": "non-subsampled Cr:Cb plane",
"since": 1,
"description": null
},
{
"name": "nv42",
"value": 842290766,
"summary": "non-subsampled Cb:Cr plane",
"since": 1,
"description": null
},
{
"name": "p210",
"value": 808530512,
"summary": "2x1 subsampled Cr:Cb plane, 10 bit per channel",
"since": 1,
"description": null
},
{
"name": "p010",
"value": 808530000,
"summary": "2x2 subsampled Cr:Cb plane 10 bits per channel",
"since": 1,
"description": null
},
{
"name": "p012",
"value": 842084432,
"summary": "2x2 subsampled Cr:Cb plane 12 bits per channel",
"since": 1,
"description": null
},
{
"name": "p016",
"value": 909193296,
"summary": "2x2 subsampled Cr:Cb plane 16 bits per channel",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_buffer",
"version": 1,
"description": {
"summary": "content for a wl_surface",
"body": "A buffer provides the content for a wl_surface. Buffers are\n created through factory interfaces such as wl_drm, wl_shm or\n similar. It has a width and a height and can be attached to a\n wl_surface, but the mechanism by which a client provides and\n updates the contents is defined by the buffer factory interface."
},
"requests": [
{
"name": "destroy",
"destructor": true,
"since": 1,
"description": {
"summary": "destroy a buffer",
"body": "Destroy a buffer. If and how you need to release the backing\n\tstorage is defined by the buffer factory interface.\n\n\tFor possible side-effects to a surface, see wl_surface.attach."
},
"args": []
}
],
"events": [
{
"name": "release",
"since": 1,
"description": {
"summary": "compositor releases buffer",
"body": "Sent when this wl_buffer is no longer used by the compositor.\n\tThe client is now free to reuse or destroy this buffer and its\n\tbacking storage.\n\n\tIf a client receives a release event before the frame callback\n\trequested in the same wl_surface.commit that attaches this\n\twl_buffer to a surface, then the client is immediately free to\n\treuse the buffer and its backing storage, and does not need a\n\tsecond buffer for the next surface content update. Typically\n\tthis is possible, when the compositor maintains a copy of the\n\twl_surface contents, e.g. as a GL texture. This is an important\n\toptimization for GL(ES) compositors with wl_shm clients."
},
"args": []
}
],
"enums": []
},
{
"name": "wl_data_offer",
"version": 3,
"description": {
"summary": "offer to transfer data",
"body": "A wl_data_offer represents a piece of data offered for transfer\n by another client (the source client). It is used by the\n copy-and-paste and drag-and-drop mechanisms. The offer\n describes the different mime types that the data can be\n converted to and provides the mechanism for transferring the\n data directly from the source client."
},
"requests": [
{
"name": "accept",
"destructor": false,
"since": 1,
"description": {
"summary": "accept one of the offered mime types",
"body": "Indicate that the client can accept the given mime type, or\n\tNULL for not accepted.\n\n\tFor objects of version 2 or older, this request is used by the\n\tclient to give feedback whether the client can receive the given\n\tmime type, or NULL if none is accepted; the feedback does not\n\tdetermine whether the drag-and-drop operation succeeds or not.\n\n\tFor objects of version 3 or newer, this request determines the\n\tfinal result of the drag-and-drop operation. If the end result\n\tis that no mime types were accepted, the drag-and-drop operation\n\twill be cancelled and the corresponding drag source will receive\n\twl_data_source.cancelled. Clients may still use this event in\n\tconjunction with wl_data_source.action for feedback."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the accept request",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "mime_type",
"kind": "String",
"summary": "mime type accepted by the client",
"interface": null,
"allow_null": true,
"enumeration": null,
"description": null
}
]
},
{
"name": "receive",
"destructor": false,
"since": 1,
"description": {
"summary": "request that the data is transferred",
"body": "To transfer the offered data, the client issues this request\n\tand indicates the mime type it wants to receive. The transfer\n\thappens through the passed file descriptor (typically created\n\twith the pipe system call). The source client writes the data\n\tin the mime type representation requested and then closes the\n\tfile descriptor.\n\n\tThe receiving client reads from the read end of the pipe until\n\tEOF and then closes its end, at which point the transfer is\n\tcomplete.\n\n\tThis request may happen multiple times for different mime types,\n\tboth before and after wl_data_device.drop. Drag-and-drop destination\n\tclients may preemptively fetch data or examine it more closely to\n\tdetermine acceptance."
},
"args": [
{
"name": "mime_type",
"kind": "String",
"summary": "mime type desired by receiver",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "fd",
"kind": "Fd",
"summary": "file descriptor for data transfer",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "destroy",
"destructor": true,
"since": 1,
"description": {
"summary": "destroy data offer",
"body": "Destroy the data offer."
},
"args": []
},
{
"name": "finish",
"destructor": false,
"since": 3,
"description": {
"summary": "the offer will no longer be used",
"body": "Notifies the compositor that the drag destination successfully\n\tfinished the drag-and-drop operation.\n\n\tUpon receiving this request, the compositor will emit\n\twl_data_source.dnd_finished on the drag source client.\n\n\tIt is a client error to perform other requests than\n\twl_data_offer.destroy after this one. It is also an error to perform\n\tthis request after a NULL mime type has been set in\n\twl_data_offer.accept or no action was received through\n\twl_data_offer.action.\n\n\tIf wl_data_offer.finish request is received for a non drag and drop\n\toperation, the invalid_finish protocol error is raised."
},
"args": []
},
{
"name": "set_actions",
"destructor": false,
"since": 3,
"description": {
"summary": "set the available/preferred drag-and-drop actions",
"body": "Sets the actions that the destination side client supports for\n\tthis operation. This request may trigger the emission of\n\twl_data_source.action and wl_data_offer.action events if the compositor\n\tneeds to change the selected action.\n\n\tThis request can be called multiple times throughout the\n\tdrag-and-drop operation, typically in response to wl_data_device.enter\n\tor wl_data_device.motion events.\n\n\tThis request determines the final result of the drag-and-drop\n\toperation. If the end result is that no action is accepted,\n\tthe drag source will receive wl_data_source.cancelled.\n\n\tThe dnd_actions argument must contain only values expressed in the\n\twl_data_device_manager.dnd_actions enum, and the preferred_action\n\targument must only contain one of those values set, otherwise it\n\twill result in a protocol error.\n\n\tWhile managing an \"ask\" action, the destination drag-and-drop client\n\tmay perform further wl_data_offer.receive requests, and is expected\n\tto perform one last wl_data_offer.set_actions request with a preferred\n\taction other than \"ask\" (and optionally wl_data_offer.accept) before\n\trequesting wl_data_offer.finish, in order to convey the action selected\n\tby the user. If the preferred action is not in the\n\twl_data_offer.source_actions mask, an error will be raised.\n\n\tIf the \"ask\" action is dismissed (e.g. user cancellation), the client\n\tis expected to perform wl_data_offer.destroy right away.\n\n\tThis request can only be made on drag-and-drop offers, a protocol error\n\twill be raised otherwise."
},
"args": [
{
"name": "dnd_actions",
"kind": "Uint",
"summary": "actions supported by the destination client",
"interface": null,
"allow_null": false,
"enumeration": "wl_data_device_manager.dnd_action",
"description": null
},
{
"name": "preferred_action",
"kind": "Uint",
"summary": "action preferred by the destination client",
"interface": null,
"allow_null": false,
"enumeration": "wl_data_device_manager.dnd_action",
"description": null
}
]
}
],
"events": [
{
"name": "offer",
"since": 1,
"description": {
"summary": "advertise offered mime type",
"body": "Sent immediately after creating the wl_data_offer object. One\n\tevent per offered mime type."
},
"args": [
{
"name": "mime_type",
"kind": "String",
"summary": "offered mime type",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "source_actions",
"since": 3,
"description": {
"summary": "notify the source-side available actions",
"body": "This event indicates the actions offered by the data source. It\n\twill be sent right after wl_data_device.enter, or anytime the source\n\tside changes its offered actions through wl_data_source.set_actions."
},
"args": [
{
"name": "source_actions",
"kind": "Uint",
"summary": "actions offered by the data source",
"interface": null,
"allow_null": false,
"enumeration": "wl_data_device_manager.dnd_action",
"description": null
}
]
},
{
"name": "action",
"since": 3,
"description": {
"summary": "notify the selected action",
"body": "This event indicates the action selected by the compositor after\n\tmatching the source/destination side actions. Only one action (or\n\tnone) will be offered here.\n\n\tThis event can be emitted multiple times during the drag-and-drop\n\toperation in response to destination side action changes through\n\twl_data_offer.set_actions.\n\n\tThis event will no longer be emitted after wl_data_device.drop\n\thappened on the drag-and-drop destination, the client must\n\thonor the last action received, or the last preferred one set\n\tthrough wl_data_offer.set_actions when handling an \"ask\" action.\n\n\tCompositors may also change the selected action on the fly, mainly\n\tin response to keyboard modifier changes during the drag-and-drop\n\toperation.\n\n\tThe most recent action received is always the valid one. Prior to\n\treceiving wl_data_device.drop, the chosen action may change (e.g.\n\tdue to keyboard modifiers being pressed). At the time of receiving\n\twl_data_device.drop the drag-and-drop destination must honor the\n\tlast action received.\n\n\tAction changes may still happen after wl_data_device.drop,\n\tespecially on \"ask\" actions, where the drag-and-drop destination\n\tmay choose another action afterwards. Action changes happening\n\tat this stage are always the result of inter-client negotiation, the\n\tcompositor shall no longer be able to induce a different action.\n\n\tUpon \"ask\" actions, it is expected that the drag-and-drop destination\n\tmay potentially choose a different action and/or mime type,\n\tbased on wl_data_offer.source_actions and finally chosen by the\n\tuser (e.g. popping up a menu with the available options). The\n\tfinal wl_data_offer.set_actions and wl_data_offer.accept requests\n\tmust happen before the call to wl_data_offer.finish."
},
"args": [
{
"name": "dnd_action",
"kind": "Uint",
"summary": "action selected by the compositor",
"interface": null,
"allow_null": false,
"enumeration": "wl_data_device_manager.dnd_action",
"description": null
}
]
}
],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": null,
"entries": [
{
"name": "invalid_finish",
"value": 0,
"summary": "finish request was called untimely",
"since": 1,
"description": null
},
{
"name": "invalid_action_mask",
"value": 1,
"summary": "action mask contains invalid values",
"since": 1,
"description": null
},
{
"name": "invalid_action",
"value": 2,
"summary": "action argument has an invalid value",
"since": 1,
"description": null
},
{
"name": "invalid_offer",
"value": 3,
"summary": "offer doesn't accept this request",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_data_source",
"version": 3,
"description": {
"summary": "offer to transfer data",
"body": "The wl_data_source object is the source side of a wl_data_offer.\n It is created by the source client in a data transfer and\n provides a way to describe the offered data and a way to respond\n to requests to transfer the data."
},
"requests": [
{
"name": "offer",
"destructor": false,
"since": 1,
"description": {
"summary": "add an offered mime type",
"body": "This request adds a mime type to the set of mime types\n\tadvertised to targets. Can be called several times to offer\n\tmultiple types."
},
"args": [
{
"name": "mime_type",
"kind": "String",
"summary": "mime type offered by the data source",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "destroy",
"destructor": true,
"since": 1,
"description": {
"summary": "destroy the data source",
"body": "Destroy the data source."
},
"args": []
},
{
"name": "set_actions",
"destructor": false,
"since": 3,
"description": {
"summary": "set the available drag-and-drop actions",
"body": "Sets the actions that the source side client supports for this\n\toperation. This request may trigger wl_data_source.action and\n\twl_data_offer.action events if the compositor needs to change the\n\tselected action.\n\n\tThe dnd_actions argument must contain only values expressed in the\n\twl_data_device_manager.dnd_actions enum, otherwise it will result\n\tin a protocol error.\n\n\tThis request must be made once only, and can only be made on sources\n\tused in drag-and-drop, so it must be performed before\n\twl_data_device.start_drag. Attempting to use the source other than\n\tfor drag-and-drop will raise a protocol error."
},
"args": [
{
"name": "dnd_actions",
"kind": "Uint",
"summary": "actions supported by the data source",
"interface": null,
"allow_null": false,
"enumeration": "wl_data_device_manager.dnd_action",
"description": null
}
]
}
],
"events": [
{
"name": "target",
"since": 1,
"description": {
"summary": "a target accepts an offered mime type",
"body": "Sent when a target accepts pointer_focus or motion events. If\n\ta target does not accept any of the offered types, type is NULL.\n\n\tUsed for feedback during drag-and-drop."
},
"args": [
{
"name": "mime_type",
"kind": "String",
"summary": "mime type accepted by the target",
"interface": null,
"allow_null": true,
"enumeration": null,
"description": null
}
]
},
{
"name": "send",
"since": 1,
"description": {
"summary": "send the data",
"body": "Request for data from the client. Send the data as the\n\tspecified mime type over the passed file descriptor, then\n\tclose it."
},
"args": [
{
"name": "mime_type",
"kind": "String",
"summary": "mime type for the data",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "fd",
"kind": "Fd",
"summary": "file descriptor for the data",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "cancelled",
"since": 1,
"description": {
"summary": "selection was cancelled",
"body": "This data source is no longer valid. There are several reasons why\n\tthis could happen:\n\n\t- The data source has been replaced by another data source.\n\t- The drag-and-drop operation was performed, but the drop destination\n\t did not accept any of the mime types offered through\n\t wl_data_source.target.\n\t- The drag-and-drop operation was performed, but the drop destination\n\t did not select any of the actions present in the mask offered through\n\t wl_data_source.action.\n\t- The drag-and-drop operation was performed but didn't happen over a\n\t surface.\n\t- The compositor cancelled the drag-and-drop operation (e.g. compositor\n\t dependent timeouts to avoid stale drag-and-drop transfers).\n\n\tThe client should clean up and destroy this data source.\n\n\tFor objects of version 2 or older, wl_data_source.cancelled will\n\tonly be emitted if the data source was replaced by another data\n\tsource."
},
"args": []
},
{
"name": "dnd_drop_performed",
"since": 3,
"description": {
"summary": "the drag-and-drop operation physically finished",
"body": "The user performed the drop action. This event does not indicate\n\tacceptance, wl_data_source.cancelled may still be emitted afterwards\n\tif the drop destination does not accept any mime type.\n\n\tHowever, this event might however not be received if the compositor\n\tcancelled the drag-and-drop operation before this event could happen.\n\n\tNote that the data_source may still be used in the future and should\n\tnot be destroyed here."
},
"args": []
},
{
"name": "dnd_finished",
"since": 3,
"description": {
"summary": "the drag-and-drop operation concluded",
"body": "The drop destination finished interoperating with this data\n\tsource, so the client is now free to destroy this data source and\n\tfree all associated data.\n\n\tIf the action used to perform the operation was \"move\", the\n\tsource can now delete the transferred data."
},
"args": []
},
{
"name": "action",
"since": 3,
"description": {
"summary": "notify the selected action",
"body": "This event indicates the action selected by the compositor after\n\tmatching the source/destination side actions. Only one action (or\n\tnone) will be offered here.\n\n\tThis event can be emitted multiple times during the drag-and-drop\n\toperation, mainly in response to destination side changes through\n\twl_data_offer.set_actions, and as the data device enters/leaves\n\tsurfaces.\n\n\tIt is only possible to receive this event after\n\twl_data_source.dnd_drop_performed if the drag-and-drop operation\n\tended in an \"ask\" action, in which case the final wl_data_source.action\n\tevent will happen immediately before wl_data_source.dnd_finished.\n\n\tCompositors may also change the selected action on the fly, mainly\n\tin response to keyboard modifier changes during the drag-and-drop\n\toperation.\n\n\tThe most recent action received is always the valid one. The chosen\n\taction may change alongside negotiation (e.g. an \"ask\" action can turn\n\tinto a \"move\" operation), so the effects of the final action must\n\talways be applied in wl_data_offer.dnd_finished.\n\n\tClients can trigger cursor surface changes from this point, so\n\tthey reflect the current action."
},
"args": [
{
"name": "dnd_action",
"kind": "Uint",
"summary": "action selected by the compositor",
"interface": null,
"allow_null": false,
"enumeration": "wl_data_device_manager.dnd_action",
"description": null
}
]
}
],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": null,
"entries": [
{
"name": "invalid_action_mask",
"value": 0,
"summary": "action mask contains invalid values",
"since": 1,
"description": null
},
{
"name": "invalid_source",
"value": 1,
"summary": "source doesn't accept this request",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_data_device",
"version": 3,
"description": {
"summary": "data transfer device",
"body": "There is one wl_data_device per seat which can be obtained\n from the global wl_data_device_manager singleton.\n\n A wl_data_device provides access to inter-client data transfer\n mechanisms such as copy-and-paste and drag-and-drop."
},
"requests": [
{
"name": "start_drag",
"destructor": false,
"since": 1,
"description": {
"summary": "start drag-and-drop operation",
"body": "This request asks the compositor to start a drag-and-drop\n\toperation on behalf of the client.\n\n\tThe source argument is the data source that provides the data\n\tfor the eventual data transfer. If source is NULL, enter, leave\n\tand motion events are sent only to the client that initiated the\n\tdrag and the client is expected to handle the data passing\n\tinternally.\n\n\tThe origin surface is the surface where the drag originates and\n\tthe client must have an active implicit grab that matches the\n\tserial.\n\n\tThe icon surface is an optional (can be NULL) surface that\n\tprovides an icon to be moved around with the cursor. Initially,\n\tthe top-left corner of the icon surface is placed at the cursor\n\thotspot, but subsequent wl_surface.attach request can move the\n\trelative position. Attach requests must be confirmed with\n\twl_surface.commit as usual. The icon surface is given the role of\n\ta drag-and-drop icon. If the icon surface already has another role,\n\tit raises a protocol error.\n\n\tThe current and pending input regions of the icon wl_surface are\n\tcleared, and wl_surface.set_input_region is ignored until the\n\twl_surface is no longer used as the icon surface. When the use\n\tas an icon ends, the current and pending input regions become\n\tundefined, and the wl_surface is unmapped."
},
"args": [
{
"name": "source",
"kind": "Object",
"summary": "data source for the eventual transfer",
"interface": "wl_data_source",
"allow_null": true,
"enumeration": null,
"description": null
},
{
"name": "origin",
"kind": "Object",
"summary": "surface where the drag originates",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "icon",
"kind": "Object",
"summary": "drag-and-drop icon surface",
"interface": "wl_surface",
"allow_null": true,
"enumeration": null,
"description": null
},
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the implicit grab on the origin",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "set_selection",
"destructor": false,
"since": 1,
"description": {
"summary": "copy data to the selection",
"body": "This request asks the compositor to set the selection\n\tto the data from the source on behalf of the client.\n\n\tTo unset the selection, set the source to NULL."
},
"args": [
{
"name": "source",
"kind": "Object",
"summary": "data source for the selection",
"interface": "wl_data_source",
"allow_null": true,
"enumeration": null,
"description": null
},
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the event that triggered this request",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "release",
"destructor": true,
"since": 2,
"description": {
"summary": "destroy data device",
"body": "This request destroys the data device."
},
"args": []
}
],
"events": [
{
"name": "data_offer",
"since": 1,
"description": {
"summary": "introduce a new wl_data_offer",
"body": "The data_offer event introduces a new wl_data_offer object,\n\twhich will subsequently be used in either the\n\tdata_device.enter event (for drag-and-drop) or the\n\tdata_device.selection event (for selections). Immediately\n\tfollowing the data_device_data_offer event, the new data_offer\n\tobject will send out data_offer.offer events to describe the\n\tmime types it offers."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "the new data_offer object",
"interface": "wl_data_offer",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "enter",
"since": 1,
"description": {
"summary": "initiate drag-and-drop session",
"body": "This event is sent when an active drag-and-drop pointer enters\n\ta surface owned by the client. The position of the pointer at\n\tenter time is provided by the x and y arguments, in surface-local\n\tcoordinates."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the enter event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface",
"kind": "Object",
"summary": "client surface entered",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "x",
"kind": "Fixed",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Fixed",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "id",
"kind": "Object",
"summary": "source data_offer object",
"interface": "wl_data_offer",
"allow_null": true,
"enumeration": null,
"description": null
}
]
},
{
"name": "leave",
"since": 1,
"description": {
"summary": "end drag-and-drop session",
"body": "This event is sent when the drag-and-drop pointer leaves the\n\tsurface and the session ends. The client must destroy the\n\twl_data_offer introduced at enter time at this point."
},
"args": []
},
{
"name": "motion",
"since": 1,
"description": {
"summary": "drag-and-drop session motion",
"body": "This event is sent when the drag-and-drop pointer moves within\n\tthe currently focused surface. The new position of the pointer\n\tis provided by the x and y arguments, in surface-local\n\tcoordinates."
},
"args": [
{
"name": "time",
"kind": "Uint",
"summary": "timestamp with millisecond granularity",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "x",
"kind": "Fixed",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Fixed",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "drop",
"since": 1,
"description": {
"summary": "end drag-and-drop session successfully",
"body": "The event is sent when a drag-and-drop operation is ended\n\tbecause the implicit grab is removed.\n\n\tThe drag-and-drop destination is expected to honor the last action\n\treceived through wl_data_offer.action, if the resulting action is\n\t\"copy\" or \"move\", the destination can still perform\n\twl_data_offer.receive requests, and is expected to end all\n\ttransfers with a wl_data_offer.finish request.\n\n\tIf the resulting action is \"ask\", the action will not be considered\n\tfinal. The drag-and-drop destination is expected to perform one last\n\twl_data_offer.set_actions request, or wl_data_offer.destroy in order\n\tto cancel the operation."
},
"args": []
},
{
"name": "selection",
"since": 1,
"description": {
"summary": "advertise new selection",
"body": "The selection event is sent out to notify the client of a new\n\twl_data_offer for the selection for this device. The\n\tdata_device.data_offer and the data_offer.offer events are\n\tsent out immediately before this event to introduce the data\n\toffer object. The selection event is sent to a client\n\timmediately before receiving keyboard focus and when a new\n\tselection is set while the client has keyboard focus. The\n\tdata_offer is valid until a new data_offer or NULL is received\n\tor until the client loses keyboard focus. The client must\n\tdestroy the previous selection data_offer, if any, upon receiving\n\tthis event."
},
"args": [
{
"name": "id",
"kind": "Object",
"summary": "selection data_offer object",
"interface": "wl_data_offer",
"allow_null": true,
"enumeration": null,
"description": null
}
]
}
],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": null,
"entries": [
{
"name": "role",
"value": 0,
"summary": "given wl_surface has another role",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_data_device_manager",
"version": 3,
"description": {
"summary": "data transfer interface",
"body": "The wl_data_device_manager is a singleton global object that\n provides access to inter-client data transfer mechanisms such as\n copy-and-paste and drag-and-drop. These mechanisms are tied to\n a wl_seat and this interface lets a client get a wl_data_device\n corresponding to a wl_seat.\n\n Depending on the version bound, the objects created from the bound\n wl_data_device_manager object will have different requirements for\n functioning properly. See wl_data_source.set_actions,\n wl_data_offer.accept and wl_data_offer.finish for details."
},
"requests": [
{
"name": "create_data_source",
"destructor": false,
"since": 1,
"description": {
"summary": "create a new data source",
"body": "Create a new data source."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "data source to create",
"interface": "wl_data_source",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "get_data_device",
"destructor": false,
"since": 1,
"description": {
"summary": "create a new data device",
"body": "Create a new data device for a given seat."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "data device to create",
"interface": "wl_data_device",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "seat",
"kind": "Object",
"summary": "seat associated with the data device",
"interface": "wl_seat",
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [],
"enums": [
{
"name": "dnd_action",
"since": 3,
"bitfield": true,
"description": {
"summary": "drag and drop actions",
"body": "This is a bitmask of the available/preferred actions in a\n\tdrag-and-drop operation.\n\n\tIn the compositor, the selected action is a result of matching the\n\tactions offered by the source and destination sides. \"action\" events\n\twith a \"none\" action will be sent to both source and destination if\n\tthere is no match. All further checks will effectively happen on\n\t(source actions ∩ destination actions).\n\n\tIn addition, compositors may also pick different actions in\n\treaction to key modifiers being pressed. One common design that\n\tis used in major toolkits (and the behavior recommended for\n\tcompositors) is:\n\n\t- If no modifiers are pressed, the first match (in bit order)\n\t will be used.\n\t- Pressing Shift selects \"move\", if enabled in the mask.\n\t- Pressing Control selects \"copy\", if enabled in the mask.\n\n\tBehavior beyond that is considered implementation-dependent.\n\tCompositors may for example bind other modifiers (like Alt/Meta)\n\tor drags initiated with other buttons than BTN_LEFT to specific\n\tactions (e.g. \"ask\")."
},
"entries": [
{
"name": "none",
"value": 0,
"summary": "no action",
"since": 1,
"description": null
},
{
"name": "copy",
"value": 1,
"summary": "copy action",
"since": 1,
"description": null
},
{
"name": "move",
"value": 2,
"summary": "move action",
"since": 1,
"description": null
},
{
"name": "ask",
"value": 4,
"summary": "ask action",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_shell",
"version": 1,
"description": {
"summary": "create desktop-style surfaces",
"body": "This interface is implemented by servers that provide\n desktop-style user interfaces.\n\n It allows clients to associate a wl_shell_surface with\n a basic surface.\n\n Note! This protocol is deprecated and not intended for production use.\n For desktop-style user interfaces, use xdg_shell."
},
"requests": [
{
"name": "get_shell_surface",
"destructor": false,
"since": 1,
"description": {
"summary": "create a shell surface from a surface",
"body": "Create a shell surface for an existing surface. This gives\n\tthe wl_surface the role of a shell surface. If the wl_surface\n\talready has another role, it raises a protocol error.\n\n\tOnly one shell surface can be associated with a given surface."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "shell surface to create",
"interface": "wl_shell_surface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface",
"kind": "Object",
"summary": "surface to be given the shell surface role",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": null,
"entries": [
{
"name": "role",
"value": 0,
"summary": "given wl_surface has another role",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_shell_surface",
"version": 1,
"description": {
"summary": "desktop-style metadata interface",
"body": "An interface that may be implemented by a wl_surface, for\n implementations that provide a desktop-style user interface.\n\n It provides requests to treat surfaces like toplevel, fullscreen\n or popup windows, move, resize or maximize them, associate\n metadata like title and class, etc.\n\n On the server side the object is automatically destroyed when\n the related wl_surface is destroyed. On the client side,\n wl_shell_surface_destroy() must be called before destroying\n the wl_surface object."
},
"requests": [
{
"name": "pong",
"destructor": false,
"since": 1,
"description": {
"summary": "respond to a ping event",
"body": "A client must respond to a ping event with a pong request or\n\tthe client may be deemed unresponsive."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the ping event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "move",
"destructor": false,
"since": 1,
"description": {
"summary": "start an interactive move",
"body": "Start a pointer-driven move of the surface.\n\n\tThis request must be used in response to a button press event.\n\tThe server may ignore move requests depending on the state of\n\tthe surface (e.g. fullscreen or maximized)."
},
"args": [
{
"name": "seat",
"kind": "Object",
"summary": "seat whose pointer is used",
"interface": "wl_seat",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the implicit grab on the pointer",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "resize",
"destructor": false,
"since": 1,
"description": {
"summary": "start an interactive resize",
"body": "Start a pointer-driven resizing of the surface.\n\n\tThis request must be used in response to a button press event.\n\tThe server may ignore resize requests depending on the state of\n\tthe surface (e.g. fullscreen or maximized)."
},
"args": [
{
"name": "seat",
"kind": "Object",
"summary": "seat whose pointer is used",
"interface": "wl_seat",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the implicit grab on the pointer",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "edges",
"kind": "Uint",
"summary": "which edge or corner is being dragged",
"interface": null,
"allow_null": false,
"enumeration": "resize",
"description": null
}
]
},
{
"name": "set_toplevel",
"destructor": false,
"since": 1,
"description": {
"summary": "make the surface a toplevel surface",
"body": "Map the surface as a toplevel surface.\n\n\tA toplevel surface is not fullscreen, maximized or transient."
},
"args": []
},
{
"name": "set_transient",
"destructor": false,
"since": 1,
"description": {
"summary": "make the surface a transient surface",
"body": "Map the surface relative to an existing surface.\n\n\tThe x and y arguments specify the location of the upper left\n\tcorner of the surface relative to the upper left corner of the\n\tparent surface, in surface-local coordinates.\n\n\tThe flags argument controls details of the transient behaviour."
},
"args": [
{
"name": "parent",
"kind": "Object",
"summary": "parent surface",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "x",
"kind": "Int",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Int",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "flags",
"kind": "Uint",
"summary": "transient surface behavior",
"interface": null,
"allow_null": false,
"enumeration": "transient",
"description": null
}
]
},
{
"name": "set_fullscreen",
"destructor": false,
"since": 1,
"description": {
"summary": "make the surface a fullscreen surface",
"body": "Map the surface as a fullscreen surface.\n\n\tIf an output parameter is given then the surface will be made\n\tfullscreen on that output. If the client does not specify the\n\toutput then the compositor will apply its policy - usually\n\tchoosing the output on which the surface has the biggest surface\n\tarea.\n\n\tThe client may specify a method to resolve a size conflict\n\tbetween the output size and the surface size - this is provided\n\tthrough the method parameter.\n\n\tThe framerate parameter is used only when the method is set\n\tto \"driver\", to indicate the preferred framerate. A value of 0\n\tindicates that the client does not care about framerate. The\n\tframerate is specified in mHz, that is framerate of 60000 is 60Hz.\n\n\tA method of \"scale\" or \"driver\" implies a scaling operation of\n\tthe surface, either via a direct scaling operation or a change of\n\tthe output mode. This will override any kind of output scaling, so\n\tthat mapping a surface with a buffer size equal to the mode can\n\tfill the screen independent of buffer_scale.\n\n\tA method of \"fill\" means we don't scale up the buffer, however\n\tany output scale is applied. This means that you may run into\n\tan edge case where the application maps a buffer with the same\n\tsize of the output mode but buffer_scale 1 (thus making a\n\tsurface larger than the output). In this case it is allowed to\n\tdownscale the results to fit the screen.\n\n\tThe compositor must reply to this request with a configure event\n\twith the dimensions for the output on which the surface will\n\tbe made fullscreen."
},
"args": [
{
"name": "method",
"kind": "Uint",
"summary": "method for resolving size conflict",
"interface": null,
"allow_null": false,
"enumeration": "fullscreen_method",
"description": null
},
{
"name": "framerate",
"kind": "Uint",
"summary": "framerate in mHz",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "output",
"kind": "Object",
"summary": "output on which the surface is to be fullscreen",
"interface": "wl_output",
"allow_null": true,
"enumeration": null,
"description": null
}
]
},
{
"name": "set_popup",
"destructor": false,
"since": 1,
"description": {
"summary": "make the surface a popup surface",
"body": "Map the surface as a popup.\n\n\tA popup surface is a transient surface with an added pointer\n\tgrab.\n\n\tAn existing implicit grab will be changed to owner-events mode,\n\tand the popup grab will continue after the implicit grab ends\n\t(i.e. releasing the mouse button does not cause the popup to\n\tbe unmapped).\n\n\tThe popup grab continues until the window is destroyed or a\n\tmouse button is pressed in any other client's window. A click\n\tin any of the client's surfaces is reported as normal, however,\n\tclicks in other clients' surfaces will be discarded and trigger\n\tthe callback.\n\n\tThe x and y arguments specify the location of the upper left\n\tcorner of the surface relative to the upper left corner of the\n\tparent surface, in surface-local coordinates."
},
"args": [
{
"name": "seat",
"kind": "Object",
"summary": "seat whose pointer is used",
"interface": "wl_seat",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the implicit grab on the pointer",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "parent",
"kind": "Object",
"summary": "parent surface",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "x",
"kind": "Int",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Int",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "flags",
"kind": "Uint",
"summary": "transient surface behavior",
"interface": null,
"allow_null": false,
"enumeration": "transient",
"description": null
}
]
},
{
"name": "set_maximized",
"destructor": false,
"since": 1,
"description": {
"summary": "make the surface a maximized surface",
"body": "Map the surface as a maximized surface.\n\n\tIf an output parameter is given then the surface will be\n\tmaximized on that output. If the client does not specify the\n\toutput then the compositor will apply its policy - usually\n\tchoosing the output on which the surface has the biggest surface\n\tarea.\n\n\tThe compositor will reply with a configure event telling\n\tthe expected new surface size. The operation is completed\n\ton the next buffer attach to this surface.\n\n\tA maximized surface typically fills the entire output it is\n\tbound to, except for desktop elements such as panels. This is\n\tthe main difference between a maximized shell surface and a\n\tfullscreen shell surface.\n\n\tThe details depend on the compositor implementation."
},
"args": [
{
"name": "output",
"kind": "Object",
"summary": "output on which the surface is to be maximized",
"interface": "wl_output",
"allow_null": true,
"enumeration": null,
"description": null
}
]
},
{
"name": "set_title",
"destructor": false,
"since": 1,
"description": {
"summary": "set surface title",
"body": "Set a short title for the surface.\n\n\tThis string may be used to identify the surface in a task bar,\n\twindow list, or other user interface elements provided by the\n\tcompositor.\n\n\tThe string must be encoded in UTF-8."
},
"args": [
{
"name": "title",
"kind": "String",
"summary": "surface title",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "set_class",
"destructor": false,
"since": 1,
"description": {
"summary": "set surface class",
"body": "Set a class for the surface.\n\n\tThe surface class identifies the general class of applications\n\tto which the surface belongs. A common convention is to use the\n\tfile name (or the full path if it is a non-standard location) of\n\tthe application's .desktop file as the class."
},
"args": [
{
"name": "class_",
"kind": "String",
"summary": "surface class",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [
{
"name": "ping",
"since": 1,
"description": {
"summary": "ping client",
"body": "Ping a client to check if it is receiving events and sending\n\trequests. A client is expected to reply with a pong request."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the ping",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "configure",
"since": 1,
"description": {
"summary": "suggest resize",
"body": "The configure event asks the client to resize its surface.\n\n\tThe size is a hint, in the sense that the client is free to\n\tignore it if it doesn't resize, pick a smaller size (to\n\tsatisfy aspect ratio or resize in steps of NxM pixels).\n\n\tThe edges parameter provides a hint about how the surface\n\twas resized. The client may use this information to decide\n\thow to adjust its content to the new size (e.g. a scrolling\n\tarea might adjust its content position to leave the viewable\n\tcontent unmoved).\n\n\tThe client is free to dismiss all but the last configure\n\tevent it received.\n\n\tThe width and height arguments specify the size of the window\n\tin surface-local coordinates."
},
"args": [
{
"name": "edges",
"kind": "Uint",
"summary": "how the surface was resized",
"interface": null,
"allow_null": false,
"enumeration": "resize",
"description": null
},
{
"name": "width",
"kind": "Int",
"summary": "new width of the surface",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "height",
"kind": "Int",
"summary": "new height of the surface",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "popup_done",
"since": 1,
"description": {
"summary": "popup interaction is done",
"body": "The popup_done event is sent out when a popup grab is broken,\n\tthat is, when the user clicks a surface that doesn't belong\n\tto the client owning the popup surface."
},
"args": []
}
],
"enums": [
{
"name": "resize",
"since": 1,
"bitfield": true,
"description": {
"summary": "edge values for resizing",
"body": "These values are used to indicate which edge of a surface\n\tis being dragged in a resize operation. The server may\n\tuse this information to adapt its behavior, e.g. choose\n\tan appropriate cursor image."
},
"entries": [
{
"name": "none",
"value": 0,
"summary": "no edge",
"since": 1,
"description": null
},
{
"name": "top",
"value": 1,
"summary": "top edge",
"since": 1,
"description": null
},
{
"name": "bottom",
"value": 2,
"summary": "bottom edge",
"since": 1,
"description": null
},
{
"name": "left",
"value": 4,
"summary": "left edge",
"since": 1,
"description": null
},
{
"name": "top_left",
"value": 5,
"summary": "top and left edges",
"since": 1,
"description": null
},
{
"name": "bottom_left",
"value": 6,
"summary": "bottom and left edges",
"since": 1,
"description": null
},
{
"name": "right",
"value": 8,
"summary": "right edge",
"since": 1,
"description": null
},
{
"name": "top_right",
"value": 9,
"summary": "top and right edges",
"since": 1,
"description": null
},
{
"name": "bottom_right",
"value": 10,
"summary": "bottom and right edges",
"since": 1,
"description": null
}
]
},
{
"name": "transient",
"since": 1,
"bitfield": true,
"description": {
"summary": "details of transient behaviour",
"body": "These flags specify details of the expected behaviour\n\tof transient surfaces. Used in the set_transient request."
},
"entries": [
{
"name": "inactive",
"value": 1,
"summary": "do not set keyboard focus",
"since": 1,
"description": null
}
]
},
{
"name": "fullscreen_method",
"since": 1,
"bitfield": false,
"description": {
"summary": "different method to set the surface fullscreen",
"body": "Hints to indicate to the compositor how to deal with a conflict\n\tbetween the dimensions of the surface and the dimensions of the\n\toutput. The compositor is free to ignore this parameter."
},
"entries": [
{
"name": "default",
"value": 0,
"summary": "no preference, apply default policy",
"since": 1,
"description": null
},
{
"name": "scale",
"value": 1,
"summary": "scale, preserve the surface's aspect ratio and center on output",
"since": 1,
"description": null
},
{
"name": "driver",
"value": 2,
"summary": "switch output mode to the smallest mode that can fit the surface, add black borders to compensate size mismatch",
"since": 1,
"description": null
},
{
"name": "fill",
"value": 3,
"summary": "no upscaling, center on output and add black borders to compensate size mismatch",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_surface",
"version": 4,
"description": {
"summary": "an onscreen surface",
"body": "A surface is a rectangular area that may be displayed on zero\n or more outputs, and shown any number of times at the compositor's\n discretion. They can present wl_buffers, receive user input, and\n define a local coordinate system.\n\n The size of a surface (and relative positions on it) is described\n in surface-local coordinates, which may differ from the buffer\n coordinates of the pixel content, in case a buffer_transform\n or a buffer_scale is used.\n\n A surface without a \"role\" is fairly useless: a compositor does\n not know where, when or how to present it. The role is the\n purpose of a wl_surface. Examples of roles are a cursor for a\n pointer (as set by wl_pointer.set_cursor), a drag icon\n (wl_data_device.start_drag), a sub-surface\n (wl_subcompositor.get_subsurface), and a window as defined by a\n shell protocol (e.g. wl_shell.get_shell_surface).\n\n A surface can have only one role at a time. Initially a\n wl_surface does not have a role. Once a wl_surface is given a\n role, it is set permanently for the whole lifetime of the\n wl_surface object. Giving the current role again is allowed,\n unless explicitly forbidden by the relevant interface\n specification.\n\n Surface roles are given by requests in other interfaces such as\n wl_pointer.set_cursor. The request should explicitly mention\n that this request gives a role to a wl_surface. Often, this\n request also creates a new protocol object that represents the\n role and adds additional functionality to wl_surface. When a\n client wants to destroy a wl_surface, they must destroy this 'role\n object' before the wl_surface.\n\n Destroying the role object does not remove the role from the\n wl_surface, but it may stop the wl_surface from \"playing the role\".\n For instance, if a wl_subsurface object is destroyed, the wl_surface\n it was created for will be unmapped and forget its position and\n z-order. It is allowed to create a wl_subsurface for the same\n wl_surface again, but it is not allowed to use the wl_surface as\n a cursor (cursor is a different role than sub-surface, and role\n switching is not allowed)."
},
"requests": [
{
"name": "destroy",
"destructor": true,
"since": 1,
"description": {
"summary": "delete surface",
"body": "Deletes the surface and invalidates its object ID."
},
"args": []
},
{
"name": "attach",
"destructor": false,
"since": 1,
"description": {
"summary": "set the surface contents",
"body": "Set a buffer as the content of this surface.\n\n\tThe new size of the surface is calculated based on the buffer\n\tsize transformed by the inverse buffer_transform and the\n\tinverse buffer_scale. This means that at commit time the supplied\n\tbuffer size must be an integer multiple of the buffer_scale. If\n\tthat's not the case, an invalid_size error is sent.\n\n\tThe x and y arguments specify the location of the new pending\n\tbuffer's upper left corner, relative to the current buffer's upper\n\tleft corner, in surface-local coordinates. In other words, the\n\tx and y, combined with the new surface size define in which\n\tdirections the surface's size changes.\n\n\tSurface contents are double-buffered state, see wl_surface.commit.\n\n\tThe initial surface contents are void; there is no content.\n\twl_surface.attach assigns the given wl_buffer as the pending\n\twl_buffer. wl_surface.commit makes the pending wl_buffer the new\n\tsurface contents, and the size of the surface becomes the size\n\tcalculated from the wl_buffer, as described above. After commit,\n\tthere is no pending buffer until the next attach.\n\n\tCommitting a pending wl_buffer allows the compositor to read the\n\tpixels in the wl_buffer. The compositor may access the pixels at\n\tany time after the wl_surface.commit request. When the compositor\n\twill not access the pixels anymore, it will send the\n\twl_buffer.release event. Only after receiving wl_buffer.release,\n\tthe client may reuse the wl_buffer. A wl_buffer that has been\n\tattached and then replaced by another attach instead of committed\n\twill not receive a release event, and is not used by the\n\tcompositor.\n\n\tIf a pending wl_buffer has been committed to more than one wl_surface,\n\tthe delivery of wl_buffer.release events becomes undefined. A well\n\tbehaved client should not rely on wl_buffer.release events in this\n\tcase. Alternatively, a client could create multiple wl_buffer objects\n\tfrom the same backing storage or use wp_linux_buffer_release.\n\n\tDestroying the wl_buffer after wl_buffer.release does not change\n\tthe surface contents. However, if the client destroys the\n\twl_buffer before receiving the wl_buffer.release event, the surface\n\tcontents become undefined immediately.\n\n\tIf wl_surface.attach is sent with a NULL wl_buffer, the\n\tfollowing wl_surface.commit will remove the surface content."
},
"args": [
{
"name": "buffer",
"kind": "Object",
"summary": "buffer of surface contents",
"interface": "wl_buffer",
"allow_null": true,
"enumeration": null,
"description": null
},
{
"name": "x",
"kind": "Int",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Int",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "damage",
"destructor": false,
"since": 1,
"description": {
"summary": "mark part of the surface damaged",
"body": "This request is used to describe the regions where the pending\n\tbuffer is different from the current surface contents, and where\n\tthe surface therefore needs to be repainted. The compositor\n\tignores the parts of the damage that fall outside of the surface.\n\n\tDamage is double-buffered state, see wl_surface.commit.\n\n\tThe damage rectangle is specified in surface-local coordinates,\n\twhere x and y specify the upper left corner of the damage rectangle.\n\n\tThe initial value for pending damage is empty: no damage.\n\twl_surface.damage adds pending damage: the new pending damage\n\tis the union of old pending damage and the given rectangle.\n\n\twl_surface.commit assigns pending damage as the current damage,\n\tand clears pending damage. The server will clear the current\n\tdamage as it repaints the surface.\n\n\tNote! New clients should not use this request. Instead damage can be\n\tposted with wl_surface.damage_buffer which uses buffer coordinates\n\tinstead of surface coordinates."
},
"args": [
{
"name": "x",
"kind": "Int",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Int",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "width",
"kind": "Int",
"summary": "width of damage rectangle",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "height",
"kind": "Int",
"summary": "height of damage rectangle",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "frame",
"destructor": false,
"since": 1,
"description": {
"summary": "request a frame throttling hint",
"body": "Request a notification when it is a good time to start drawing a new\n\tframe, by creating a frame callback. This is useful for throttling\n\tredrawing operations, and driving animations.\n\n\tWhen a client is animating on a wl_surface, it can use the 'frame'\n\trequest to get notified when it is a good time to draw and commit the\n\tnext frame of animation. If the client commits an update earlier than\n\tthat, it is likely that some updates will not make it to the display,\n\tand the client is wasting resources by drawing too often.\n\n\tThe frame request will take effect on the next wl_surface.commit.\n\tThe notification will only be posted for one frame unless\n\trequested again. For a wl_surface, the notifications are posted in\n\tthe order the frame requests were committed.\n\n\tThe server must send the notifications so that a client\n\twill not send excessive updates, while still allowing\n\tthe highest possible update rate for clients that wait for the reply\n\tbefore drawing again. The server should give some time for the client\n\tto draw and commit after sending the frame callback events to let it\n\thit the next output refresh.\n\n\tA server should avoid signaling the frame callbacks if the\n\tsurface is not visible in any way, e.g. the surface is off-screen,\n\tor completely obscured by other opaque surfaces.\n\n\tThe object returned by this request will be destroyed by the\n\tcompositor after the callback is fired and as such the client must not\n\tattempt to use it after that point.\n\n\tThe callback_data passed in the callback is the current time, in\n\tmilliseconds, with an undefined base."
},
"args": [
{
"name": "callback",
"kind": "NewId",
"summary": "callback object for the frame request",
"interface": "wl_callback",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "set_opaque_region",
"destructor": false,
"since": 1,
"description": {
"summary": "set opaque region",
"body": "This request sets the region of the surface that contains\n\topaque content.\n\n\tThe opaque region is an optimization hint for the compositor\n\tthat lets it optimize the redrawing of content behind opaque\n\tregions. Setting an opaque region is not required for correct\n\tbehaviour, but marking transparent content as opaque will result\n\tin repaint artifacts.\n\n\tThe opaque region is specified in surface-local coordinates.\n\n\tThe compositor ignores the parts of the opaque region that fall\n\toutside of the surface.\n\n\tOpaque region is double-buffered state, see wl_surface.commit.\n\n\twl_surface.set_opaque_region changes the pending opaque region.\n\twl_surface.commit copies the pending region to the current region.\n\tOtherwise, the pending and current regions are never changed.\n\n\tThe initial value for an opaque region is empty. Setting the pending\n\topaque region has copy semantics, and the wl_region object can be\n\tdestroyed immediately. A NULL wl_region causes the pending opaque\n\tregion to be set to empty."
},
"args": [
{
"name": "region",
"kind": "Object",
"summary": "opaque region of the surface",
"interface": "wl_region",
"allow_null": true,
"enumeration": null,
"description": null
}
]
},
{
"name": "set_input_region",
"destructor": false,
"since": 1,
"description": {
"summary": "set input region",
"body": "This request sets the region of the surface that can receive\n\tpointer and touch events.\n\n\tInput events happening outside of this region will try the next\n\tsurface in the server surface stack. The compositor ignores the\n\tparts of the input region that fall outside of the surface.\n\n\tThe input region is specified in surface-local coordinates.\n\n\tInput region is double-buffered state, see wl_surface.commit.\n\n\twl_surface.set_input_region changes the pending input region.\n\twl_surface.commit copies the pending region to the current region.\n\tOtherwise the pending and current regions are never changed,\n\texcept cursor and icon surfaces are special cases, see\n\twl_pointer.set_cursor and wl_data_device.start_drag.\n\n\tThe initial value for an input region is infinite. That means the\n\twhole surface will accept input. Setting the pending input region\n\thas copy semantics, and the wl_region object can be destroyed\n\timmediately. A NULL wl_region causes the input region to be set\n\tto infinite."
},
"args": [
{
"name": "region",
"kind": "Object",
"summary": "input region of the surface",
"interface": "wl_region",
"allow_null": true,
"enumeration": null,
"description": null
}
]
},
{
"name": "commit",
"destructor": false,
"since": 1,
"description": {
"summary": "commit pending surface state",
"body": "Surface state (input, opaque, and damage regions, attached buffers,\n\tetc.) is double-buffered. Protocol requests modify the pending state,\n\tas opposed to the current state in use by the compositor. A commit\n\trequest atomically applies all pending state, replacing the current\n\tstate. After commit, the new pending state is as documented for each\n\trelated request.\n\n\tOn commit, a pending wl_buffer is applied first, and all other state\n\tsecond. This means that all coordinates in double-buffered state are\n\trelative to the new wl_buffer coming into use, except for\n\twl_surface.attach itself. If there is no pending wl_buffer, the\n\tcoordinates are relative to the current surface contents.\n\n\tAll requests that need a commit to become effective are documented\n\tto affect double-buffered state.\n\n\tOther interfaces may add further double-buffered surface state."
},
"args": []
},
{
"name": "set_buffer_transform",
"destructor": false,
"since": 2,
"description": {
"summary": "sets the buffer transformation",
"body": "This request sets an optional transformation on how the compositor\n\tinterprets the contents of the buffer attached to the surface. The\n\taccepted values for the transform parameter are the values for\n\twl_output.transform.\n\n\tBuffer transform is double-buffered state, see wl_surface.commit.\n\n\tA newly created surface has its buffer transformation set to normal.\n\n\twl_surface.set_buffer_transform changes the pending buffer\n\ttransformation. wl_surface.commit copies the pending buffer\n\ttransformation to the current one. Otherwise, the pending and current\n\tvalues are never changed.\n\n\tThe purpose of this request is to allow clients to render content\n\taccording to the output transform, thus permitting the compositor to\n\tuse certain optimizations even if the display is rotated. Using\n\thardware overlays and scanning out a client buffer for fullscreen\n\tsurfaces are examples of such optimizations. Those optimizations are\n\thighly dependent on the compositor implementation, so the use of this\n\trequest should be considered on a case-by-case basis.\n\n\tNote that if the transform value includes 90 or 270 degree rotation,\n\tthe width of the buffer will become the surface height and the height\n\tof the buffer will become the surface width.\n\n\tIf transform is not one of the values from the\n\twl_output.transform enum the invalid_transform protocol error\n\tis raised."
},
"args": [
{
"name": "transform",
"kind": "Int",
"summary": "transform for interpreting buffer contents",
"interface": null,
"allow_null": false,
"enumeration": "wl_output.transform",
"description": null
}
]
},
{
"name": "set_buffer_scale",
"destructor": false,
"since": 3,
"description": {
"summary": "sets the buffer scaling factor",
"body": "This request sets an optional scaling factor on how the compositor\n\tinterprets the contents of the buffer attached to the window.\n\n\tBuffer scale is double-buffered state, see wl_surface.commit.\n\n\tA newly created surface has its buffer scale set to 1.\n\n\twl_surface.set_buffer_scale changes the pending buffer scale.\n\twl_surface.commit copies the pending buffer scale to the current one.\n\tOtherwise, the pending and current values are never changed.\n\n\tThe purpose of this request is to allow clients to supply higher\n\tresolution buffer data for use on high resolution outputs. It is\n\tintended that you pick the same buffer scale as the scale of the\n\toutput that the surface is displayed on. This means the compositor\n\tcan avoid scaling when rendering the surface on that output.\n\n\tNote that if the scale is larger than 1, then you have to attach\n\ta buffer that is larger (by a factor of scale in each dimension)\n\tthan the desired surface size.\n\n\tIf scale is not positive the invalid_scale protocol error is\n\traised."
},
"args": [
{
"name": "scale",
"kind": "Int",
"summary": "positive scale for interpreting buffer contents",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "damage_buffer",
"destructor": false,
"since": 4,
"description": {
"summary": "mark part of the surface damaged using buffer coordinates",
"body": "This request is used to describe the regions where the pending\n\tbuffer is different from the current surface contents, and where\n\tthe surface therefore needs to be repainted. The compositor\n\tignores the parts of the damage that fall outside of the surface.\n\n\tDamage is double-buffered state, see wl_surface.commit.\n\n\tThe damage rectangle is specified in buffer coordinates,\n\twhere x and y specify the upper left corner of the damage rectangle.\n\n\tThe initial value for pending damage is empty: no damage.\n\twl_surface.damage_buffer adds pending damage: the new pending\n\tdamage is the union of old pending damage and the given rectangle.\n\n\twl_surface.commit assigns pending damage as the current damage,\n\tand clears pending damage. The server will clear the current\n\tdamage as it repaints the surface.\n\n\tThis request differs from wl_surface.damage in only one way - it\n\ttakes damage in buffer coordinates instead of surface-local\n\tcoordinates. While this generally is more intuitive than surface\n\tcoordinates, it is especially desirable when using wp_viewport\n\tor when a drawing library (like EGL) is unaware of buffer scale\n\tand buffer transform.\n\n\tNote: Because buffer transformation changes and damage requests may\n\tbe interleaved in the protocol stream, it is impossible to determine\n\tthe actual mapping between surface and buffer damage until\n\twl_surface.commit time. Therefore, compositors wishing to take both\n\tkinds of damage into account will have to accumulate damage from the\n\ttwo requests separately and only transform from one to the other\n\tafter receiving the wl_surface.commit."
},
"args": [
{
"name": "x",
"kind": "Int",
"summary": "buffer-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Int",
"summary": "buffer-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "width",
"kind": "Int",
"summary": "width of damage rectangle",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "height",
"kind": "Int",
"summary": "height of damage rectangle",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [
{
"name": "enter",
"since": 1,
"description": {
"summary": "surface enters an output",
"body": "This is emitted whenever a surface's creation, movement, or resizing\n\tresults in some part of it being within the scanout region of an\n\toutput.\n\n\tNote that a surface may be overlapping with zero or more outputs."
},
"args": [
{
"name": "output",
"kind": "Object",
"summary": "output entered by the surface",
"interface": "wl_output",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "leave",
"since": 1,
"description": {
"summary": "surface leaves an output",
"body": "This is emitted whenever a surface's creation, movement, or resizing\n\tresults in it no longer having any part of it within the scanout region\n\tof an output."
},
"args": [
{
"name": "output",
"kind": "Object",
"summary": "output left by the surface",
"interface": "wl_output",
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": {
"summary": "wl_surface error values",
"body": "These errors can be emitted in response to wl_surface requests."
},
"entries": [
{
"name": "invalid_scale",
"value": 0,
"summary": "buffer scale value is invalid",
"since": 1,
"description": null
},
{
"name": "invalid_transform",
"value": 1,
"summary": "buffer transform value is invalid",
"since": 1,
"description": null
},
{
"name": "invalid_size",
"value": 2,
"summary": "buffer size is invalid",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_seat",
"version": 7,
"description": {
"summary": "group of input devices",
"body": "A seat is a group of keyboards, pointer and touch devices. This\n object is published as a global during start up, or when such a\n device is hot plugged. A seat typically has a pointer and\n maintains a keyboard focus and a pointer focus."
},
"requests": [
{
"name": "get_pointer",
"destructor": false,
"since": 1,
"description": {
"summary": "return pointer object",
"body": "The ID provided will be initialized to the wl_pointer interface\n\tfor this seat.\n\n\tThis request only takes effect if the seat has the pointer\n\tcapability, or has had the pointer capability in the past.\n\tIt is a protocol violation to issue this request on a seat that has\n\tnever had the pointer capability."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "seat pointer",
"interface": "wl_pointer",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "get_keyboard",
"destructor": false,
"since": 1,
"description": {
"summary": "return keyboard object",
"body": "The ID provided will be initialized to the wl_keyboard interface\n\tfor this seat.\n\n\tThis request only takes effect if the seat has the keyboard\n\tcapability, or has had the keyboard capability in the past.\n\tIt is a protocol violation to issue this request on a seat that has\n\tnever had the keyboard capability."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "seat keyboard",
"interface": "wl_keyboard",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "get_touch",
"destructor": false,
"since": 1,
"description": {
"summary": "return touch object",
"body": "The ID provided will be initialized to the wl_touch interface\n\tfor this seat.\n\n\tThis request only takes effect if the seat has the touch\n\tcapability, or has had the touch capability in the past.\n\tIt is a protocol violation to issue this request on a seat that has\n\tnever had the touch capability."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "seat touch interface",
"interface": "wl_touch",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "release",
"destructor": true,
"since": 5,
"description": {
"summary": "release the seat object",
"body": "Using this request a client can tell the server that it is not going to\n\tuse the seat object anymore."
},
"args": []
}
],
"events": [
{
"name": "capabilities",
"since": 1,
"description": {
"summary": "seat capabilities changed",
"body": "This is emitted whenever a seat gains or loses the pointer,\n\tkeyboard or touch capabilities. The argument is a capability\n\tenum containing the complete set of capabilities this seat has.\n\n\tWhen the pointer capability is added, a client may create a\n\twl_pointer object using the wl_seat.get_pointer request. This object\n\twill receive pointer events until the capability is removed in the\n\tfuture.\n\n\tWhen the pointer capability is removed, a client should destroy the\n\twl_pointer objects associated with the seat where the capability was\n\tremoved, using the wl_pointer.release request. No further pointer\n\tevents will be received on these objects.\n\n\tIn some compositors, if a seat regains the pointer capability and a\n\tclient has a previously obtained wl_pointer object of version 4 or\n\tless, that object may start sending pointer events again. This\n\tbehavior is considered a misinterpretation of the intended behavior\n\tand must not be relied upon by the client. wl_pointer objects of\n\tversion 5 or later must not send events if created before the most\n\trecent event notifying the client of an added pointer capability.\n\n\tThe above behavior also applies to wl_keyboard and wl_touch with the\n\tkeyboard and touch capabilities, respectively."
},
"args": [
{
"name": "capabilities",
"kind": "Uint",
"summary": "capabilities of the seat",
"interface": null,
"allow_null": false,
"enumeration": "capability",
"description": null
}
]
},
{
"name": "name",
"since": 2,
"description": {
"summary": "unique identifier for this seat",
"body": "In a multiseat configuration this can be used by the client to help\n\tidentify which physical devices the seat represents. Based on\n\tthe seat configuration used by the compositor."
},
"args": [
{
"name": "name",
"kind": "String",
"summary": "seat identifier",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"enums": [
{
"name": "capability",
"since": 1,
"bitfield": true,
"description": {
"summary": "seat capability bitmask",
"body": "This is a bitmask of capabilities this seat has; if a member is\n\tset, then it is present on the seat."
},
"entries": [
{
"name": "pointer",
"value": 1,
"summary": "the seat has pointer devices",
"since": 1,
"description": null
},
{
"name": "keyboard",
"value": 2,
"summary": "the seat has one or more keyboards",
"since": 1,
"description": null
},
{
"name": "touch",
"value": 4,
"summary": "the seat has touch devices",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_pointer",
"version": 7,
"description": {
"summary": "pointer input device",
"body": "The wl_pointer interface represents one or more input devices,\n such as mice, which control the pointer location and pointer_focus\n of a seat.\n\n The wl_pointer interface generates motion, enter and leave\n events for the surfaces that the pointer is located over,\n and button and axis events for button presses, button releases\n and scrolling."
},
"requests": [
{
"name": "set_cursor",
"destructor": false,
"since": 1,
"description": {
"summary": "set the pointer surface",
"body": "Set the pointer surface, i.e., the surface that contains the\n\tpointer image (cursor). This request gives the surface the role\n\tof a cursor. If the surface already has another role, it raises\n\ta protocol error.\n\n\tThe cursor actually changes only if the pointer\n\tfocus for this device is one of the requesting client's surfaces\n\tor the surface parameter is the current pointer surface. If\n\tthere was a previous surface set with this request it is\n\treplaced. If surface is NULL, the pointer image is hidden.\n\n\tThe parameters hotspot_x and hotspot_y define the position of\n\tthe pointer surface relative to the pointer location. Its\n\ttop-left corner is always at (x, y) - (hotspot_x, hotspot_y),\n\twhere (x, y) are the coordinates of the pointer location, in\n\tsurface-local coordinates.\n\n\tOn surface.attach requests to the pointer surface, hotspot_x\n\tand hotspot_y are decremented by the x and y parameters\n\tpassed to the request. Attach must be confirmed by\n\twl_surface.commit as usual.\n\n\tThe hotspot can also be updated by passing the currently set\n\tpointer surface to this request with new values for hotspot_x\n\tand hotspot_y.\n\n\tThe current and pending input regions of the wl_surface are\n\tcleared, and wl_surface.set_input_region is ignored until the\n\twl_surface is no longer used as the cursor. When the use as a\n\tcursor ends, the current and pending input regions become\n\tundefined, and the wl_surface is unmapped."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the enter event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface",
"kind": "Object",
"summary": "pointer surface",
"interface": "wl_surface",
"allow_null": true,
"enumeration": null,
"description": null
},
{
"name": "hotspot_x",
"kind": "Int",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "hotspot_y",
"kind": "Int",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "release",
"destructor": true,
"since": 3,
"description": {
"summary": "release the pointer object",
"body": "Using this request a client can tell the server that it is not going to\n\tuse the pointer object anymore.\n\n\tThis request destroys the pointer proxy object, so clients must not call\n\twl_pointer_destroy() after using this request."
},
"args": []
}
],
"events": [
{
"name": "enter",
"since": 1,
"description": {
"summary": "enter event",
"body": "Notification that this seat's pointer is focused on a certain\n\tsurface.\n\n\tWhen a seat's focus enters a surface, the pointer image\n\tis undefined and a client should respond to this event by setting\n\tan appropriate pointer image with the set_cursor request."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the enter event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface",
"kind": "Object",
"summary": "surface entered by the pointer",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface_x",
"kind": "Fixed",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface_y",
"kind": "Fixed",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "leave",
"since": 1,
"description": {
"summary": "leave event",
"body": "Notification that this seat's pointer is no longer focused on\n\ta certain surface.\n\n\tThe leave notification is sent before the enter notification\n\tfor the new focus."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the leave event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface",
"kind": "Object",
"summary": "surface left by the pointer",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "motion",
"since": 1,
"description": {
"summary": "pointer motion event",
"body": "Notification of pointer location change. The arguments\n\tsurface_x and surface_y are the location relative to the\n\tfocused surface."
},
"args": [
{
"name": "time",
"kind": "Uint",
"summary": "timestamp with millisecond granularity",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface_x",
"kind": "Fixed",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface_y",
"kind": "Fixed",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "button",
"since": 1,
"description": {
"summary": "pointer button event",
"body": "Mouse button click and release notifications.\n\n\tThe location of the click is given by the last motion or\n\tenter event.\n\tThe time argument is a timestamp with millisecond\n\tgranularity, with an undefined base.\n\n\tThe button is a button code as defined in the Linux kernel's\n\tlinux/input-event-codes.h header file, e.g. BTN_LEFT.\n\n\tAny 16-bit button code value is reserved for future additions to the\n\tkernel's event code list. All other button codes above 0xFFFF are\n\tcurrently undefined but may be used in future versions of this\n\tprotocol."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the button event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "time",
"kind": "Uint",
"summary": "timestamp with millisecond granularity",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "button",
"kind": "Uint",
"summary": "button that produced the event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "state",
"kind": "Uint",
"summary": "physical state of the button",
"interface": null,
"allow_null": false,
"enumeration": "button_state",
"description": null
}
]
},
{
"name": "axis",
"since": 1,
"description": {
"summary": "axis event",
"body": "Scroll and other axis notifications.\n\n\tFor scroll events (vertical and horizontal scroll axes), the\n\tvalue parameter is the length of a vector along the specified\n\taxis in a coordinate space identical to those of motion events,\n\trepresenting a relative movement along the specified axis.\n\n\tFor devices that support movements non-parallel to axes multiple\n\taxis events will be emitted.\n\n\tWhen applicable, for example for touch pads, the server can\n\tchoose to emit scroll events where the motion vector is\n\tequivalent to a motion event vector.\n\n\tWhen applicable, a client can transform its content relative to the\n\tscroll distance."
},
"args": [
{
"name": "time",
"kind": "Uint",
"summary": "timestamp with millisecond granularity",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "axis",
"kind": "Uint",
"summary": "axis type",
"interface": null,
"allow_null": false,
"enumeration": "axis",
"description": null
},
{
"name": "value",
"kind": "Fixed",
"summary": "length of vector in surface-local coordinate space",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "frame",
"since": 5,
"description": {
"summary": "end of a pointer event sequence",
"body": "Indicates the end of a set of events that logically belong together.\n\tA client is expected to accumulate the data in all events within the\n\tframe before proceeding.\n\n\tAll wl_pointer events before a wl_pointer.frame event belong\n\tlogically together. For example, in a diagonal scroll motion the\n\tcompositor will send an optional wl_pointer.axis_source event, two\n\twl_pointer.axis events (horizontal and vertical) and finally a\n\twl_pointer.frame event. The client may use this information to\n\tcalculate a diagonal vector for scrolling.\n\n\tWhen multiple wl_pointer.axis events occur within the same frame,\n\tthe motion vector is the combined motion of all events.\n\tWhen a wl_pointer.axis and a wl_pointer.axis_stop event occur within\n\tthe same frame, this indicates that axis movement in one axis has\n\tstopped but continues in the other axis.\n\tWhen multiple wl_pointer.axis_stop events occur within the same\n\tframe, this indicates that these axes stopped in the same instance.\n\n\tA wl_pointer.frame event is sent for every logical event group,\n\teven if the group only contains a single wl_pointer event.\n\tSpecifically, a client may get a sequence: motion, frame, button,\n\tframe, axis, frame, axis_stop, frame.\n\n\tThe wl_pointer.enter and wl_pointer.leave events are logical events\n\tgenerated by the compositor and not the hardware. These events are\n\talso grouped by a wl_pointer.frame. When a pointer moves from one\n\tsurface to another, a compositor should group the\n\twl_pointer.leave event within the same wl_pointer.frame.\n\tHowever, a client must not rely on wl_pointer.leave and\n\twl_pointer.enter being in the same wl_pointer.frame.\n\tCompositor-specific policies may require the wl_pointer.leave and\n\twl_pointer.enter event being split across multiple wl_pointer.frame\n\tgroups."
},
"args": []
},
{
"name": "axis_source",
"since": 5,
"description": {
"summary": "axis source event",
"body": "Source information for scroll and other axes.\n\n\tThis event does not occur on its own. It is sent before a\n\twl_pointer.frame event and carries the source information for\n\tall events within that frame.\n\n\tThe source specifies how this event was generated. If the source is\n\twl_pointer.axis_source.finger, a wl_pointer.axis_stop event will be\n\tsent when the user lifts the finger off the device.\n\n\tIf the source is wl_pointer.axis_source.wheel,\n\twl_pointer.axis_source.wheel_tilt or\n\twl_pointer.axis_source.continuous, a wl_pointer.axis_stop event may\n\tor may not be sent. Whether a compositor sends an axis_stop event\n\tfor these sources is hardware-specific and implementation-dependent;\n\tclients must not rely on receiving an axis_stop event for these\n\tscroll sources and should treat scroll sequences from these scroll\n\tsources as unterminated by default.\n\n\tThis event is optional. If the source is unknown for a particular\n\taxis event sequence, no event is sent.\n\tOnly one wl_pointer.axis_source event is permitted per frame.\n\n\tThe order of wl_pointer.axis_discrete and wl_pointer.axis_source is\n\tnot guaranteed."
},
"args": [
{
"name": "axis_source",
"kind": "Uint",
"summary": "source of the axis event",
"interface": null,
"allow_null": false,
"enumeration": "axis_source",
"description": null
}
]
},
{
"name": "axis_stop",
"since": 5,
"description": {
"summary": "axis stop event",
"body": "Stop notification for scroll and other axes.\n\n\tFor some wl_pointer.axis_source types, a wl_pointer.axis_stop event\n\tis sent to notify a client that the axis sequence has terminated.\n\tThis enables the client to implement kinetic scrolling.\n\tSee the wl_pointer.axis_source documentation for information on when\n\tthis event may be generated.\n\n\tAny wl_pointer.axis events with the same axis_source after this\n\tevent should be considered as the start of a new axis motion.\n\n\tThe timestamp is to be interpreted identical to the timestamp in the\n\twl_pointer.axis event. The timestamp value may be the same as a\n\tpreceding wl_pointer.axis event."
},
"args": [
{
"name": "time",
"kind": "Uint",
"summary": "timestamp with millisecond granularity",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "axis",
"kind": "Uint",
"summary": "the axis stopped with this event",
"interface": null,
"allow_null": false,
"enumeration": "axis",
"description": null
}
]
},
{
"name": "axis_discrete",
"since": 5,
"description": {
"summary": "axis click event",
"body": "Discrete step information for scroll and other axes.\n\n\tThis event carries the axis value of the wl_pointer.axis event in\n\tdiscrete steps (e.g. mouse wheel clicks).\n\n\tThis event does not occur on its own, it is coupled with a\n\twl_pointer.axis event that represents this axis value on a\n\tcontinuous scale. The protocol guarantees that each axis_discrete\n\tevent is always followed by exactly one axis event with the same\n\taxis number within the same wl_pointer.frame. Note that the protocol\n\tallows for other events to occur between the axis_discrete and\n\tits coupled axis event, including other axis_discrete or axis\n\tevents.\n\n\tThis event is optional; continuous scrolling devices\n\tlike two-finger scrolling on touchpads do not have discrete\n\tsteps and do not generate this event.\n\n\tThe discrete value carries the directional information. e.g. a value\n\tof -2 is two steps towards the negative direction of this axis.\n\n\tThe axis number is identical to the axis number in the associated\n\taxis event.\n\n\tThe order of wl_pointer.axis_discrete and wl_pointer.axis_source is\n\tnot guaranteed."
},
"args": [
{
"name": "axis",
"kind": "Uint",
"summary": "axis type",
"interface": null,
"allow_null": false,
"enumeration": "axis",
"description": null
},
{
"name": "discrete",
"kind": "Int",
"summary": "number of steps",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": null,
"entries": [
{
"name": "role",
"value": 0,
"summary": "given wl_surface has another role",
"since": 1,
"description": null
}
]
},
{
"name": "button_state",
"since": 1,
"bitfield": false,
"description": {
"summary": "physical button state",
"body": "Describes the physical state of a button that produced the button\n\tevent."
},
"entries": [
{
"name": "released",
"value": 0,
"summary": "the button is not pressed",
"since": 1,
"description": null
},
{
"name": "pressed",
"value": 1,
"summary": "the button is pressed",
"since": 1,
"description": null
}
]
},
{
"name": "axis",
"since": 1,
"bitfield": false,
"description": {
"summary": "axis types",
"body": "Describes the axis types of scroll events."
},
"entries": [
{
"name": "vertical_scroll",
"value": 0,
"summary": "vertical axis",
"since": 1,
"description": null
},
{
"name": "horizontal_scroll",
"value": 1,
"summary": "horizontal axis",
"since": 1,
"description": null
}
]
},
{
"name": "axis_source",
"since": 1,
"bitfield": false,
"description": {
"summary": "axis source types",
"body": "Describes the source types for axis events. This indicates to the\n\tclient how an axis event was physically generated; a client may\n\tadjust the user interface accordingly. For example, scroll events\n\tfrom a \"finger\" source may be in a smooth coordinate space with\n\tkinetic scrolling whereas a \"wheel\" source may be in discrete steps\n\tof a number of lines.\n\n\tThe \"continuous\" axis source is a device generating events in a\n\tcontinuous coordinate space, but using something other than a\n\tfinger. One example for this source is button-based scrolling where\n\tthe vertical motion of a device is converted to scroll events while\n\ta button is held down.\n\n\tThe \"wheel tilt\" axis source indicates that the actual device is a\n\twheel but the scroll event is not caused by a rotation but a\n\t(usually sideways) tilt of the wheel."
},
"entries": [
{
"name": "wheel",
"value": 0,
"summary": "a physical wheel rotation",
"since": 1,
"description": null
},
{
"name": "finger",
"value": 1,
"summary": "finger on a touch surface",
"since": 1,
"description": null
},
{
"name": "continuous",
"value": 2,
"summary": "continuous coordinate space",
"since": 1,
"description": null
},
{
"name": "wheel_tilt",
"value": 3,
"summary": "a physical wheel tilt",
"since": 6,
"description": null
}
]
}
]
},
{
"name": "wl_keyboard",
"version": 7,
"description": {
"summary": "keyboard input device",
"body": "The wl_keyboard interface represents one or more keyboards\n associated with a seat."
},
"requests": [
{
"name": "release",
"destructor": true,
"since": 3,
"description": {
"summary": "release the keyboard object",
"body": ""
},
"args": []
}
],
"events": [
{
"name": "keymap",
"since": 1,
"description": {
"summary": "keyboard mapping",
"body": "This event provides a file descriptor to the client which can be\n\tmemory-mapped to provide a keyboard mapping description.\n\n\tFrom version 7 onwards, the fd must be mapped with MAP_PRIVATE by\n\tthe recipient, as MAP_SHARED may fail."
},
"args": [
{
"name": "format",
"kind": "Uint",
"summary": "keymap format",
"interface": null,
"allow_null": false,
"enumeration": "keymap_format",
"description": null
},
{
"name": "fd",
"kind": "Fd",
"summary": "keymap file descriptor",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "size",
"kind": "Uint",
"summary": "keymap size, in bytes",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "enter",
"since": 1,
"description": {
"summary": "enter event",
"body": "Notification that this seat's keyboard focus is on a certain\n\tsurface."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the enter event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface",
"kind": "Object",
"summary": "surface gaining keyboard focus",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "keys",
"kind": "Array",
"summary": "the currently pressed keys",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "leave",
"since": 1,
"description": {
"summary": "leave event",
"body": "Notification that this seat's keyboard focus is no longer on\n\ta certain surface.\n\n\tThe leave notification is sent before the enter notification\n\tfor the new focus."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the leave event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface",
"kind": "Object",
"summary": "surface that lost keyboard focus",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "key",
"since": 1,
"description": {
"summary": "key event",
"body": "A key was pressed or released.\n\tThe time argument is a timestamp with millisecond\n\tgranularity, with an undefined base."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the key event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "time",
"kind": "Uint",
"summary": "timestamp with millisecond granularity",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "key",
"kind": "Uint",
"summary": "key that produced the event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "state",
"kind": "Uint",
"summary": "physical state of the key",
"interface": null,
"allow_null": false,
"enumeration": "key_state",
"description": null
}
]
},
{
"name": "modifiers",
"since": 1,
"description": {
"summary": "modifier and group state",
"body": "Notifies clients that the modifier and/or group state has\n\tchanged, and it should update its local state."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the modifiers event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "mods_depressed",
"kind": "Uint",
"summary": "depressed modifiers",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "mods_latched",
"kind": "Uint",
"summary": "latched modifiers",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "mods_locked",
"kind": "Uint",
"summary": "locked modifiers",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "group",
"kind": "Uint",
"summary": "keyboard layout",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "repeat_info",
"since": 4,
"description": {
"summary": "repeat rate and delay",
"body": "Informs the client about the keyboard's repeat rate and delay.\n\n\tThis event is sent as soon as the wl_keyboard object has been created,\n\tand is guaranteed to be received by the client before any key press\n\tevent.\n\n\tNegative values for either rate or delay are illegal. A rate of zero\n\twill disable any repeating (regardless of the value of delay).\n\n\tThis event can be sent later on as well with a new value if necessary,\n\tso clients should continue listening for the event past the creation\n\tof wl_keyboard."
},
"args": [
{
"name": "rate",
"kind": "Int",
"summary": "the rate of repeating keys in characters per second",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "delay",
"kind": "Int",
"summary": "delay in milliseconds since key down until repeating starts",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"enums": [
{
"name": "keymap_format",
"since": 1,
"bitfield": false,
"description": {
"summary": "keyboard mapping format",
"body": "This specifies the format of the keymap provided to the\n\tclient with the wl_keyboard.keymap event."
},
"entries": [
{
"name": "no_keymap",
"value": 0,
"summary": "no keymap; client must understand how to interpret the raw keycode",
"since": 1,
"description": null
},
{
"name": "xkb_v1",
"value": 1,
"summary": "libxkbcommon compatible; to determine the xkb keycode, clients must add 8 to the key event keycode",
"since": 1,
"description": null
}
]
},
{
"name": "key_state",
"since": 1,
"bitfield": false,
"description": {
"summary": "physical key state",
"body": "Describes the physical state of a key that produced the key event."
},
"entries": [
{
"name": "released",
"value": 0,
"summary": "key is not pressed",
"since": 1,
"description": null
},
{
"name": "pressed",
"value": 1,
"summary": "key is pressed",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_touch",
"version": 7,
"description": {
"summary": "touchscreen input device",
"body": "The wl_touch interface represents a touchscreen\n associated with a seat.\n\n Touch interactions can consist of one or more contacts.\n For each contact, a series of events is generated, starting\n with a down event, followed by zero or more motion events,\n and ending with an up event. Events relating to the same\n contact point can be identified by the ID of the sequence."
},
"requests": [
{
"name": "release",
"destructor": true,
"since": 3,
"description": {
"summary": "release the touch object",
"body": ""
},
"args": []
}
],
"events": [
{
"name": "down",
"since": 1,
"description": {
"summary": "touch down event and beginning of a touch sequence",
"body": "A new touch point has appeared on the surface. This touch point is\n\tassigned a unique ID. Future events from this touch point reference\n\tthis ID. The ID ceases to be valid after a touch up event and may be\n\treused in the future."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the touch down event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "time",
"kind": "Uint",
"summary": "timestamp with millisecond granularity",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface",
"kind": "Object",
"summary": "surface touched",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "id",
"kind": "Int",
"summary": "the unique ID of this touch point",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "x",
"kind": "Fixed",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Fixed",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "up",
"since": 1,
"description": {
"summary": "end of a touch event sequence",
"body": "The touch point has disappeared. No further events will be sent for\n\tthis touch point and the touch point's ID is released and may be\n\treused in a future touch down event."
},
"args": [
{
"name": "serial",
"kind": "Uint",
"summary": "serial number of the touch up event",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "time",
"kind": "Uint",
"summary": "timestamp with millisecond granularity",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "id",
"kind": "Int",
"summary": "the unique ID of this touch point",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "motion",
"since": 1,
"description": {
"summary": "update of touch point coordinates",
"body": "A touch point has changed coordinates."
},
"args": [
{
"name": "time",
"kind": "Uint",
"summary": "timestamp with millisecond granularity",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "id",
"kind": "Int",
"summary": "the unique ID of this touch point",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "x",
"kind": "Fixed",
"summary": "surface-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Fixed",
"summary": "surface-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "frame",
"since": 1,
"description": {
"summary": "end of touch frame event",
"body": "Indicates the end of a set of events that logically belong together.\n\tA client is expected to accumulate the data in all events within the\n\tframe before proceeding.\n\n\tA wl_touch.frame terminates at least one event but otherwise no\n\tguarantee is provided about the set of events within a frame. A client\n\tmust assume that any state not updated in a frame is unchanged from the\n\tpreviously known state."
},
"args": []
},
{
"name": "cancel",
"since": 1,
"description": {
"summary": "touch session cancelled",
"body": "Sent if the compositor decides the touch stream is a global\n\tgesture. No further events are sent to the clients from that\n\tparticular gesture. Touch cancellation applies to all touch points\n\tcurrently active on this client's surface. The client is\n\tresponsible for finalizing the touch points, future touch points on\n\tthis surface may reuse the touch point ID."
},
"args": []
},
{
"name": "shape",
"since": 6,
"description": {
"summary": "update shape of touch point",
"body": "Sent when a touchpoint has changed its shape.\n\n\tThis event does not occur on its own. It is sent before a\n\twl_touch.frame event and carries the new shape information for\n\tany previously reported, or new touch points of that frame.\n\n\tOther events describing the touch point such as wl_touch.down,\n\twl_touch.motion or wl_touch.orientation may be sent within the\n\tsame wl_touch.frame. A client should treat these events as a single\n\tlogical touch point update. The order of wl_touch.shape,\n\twl_touch.orientation and wl_touch.motion is not guaranteed.\n\tA wl_touch.down event is guaranteed to occur before the first\n\twl_touch.shape event for this touch ID but both events may occur within\n\tthe same wl_touch.frame.\n\n\tA touchpoint shape is approximated by an ellipse through the major and\n\tminor axis length. The major axis length describes the longer diameter\n\tof the ellipse, while the minor axis length describes the shorter\n\tdiameter. Major and minor are orthogonal and both are specified in\n\tsurface-local coordinates. The center of the ellipse is always at the\n\ttouchpoint location as reported by wl_touch.down or wl_touch.move.\n\n\tThis event is only sent by the compositor if the touch device supports\n\tshape reports. The client has to make reasonable assumptions about the\n\tshape if it did not receive this event."
},
"args": [
{
"name": "id",
"kind": "Int",
"summary": "the unique ID of this touch point",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "major",
"kind": "Fixed",
"summary": "length of the major axis in surface-local coordinates",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "minor",
"kind": "Fixed",
"summary": "length of the minor axis in surface-local coordinates",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "orientation",
"since": 6,
"description": {
"summary": "update orientation of touch point",
"body": "Sent when a touchpoint has changed its orientation.\n\n\tThis event does not occur on its own. It is sent before a\n\twl_touch.frame event and carries the new shape information for\n\tany previously reported, or new touch points of that frame.\n\n\tOther events describing the touch point such as wl_touch.down,\n\twl_touch.motion or wl_touch.shape may be sent within the\n\tsame wl_touch.frame. A client should treat these events as a single\n\tlogical touch point update. The order of wl_touch.shape,\n\twl_touch.orientation and wl_touch.motion is not guaranteed.\n\tA wl_touch.down event is guaranteed to occur before the first\n\twl_touch.orientation event for this touch ID but both events may occur\n\twithin the same wl_touch.frame.\n\n\tThe orientation describes the clockwise angle of a touchpoint's major\n\taxis to the positive surface y-axis and is normalized to the -180 to\n\t+180 degree range. The granularity of orientation depends on the touch\n\tdevice, some devices only support binary rotation values between 0 and\n\t90 degrees.\n\n\tThis event is only sent by the compositor if the touch device supports\n\torientation reports."
},
"args": [
{
"name": "id",
"kind": "Int",
"summary": "the unique ID of this touch point",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "orientation",
"kind": "Fixed",
"summary": "angle between major axis and positive surface y-axis in degrees",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"enums": []
},
{
"name": "wl_output",
"version": 3,
"description": {
"summary": "compositor output region",
"body": "An output describes part of the compositor geometry. The\n compositor works in the 'compositor coordinate system' and an\n output corresponds to a rectangular area in that space that is\n actually visible. This typically corresponds to a monitor that\n displays part of the compositor space. This object is published\n as global during start up, or when a monitor is hotplugged."
},
"requests": [
{
"name": "release",
"destructor": true,
"since": 3,
"description": {
"summary": "release the output object",
"body": "Using this request a client can tell the server that it is not going to\n\tuse the output object anymore."
},
"args": []
}
],
"events": [
{
"name": "geometry",
"since": 1,
"description": {
"summary": "properties of the output",
"body": "The geometry event describes geometric properties of the output.\n\tThe event is sent when binding to the output object and whenever\n\tany of the properties change.\n\n\tThe physical size can be set to zero if it doesn't make sense for this\n\toutput (e.g. for projectors or virtual outputs).\n\n\tNote: wl_output only advertises partial information about the output\n\tposition and identification. Some compositors, for instance those not\n\timplementing a desktop-style output layout or those exposing virtual\n\toutputs, might fake this information. Instead of using x and y, clients\n\tshould use xdg_output.logical_position. Instead of using make and model,\n\tclients should use xdg_output.name and xdg_output.description."
},
"args": [
{
"name": "x",
"kind": "Int",
"summary": "x position within the global compositor space",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Int",
"summary": "y position within the global compositor space",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "physical_width",
"kind": "Int",
"summary": "width in millimeters of the output",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "physical_height",
"kind": "Int",
"summary": "height in millimeters of the output",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "subpixel",
"kind": "Int",
"summary": "subpixel orientation of the output",
"interface": null,
"allow_null": false,
"enumeration": "subpixel",
"description": null
},
{
"name": "make",
"kind": "String",
"summary": "textual description of the manufacturer",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "model",
"kind": "String",
"summary": "textual description of the model",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "transform",
"kind": "Int",
"summary": "transform that maps framebuffer to output",
"interface": null,
"allow_null": false,
"enumeration": "transform",
"description": null
}
]
},
{
"name": "mode",
"since": 1,
"description": {
"summary": "advertise available modes for the output",
"body": "The mode event describes an available mode for the output.\n\n\tThe event is sent when binding to the output object and there\n\twill always be one mode, the current mode. The event is sent\n\tagain if an output changes mode, for the mode that is now\n\tcurrent. In other words, the current mode is always the last\n\tmode that was received with the current flag set.\n\n\tThe size of a mode is given in physical hardware units of\n\tthe output device. This is not necessarily the same as\n\tthe output size in the global compositor space. For instance,\n\tthe output may be scaled, as described in wl_output.scale,\n\tor transformed, as described in wl_output.transform. Clients\n\twilling to retrieve the output size in the global compositor\n\tspace should use xdg_output.logical_size instead.\n\n\tThe vertical refresh rate can be set to zero if it doesn't make\n\tsense for this output (e.g. for virtual outputs).\n\n\tClients should not use the refresh rate to schedule frames. Instead,\n\tthey should use the wl_surface.frame event or the presentation-time\n\tprotocol.\n\n\tNote: this information is not always meaningful for all outputs. Some\n\tcompositors, such as those exposing virtual outputs, might fake the\n\trefresh rate or the size."
},
"args": [
{
"name": "flags",
"kind": "Uint",
"summary": "bitfield of mode flags",
"interface": null,
"allow_null": false,
"enumeration": "mode",
"description": null
},
{
"name": "width",
"kind": "Int",
"summary": "width of the mode in hardware units",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "height",
"kind": "Int",
"summary": "height of the mode in hardware units",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "refresh",
"kind": "Int",
"summary": "vertical refresh rate in mHz",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "done",
"since": 2,
"description": {
"summary": "sent all information about output",
"body": "This event is sent after all other properties have been\n\tsent after binding to the output object and after any\n\tother property changes done after that. This allows\n\tchanges to the output properties to be seen as\n\tatomic, even if they happen via multiple events."
},
"args": []
},
{
"name": "scale",
"since": 2,
"description": {
"summary": "output scaling properties",
"body": "This event contains scaling geometry information\n\tthat is not in the geometry event. It may be sent after\n\tbinding the output object or if the output scale changes\n\tlater. If it is not sent, the client should assume a\n\tscale of 1.\n\n\tA scale larger than 1 means that the compositor will\n\tautomatically scale surface buffers by this amount\n\twhen rendering. This is used for very high resolution\n\tdisplays where applications rendering at the native\n\tresolution would be too small to be legible.\n\n\tIt is intended that scaling aware clients track the\n\tcurrent output of a surface, and if it is on a scaled\n\toutput it should use wl_surface.set_buffer_scale with\n\tthe scale of the output. That way the compositor can\n\tavoid scaling the surface, and the client can supply\n\ta higher detail image."
},
"args": [
{
"name": "factor",
"kind": "Int",
"summary": "scaling factor of output",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"enums": [
{
"name": "subpixel",
"since": 1,
"bitfield": false,
"description": {
"summary": "subpixel geometry information",
"body": "This enumeration describes how the physical\n\tpixels on an output are laid out."
},
"entries": [
{
"name": "unknown",
"value": 0,
"summary": "unknown geometry",
"since": 1,
"description": null
},
{
"name": "none",
"value": 1,
"summary": "no geometry",
"since": 1,
"description": null
},
{
"name": "horizontal_rgb",
"value": 2,
"summary": "horizontal RGB",
"since": 1,
"description": null
},
{
"name": "horizontal_bgr",
"value": 3,
"summary": "horizontal BGR",
"since": 1,
"description": null
},
{
"name": "vertical_rgb",
"value": 4,
"summary": "vertical RGB",
"since": 1,
"description": null
},
{
"name": "vertical_bgr",
"value": 5,
"summary": "vertical BGR",
"since": 1,
"description": null
}
]
},
{
"name": "transform",
"since": 1,
"bitfield": false,
"description": {
"summary": "transform from framebuffer to output",
"body": "This describes the transform that a compositor will apply to a\n\tsurface to compensate for the rotation or mirroring of an\n\toutput device.\n\n\tThe flipped values correspond to an initial flip around a\n\tvertical axis followed by rotation.\n\n\tThe purpose is mainly to allow clients to render accordingly and\n\ttell the compositor, so that for fullscreen surfaces, the\n\tcompositor will still be able to scan out directly from client\n\tsurfaces."
},
"entries": [
{
"name": "normal",
"value": 0,
"summary": "no transform",
"since": 1,
"description": null
},
{
"name": "90",
"value": 1,
"summary": "90 degrees counter-clockwise",
"since": 1,
"description": null
},
{
"name": "180",
"value": 2,
"summary": "180 degrees counter-clockwise",
"since": 1,
"description": null
},
{
"name": "270",
"value": 3,
"summary": "270 degrees counter-clockwise",
"since": 1,
"description": null
},
{
"name": "flipped",
"value": 4,
"summary": "180 degree flip around a vertical axis",
"since": 1,
"description": null
},
{
"name": "flipped_90",
"value": 5,
"summary": "flip and rotate 90 degrees counter-clockwise",
"since": 1,
"description": null
},
{
"name": "flipped_180",
"value": 6,
"summary": "flip and rotate 180 degrees counter-clockwise",
"since": 1,
"description": null
},
{
"name": "flipped_270",
"value": 7,
"summary": "flip and rotate 270 degrees counter-clockwise",
"since": 1,
"description": null
}
]
},
{
"name": "mode",
"since": 1,
"bitfield": true,
"description": {
"summary": "mode information",
"body": "These flags describe properties of an output mode.\n\tThey are used in the flags bitfield of the mode event."
},
"entries": [
{
"name": "current",
"value": 1,
"summary": "indicates this is the current mode",
"since": 1,
"description": null
},
{
"name": "preferred",
"value": 2,
"summary": "indicates this is the preferred mode",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_region",
"version": 1,
"description": {
"summary": "region interface",
"body": "A region object describes an area.\n\n Region objects are used to describe the opaque and input\n regions of a surface."
},
"requests": [
{
"name": "destroy",
"destructor": true,
"since": 1,
"description": {
"summary": "destroy region",
"body": "Destroy the region. This will invalidate the object ID."
},
"args": []
},
{
"name": "add",
"destructor": false,
"since": 1,
"description": {
"summary": "add rectangle to region",
"body": "Add the specified rectangle to the region."
},
"args": [
{
"name": "x",
"kind": "Int",
"summary": "region-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Int",
"summary": "region-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "width",
"kind": "Int",
"summary": "rectangle width",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "height",
"kind": "Int",
"summary": "rectangle height",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "subtract",
"destructor": false,
"since": 1,
"description": {
"summary": "subtract rectangle from region",
"body": "Subtract the specified rectangle from the region."
},
"args": [
{
"name": "x",
"kind": "Int",
"summary": "region-local x coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Int",
"summary": "region-local y coordinate",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "width",
"kind": "Int",
"summary": "rectangle width",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "height",
"kind": "Int",
"summary": "rectangle height",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [],
"enums": []
},
{
"name": "wl_subcompositor",
"version": 1,
"description": {
"summary": "sub-surface compositing",
"body": "The global interface exposing sub-surface compositing capabilities.\n A wl_surface, that has sub-surfaces associated, is called the\n parent surface. Sub-surfaces can be arbitrarily nested and create\n a tree of sub-surfaces.\n\n The root surface in a tree of sub-surfaces is the main\n surface. The main surface cannot be a sub-surface, because\n sub-surfaces must always have a parent.\n\n A main surface with its sub-surfaces forms a (compound) window.\n For window management purposes, this set of wl_surface objects is\n to be considered as a single window, and it should also behave as\n such.\n\n The aim of sub-surfaces is to offload some of the compositing work\n within a window from clients to the compositor. A prime example is\n a video player with decorations and video in separate wl_surface\n objects. This should allow the compositor to pass YUV video buffer\n processing to dedicated overlay hardware when possible."
},
"requests": [
{
"name": "destroy",
"destructor": true,
"since": 1,
"description": {
"summary": "unbind from the subcompositor interface",
"body": "Informs the server that the client will not be using this\n\tprotocol object anymore. This does not affect any other\n\tobjects, wl_subsurface objects included."
},
"args": []
},
{
"name": "get_subsurface",
"destructor": false,
"since": 1,
"description": {
"summary": "give a surface the role sub-surface",
"body": "Create a sub-surface interface for the given surface, and\n\tassociate it with the given parent surface. This turns a\n\tplain wl_surface into a sub-surface.\n\n\tThe to-be sub-surface must not already have another role, and it\n\tmust not have an existing wl_subsurface object. Otherwise a protocol\n\terror is raised.\n\n\tAdding sub-surfaces to a parent is a double-buffered operation on the\n\tparent (see wl_surface.commit). The effect of adding a sub-surface\n\tbecomes visible on the next time the state of the parent surface is\n\tapplied.\n\n\tThis request modifies the behaviour of wl_surface.commit request on\n\tthe sub-surface, see the documentation on wl_subsurface interface."
},
"args": [
{
"name": "id",
"kind": "NewId",
"summary": "the new sub-surface object ID",
"interface": "wl_subsurface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "surface",
"kind": "Object",
"summary": "the surface to be turned into a sub-surface",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "parent",
"kind": "Object",
"summary": "the parent surface",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
}
]
}
],
"events": [],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": null,
"entries": [
{
"name": "bad_surface",
"value": 0,
"summary": "the to-be sub-surface is invalid",
"since": 1,
"description": null
}
]
}
]
},
{
"name": "wl_subsurface",
"version": 1,
"description": {
"summary": "sub-surface interface to a wl_surface",
"body": "An additional interface to a wl_surface object, which has been\n made a sub-surface. A sub-surface has one parent surface. A\n sub-surface's size and position are not limited to that of the parent.\n Particularly, a sub-surface is not automatically clipped to its\n parent's area.\n\n A sub-surface becomes mapped, when a non-NULL wl_buffer is applied\n and the parent surface is mapped. The order of which one happens\n first is irrelevant. A sub-surface is hidden if the parent becomes\n hidden, or if a NULL wl_buffer is applied. These rules apply\n recursively through the tree of surfaces.\n\n The behaviour of a wl_surface.commit request on a sub-surface\n depends on the sub-surface's mode. The possible modes are\n synchronized and desynchronized, see methods\n wl_subsurface.set_sync and wl_subsurface.set_desync. Synchronized\n mode caches the wl_surface state to be applied when the parent's\n state gets applied, and desynchronized mode applies the pending\n wl_surface state directly. A sub-surface is initially in the\n synchronized mode.\n\n Sub-surfaces have also other kind of state, which is managed by\n wl_subsurface requests, as opposed to wl_surface requests. This\n state includes the sub-surface position relative to the parent\n surface (wl_subsurface.set_position), and the stacking order of\n the parent and its sub-surfaces (wl_subsurface.place_above and\n .place_below). This state is applied when the parent surface's\n wl_surface state is applied, regardless of the sub-surface's mode.\n As the exception, set_sync and set_desync are effective immediately.\n\n The main surface can be thought to be always in desynchronized mode,\n since it does not have a parent in the sub-surfaces sense.\n\n Even if a sub-surface is in desynchronized mode, it will behave as\n in synchronized mode, if its parent surface behaves as in\n synchronized mode. This rule is applied recursively throughout the\n tree of surfaces. This means, that one can set a sub-surface into\n synchronized mode, and then assume that all its child and grand-child\n sub-surfaces are synchronized, too, without explicitly setting them.\n\n If the wl_surface associated with the wl_subsurface is destroyed, the\n wl_subsurface object becomes inert. Note, that destroying either object\n takes effect immediately. If you need to synchronize the removal\n of a sub-surface to the parent surface update, unmap the sub-surface\n first by attaching a NULL wl_buffer, update parent, and then destroy\n the sub-surface.\n\n If the parent wl_surface object is destroyed, the sub-surface is\n unmapped."
},
"requests": [
{
"name": "destroy",
"destructor": true,
"since": 1,
"description": {
"summary": "remove sub-surface interface",
"body": "The sub-surface interface is removed from the wl_surface object\n\tthat was turned into a sub-surface with a\n\twl_subcompositor.get_subsurface request. The wl_surface's association\n\tto the parent is deleted, and the wl_surface loses its role as\n\ta sub-surface. The wl_surface is unmapped immediately."
},
"args": []
},
{
"name": "set_position",
"destructor": false,
"since": 1,
"description": {
"summary": "reposition the sub-surface",
"body": "This schedules a sub-surface position change.\n\tThe sub-surface will be moved so that its origin (top left\n\tcorner pixel) will be at the location x, y of the parent surface\n\tcoordinate system. The coordinates are not restricted to the parent\n\tsurface area. Negative values are allowed.\n\n\tThe scheduled coordinates will take effect whenever the state of the\n\tparent surface is applied. When this happens depends on whether the\n\tparent surface is in synchronized mode or not. See\n\twl_subsurface.set_sync and wl_subsurface.set_desync for details.\n\n\tIf more than one set_position request is invoked by the client before\n\tthe commit of the parent surface, the position of a new request always\n\treplaces the scheduled position from any previous request.\n\n\tThe initial position is 0, 0."
},
"args": [
{
"name": "x",
"kind": "Int",
"summary": "x coordinate in the parent surface",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
},
{
"name": "y",
"kind": "Int",
"summary": "y coordinate in the parent surface",
"interface": null,
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "place_above",
"destructor": false,
"since": 1,
"description": {
"summary": "restack the sub-surface",
"body": "This sub-surface is taken from the stack, and put back just\n\tabove the reference surface, changing the z-order of the sub-surfaces.\n\tThe reference surface must be one of the sibling surfaces, or the\n\tparent surface. Using any other surface, including this sub-surface,\n\twill cause a protocol error.\n\n\tThe z-order is double-buffered. Requests are handled in order and\n\tapplied immediately to a pending state. The final pending state is\n\tcopied to the active state the next time the state of the parent\n\tsurface is applied. When this happens depends on whether the parent\n\tsurface is in synchronized mode or not. See wl_subsurface.set_sync and\n\twl_subsurface.set_desync for details.\n\n\tA new sub-surface is initially added as the top-most in the stack\n\tof its siblings and parent."
},
"args": [
{
"name": "sibling",
"kind": "Object",
"summary": "the reference surface",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "place_below",
"destructor": false,
"since": 1,
"description": {
"summary": "restack the sub-surface",
"body": "The sub-surface is placed just below the reference surface.\n\tSee wl_subsurface.place_above."
},
"args": [
{
"name": "sibling",
"kind": "Object",
"summary": "the reference surface",
"interface": "wl_surface",
"allow_null": false,
"enumeration": null,
"description": null
}
]
},
{
"name": "set_sync",
"destructor": false,
"since": 1,
"description": {
"summary": "set sub-surface to synchronized mode",
"body": "Change the commit behaviour of the sub-surface to synchronized\n\tmode, also described as the parent dependent mode.\n\n\tIn synchronized mode, wl_surface.commit on a sub-surface will\n\taccumulate the committed state in a cache, but the state will\n\tnot be applied and hence will not change the compositor output.\n\tThe cached state is applied to the sub-surface immediately after\n\tthe parent surface's state is applied. This ensures atomic\n\tupdates of the parent and all its synchronized sub-surfaces.\n\tApplying the cached state will invalidate the cache, so further\n\tparent surface commits do not (re-)apply old state.\n\n\tSee wl_subsurface for the recursive effect of this mode."
},
"args": []
},
{
"name": "set_desync",
"destructor": false,
"since": 1,
"description": {
"summary": "set sub-surface to desynchronized mode",
"body": "Change the commit behaviour of the sub-surface to desynchronized\n\tmode, also described as independent or freely running mode.\n\n\tIn desynchronized mode, wl_surface.commit on a sub-surface will\n\tapply the pending state directly, without caching, as happens\n\tnormally with a wl_surface. Calling wl_surface.commit on the\n\tparent surface has no effect on the sub-surface's wl_surface\n\tstate. This mode allows a sub-surface to be updated on its own.\n\n\tIf cached state exists when wl_surface.commit is called in\n\tdesynchronized mode, the pending state is added to the cached\n\tstate, and applied as a whole. This invalidates the cache.\n\n\tNote: even if a sub-surface is set to desynchronized, a parent\n\tsub-surface may override it to behave as synchronized. For details,\n\tsee wl_subsurface.\n\n\tIf a surface's parent surface behaves as desynchronized, then\n\tthe cached state is applied on set_desync."
},
"args": []
}
],
"events": [],
"enums": [
{
"name": "error",
"since": 1,
"bitfield": false,
"description": null,
"entries": [
{
"name": "bad_surface",
"value": 0,
"summary": "wl_surface is not a sibling or the parent",
"since": 1,
"description": null
}
]
}
]
}
]
}