Module `wayland`

wayland

Class wl_display

wl_display:sync ()	asynchronous roundtrip The sync request asks the server to emit the 'done' event on the returned wl_callback object.
wl_display:get_registry ()	get global registry object This request creates a registry object that allows the client to list and bind the global objects available from the compositor.
wl_display:error	fatal error event The error event is sent out when a fatal (non-recoverable) error has occurred.
wl_display:delete_id	acknowledge object ID deletion This event is used internally by the object ID management logic.
wl_display.Error	global error values

Class wl_registry

wl_registry:bind (name)

bind an object to the display

wl_registry:global

announce global object

Notify the client of global objects.

wl_registry:global_remove

announce removal of global object

Notify the client of removed global objects.

Class wl_compositor

wl_compositor:create_surface ()	create new surface
wl_compositor:create_region ()	create new region

Class wl_shm_pool

wl_shm_pool:create_buffer (offset, width, height, stride, format)

create a buffer from the pool

Create a wl_buffer object from the pool.

wl_shm_pool:destroy ()

destroy the pool

Destroy the shared memory pool.

wl_shm_pool:resize (size)

change the size of the pool mapping

This request will cause the server to remap the backing memory for the pool from the file descriptor passed when the pool was created, but using the new size.

Class wl_shm

wl_shm:create_pool (fd, size)	create a shm pool Create a new wlshmpool object.
wl_shm:format	pixel format description Informs the client about a valid pixel format that can be used for buffers.
wl_shm.Error	wl_shm error values
wl_shm.Format	pixel formats This describes the memory layout of an individual pixel.

Class wl_buffer

wl_buffer:destroy ()

destroy a buffer

Destroy a buffer.

wl_buffer:release

compositor releases buffer

Sent when this wl_buffer is no longer used by the compositor.

Class wl_data_offer

wl_data_offer:accept (serial, mime_type)	accept one of the offered mime types Indicate that the client can accept the given mime type, or NULL for not accepted.
wl_data_offer:receive (mime_type, fd)	request that the data is transferred To transfer the offered data, the client issues this request and indicates the mime type it wants to receive.
wl_data_offer:destroy ()	destroy data offer
wl_data_offer:finish ()	the offer will no longer be used Notifies the compositor that the drag destination successfully finished the drag-and-drop operation.
wl_data_offer:set_actions (dnd_actions, preferred_action)	set the available/preferred drag-and-drop actions Sets the actions that the destination side client supports for this operation.
wl_data_offer:offer	advertise offered mime type Sent immediately after creating the wldataoffer object.
wl_data_offer:source_actions	notify the source-side available actions This event indicates the actions offered by the data source.
wl_data_offer:action	notify the selected action This event indicates the action selected by the compositor after matching the source/destination side actions.
wl_data_offer.Error	error

Class wl_data_source

wl_data_source:offer (mime_type)	add an offered mime type This request adds a mime type to the set of mime types advertised to targets.
wl_data_source:destroy ()	destroy the data source
wl_data_source:set_actions (dnd_actions)	set the available drag-and-drop actions Sets the actions that the source side client supports for this operation.
wl_data_source:target	a target accepts an offered mime type Sent when a target accepts pointer_focus or motion events.
wl_data_source:send	send the data Request for data from the client.
wl_data_source:cancelled	selection was cancelled This data source is no longer valid.
wl_data_source:dnd_drop_performed	the drag-and-drop operation physically finished The user performed the drop action.
wl_data_source:dnd_finished	the drag-and-drop operation concluded The drop destination finished interoperating with this data source, so the client is now free to destroy this data source and free all associated data.
wl_data_source:action	notify the selected action This event indicates the action selected by the compositor after matching the source/destination side actions.
wl_data_source.Error	error

Class wl_data_device

wl_data_device:start_drag (source, origin, icon, serial)	start drag-and-drop operation This request asks the compositor to start a drag-and-drop operation on behalf of the client.
wl_data_device:set_selection (source, serial)	copy data to the selection This request asks the compositor to set the selection to the data from the source on behalf of the client.
wl_data_device:release ()	destroy data device
wl_data_device:data_offer	introduce a new wldataoffer The dataoffer event introduces a new wldataoffer object, which will subsequently be used in either the datadevice.enter event (for drag-and-drop) or the data_device.selection event (for selections).
wl_data_device:enter	initiate drag-and-drop session This event is sent when an active drag-and-drop pointer enters a surface owned by the client.
wl_data_device:leave	end drag-and-drop session This event is sent when the drag-and-drop pointer leaves the surface and the session ends.
wl_data_device:motion	drag-and-drop session motion This event is sent when the drag-and-drop pointer moves within the currently focused surface.
wl_data_device:drop	end drag-and-drop session successfully The event is sent when a drag-and-drop operation is ended because the implicit grab is removed.
wl_data_device:selection	advertise new selection The selection event is sent out to notify the client of a new wldataoffer for the selection for this device.
wl_data_device.Error	error

Class wl_data_device_manager

wl_data_device_manager:create_data_source ()

create a new data source

wl_data_device_manager:get_data_device (seat)

create a new data device

wl_data_device_manager.DndAction

drag and drop actions

This is a bitmask of the available/preferred actions in a drag-and-drop operation.

Class wl_shell

wl_shell:get_shell_surface (surface)

create a shell surface from a surface

Create a shell surface for an existing surface.

wl_shell.Error

error

Class wl_shell_surface

wl_shell_surface:pong (serial)	respond to a ping event
wl_shell_surface:move (seat, serial)	start an interactive move Start a pointer-driven move of the surface.
wl_shell_surface:resize (seat, serial, edges)	start an interactive resize Start a pointer-driven resizing of the surface.
wl_shell_surface:set_toplevel ()	make the surface a toplevel surface Map the surface as a toplevel surface.
wl_shell_surface:set_transient (parent, x, y, flags)	make the surface a transient surface Map the surface relative to an existing surface.
wl_shell_surface:set_fullscreen (method, framerate, output)	make the surface a fullscreen surface Map the surface as a fullscreen surface.
wl_shell_surface:set_popup (seat, serial, parent, x, y, flags)	make the surface a popup surface Map the surface as a popup.
wl_shell_surface:set_maximized (output)	make the surface a maximized surface Map the surface as a maximized surface.
wl_shell_surface:set_title (title)	set surface title Set a short title for the surface.
wl_shell_surface:set_class (class_)	set surface class Set a class for the surface.
wl_shell_surface:ping	ping client Ping a client to check if it is receiving events and sending requests.
wl_shell_surface:configure	suggest resize The configure event asks the client to resize its surface.
wl_shell_surface:popup_done	popup interaction is done
wl_shell_surface.Resize	edge values for resizing These values are used to indicate which edge of a surface is being dragged in a resize operation.
wl_shell_surface.Transient	details of transient behaviour These flags specify details of the expected behaviour of transient surfaces.
wl_shell_surface.FullscreenMethod	different method to set the surface fullscreen Hints to indicate to the compositor how to deal with a conflict between the dimensions of the surface and the dimensions of the output.

Class wl_surface

wl_surface:destroy ()	delete surface
wl_surface:attach (buffer, x, y)	set the surface contents Set a buffer as the content of this surface.
wl_surface:damage (x, y, width, height)	mark part of the surface damaged This request is used to describe the regions where the pending buffer is different from the current surface contents, and where the surface therefore needs to be repainted.
wl_surface:frame ()	request a frame throttling hint Request a notification when it is a good time to start drawing a new frame, by creating a frame callback.
wl_surface:set_opaque_region (region)	set opaque region This request sets the region of the surface that contains opaque content.
wl_surface:set_input_region (region)	set input region This request sets the region of the surface that can receive pointer and touch events.
wl_surface:commit ()	commit pending surface state Surface state (input, opaque, and damage regions, attached buffers, etc.) is double-buffered.
wl_surface:set_buffer_transform (transform)	sets the buffer transformation This request sets an optional transformation on how the compositor interprets the contents of the buffer attached to the surface.
wl_surface:set_buffer_scale (scale)	sets the buffer scaling factor This request sets an optional scaling factor on how the compositor interprets the contents of the buffer attached to the window.
wl_surface:damage_buffer (x, y, width, height)	mark part of the surface damaged using buffer coordinates This request is used to describe the regions where the pending buffer is different from the current surface contents, and where the surface therefore needs to be repainted.
wl_surface:offset (x, y)	set the surface contents offset The x and y arguments specify the location of the new pending buffer's upper left corner, relative to the current buffer's upper left corner, in surface-local coordinates.
wl_surface:enter	surface enters an output This is emitted whenever a surface's creation, movement, or resizing results in some part of it being within the scanout region of an output.
wl_surface:leave	surface leaves an output This is emitted whenever a surface's creation, movement, or resizing results in it no longer having any part of it within the scanout region of an output.
wl_surface:preferred_buffer_scale	preferred buffer scale for the surface This event indicates the preferred buffer scale for this surface.
wl_surface:preferred_buffer_transform	preferred buffer transform for the surface This event indicates the preferred buffer transform for this surface.
wl_surface.Error	wl_surface error values

Class wl_seat

wl_seat:get_pointer ()	return pointer object The ID provided will be initialized to the wl_pointer interface for this seat.
wl_seat:get_keyboard ()	return keyboard object The ID provided will be initialized to the wl_keyboard interface for this seat.
wl_seat:get_touch ()	return touch object The ID provided will be initialized to the wl_touch interface for this seat.
wl_seat:release ()	release the seat object
wl_seat:capabilities	seat capabilities changed This is emitted whenever a seat gains or loses the pointer, keyboard or touch capabilities.
wl_seat:name	unique identifier for this seat In a multi-seat configuration the seat name can be used by clients to help identify which physical devices the seat represents.
wl_seat.Capability	seat capability bitmask
wl_seat.Error	wl_seat error values

Class wl_pointer

wl_pointer:set_cursor (serial, surface, hotspot_x, hotspot_y)	set the pointer surface Set the pointer surface, i.e., the surface that contains the pointer image (cursor).
wl_pointer:release ()	release the pointer object Using this request a client can tell the server that it is not going to use the pointer object anymore.
wl_pointer:enter	enter event Notification that this seat's pointer is focused on a certain surface.
wl_pointer:leave	leave event Notification that this seat's pointer is no longer focused on a certain surface.
wl_pointer:motion	pointer motion event Notification of pointer location change.
wl_pointer:button	pointer button event Mouse button click and release notifications.
wl_pointer:axis	axis event Scroll and other axis notifications.
wl_pointer:frame	end of a pointer event sequence Indicates the end of a set of events that logically belong together.
wl_pointer:axis_source	axis source event Source information for scroll and other axes.
wl_pointer:axis_stop	axis stop event Stop notification for scroll and other axes.
wl_pointer:axis_discrete	axis click event Discrete step information for scroll and other axes.
wl_pointer:axis_value120	axis high-resolution scroll event Discrete high-resolution scroll information.
wl_pointer:axis_relative_direction	axis relative physical direction event Relative directional information of the entity causing the axis motion.
wl_pointer.Error	error
wl_pointer.ButtonState	physical button state
wl_pointer.Axis	axis types
wl_pointer.AxisSource	axis source types Describes the source types for axis events.
wl_pointer.AxisRelativeDirection	axis relative direction

Class wl_keyboard

wl_keyboard:release ()	release the keyboard object
wl_keyboard:keymap	keyboard mapping This event provides a file descriptor to the client which can be memory-mapped in read-only mode to provide a keyboard mapping description.
wl_keyboard:enter	enter event Notification that this seat's keyboard focus is on a certain surface.
wl_keyboard:leave	leave event Notification that this seat's keyboard focus is no longer on a certain surface.
wl_keyboard:key	key event A key was pressed or released.
wl_keyboard:modifiers	modifier and group state Notifies clients that the modifier and/or group state has changed, and it should update its local state.
wl_keyboard:repeat_info	repeat rate and delay Informs the client about the keyboard's repeat rate and delay.
wl_keyboard.KeymapFormat	keyboard mapping format
wl_keyboard.KeyState	physical key state

Class wl_touch

wl_touch:release ()	release the touch object
wl_touch:down	touch down event and beginning of a touch sequence A new touch point has appeared on the surface.
wl_touch:up	end of a touch event sequence The touch point has disappeared.
wl_touch:motion	update of touch point coordinates
wl_touch:frame	end of touch frame event Indicates the end of a set of events that logically belong together.
wl_touch:cancel	touch session cancelled Sent if the compositor decides the touch stream is a global gesture.
wl_touch:shape	update shape of touch point Sent when a touchpoint has changed its shape.
wl_touch:orientation	update orientation of touch point Sent when a touchpoint has changed its orientation.

Class wl_output

wl_output:release ()	release the output object
wl_output:geometry	properties of the output The geometry event describes geometric properties of the output.
wl_output:mode	advertise available modes for the output The mode event describes an available mode for the output.
wl_output:done	sent all information about output This event is sent after all other properties have been sent after binding to the output object and after any other property changes done after that.
wl_output:scale	output scaling properties This event contains scaling geometry information that is not in the geometry event.
wl_output:name	name of this output Many compositors will assign user-friendly names to their outputs, show them to the user, allow the user to refer to an output, etc.
wl_output:description	human-readable description of this output Many compositors can produce human-readable descriptions of their outputs.
wl_output.Subpixel	subpixel geometry information
wl_output.Transform	transform from framebuffer to output This describes the transform that a compositor will apply to a surface to compensate for the rotation or mirroring of an output device.
wl_output.Mode	mode information These flags describe properties of an output mode.

Class wl_region

wl_region:destroy ()

destroy region

Destroy the region.

wl_region:add (x, y, width, height)

add rectangle to region

wl_region:subtract (x, y, width, height)

subtract rectangle from region

Class wl_subcompositor

wl_subcompositor:destroy ()

unbind from the subcompositor interface

Informs the server that the client will not be using this protocol object anymore.

wl_subcompositor:get_subsurface (surface, parent)

give a surface the role sub-surface

Create a sub-surface interface for the given surface, and associate it with the given parent surface.

wl_subcompositor.Error

error

Class wl_subsurface

wl_subsurface:destroy ()	remove sub-surface interface The sub-surface interface is removed from the wlsurface object that was turned into a sub-surface with a wlsubcompositor.get_subsurface request.
wl_subsurface:set_position (x, y)	reposition the sub-surface This schedules a sub-surface position change.
wl_subsurface:place_above (sibling)	restack the sub-surface This sub-surface is taken from the stack, and put back just above the reference surface, changing the z-order of the sub-surfaces.
wl_subsurface:place_below (sibling)	restack the sub-surface The sub-surface is placed just below the reference surface.
wl_subsurface:set_sync ()	set sub-surface to synchronized mode Change the commit behaviour of the sub-surface to synchronized mode, also described as the parent dependent mode.
wl_subsurface:set_desync ()	set sub-surface to desynchronized mode Change the commit behaviour of the sub-surface to desynchronized mode, also described as independent or freely running mode.
wl_subsurface.Error	error

Class wl_display

core global object

The core global object. This is a special singleton object. It is used for internal Wayland protocol features.

wl_display:sync ()

asynchronous roundtrip

The sync request asks the server to emit the 'done' event on the returned wlcallback object. Since requests are handled in-order and events are delivered in-order, this can be used as a barrier to ensure all previous requests and the resulting events have been handled. The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point. The callbackdata passed in the callback is the event serial.

Returns:

wl_callback

wl_display:get_registry ()

get global registry object

This request creates a registry object that allows the client to list and bind the global objects available from the compositor. It should be noted that the server side resources consumed in response to a getregistry request can only be released when the client disconnects, not when the client side proxy is destroyed. Therefore, clients should invoke getregistry as infrequently as possible to avoid wasting memory.

Returns:

wl_registry

wl_display:error

fatal error event

The error event is sent out when a fatal (non-recoverable) error has occurred. The object_id argument is the object where the error occurred, most often in response to a request to that object. The code identifies the error and is defined by the object interface. As such, each interface defines its own set of error codes. The message is a brief description of the error, for (debugging) convenience.

Parameters:

object_id object object where the error occurred
code uint error code
message string error description

wl_display:delete_id

acknowledge object ID deletion

This event is used internally by the object ID management logic. When a client deletes an object that it had created, the server will send this event to acknowledge that it has seen the delete request. When the client receives this event, it will know that it can safely reuse the object ID.

Parameters:

id uint deleted object ID

wl_display.Error

global error values These errors are global and can be emitted in response to any server request.

INVALID_OBJECT 0 server couldn't find object
INVALID_METHOD 1 method doesn't exist on the specified interface or malformed request
NO_MEMORY 2 server is out of memory
IMPLEMENTATION 3 implementation error in compositor

Class wl_registry

global registry object

The singleton global registry object. The server has a number of global objects that are available to all clients. These objects typically represent an actual object in the server (for example, an input device) or they are singleton objects that provide extension functionality. When a client creates a registry object, the registry object will emit a global event for each global currently in the registry. Globals come and go as a result of device or monitor hotplugs, reconfiguration or other events, and the registry will send out global and globalremove events to keep the client up to date with the changes. To mark the end of the initial burst of events, the client can use the wldisplay.sync request immediately after calling wldisplay.getregistry. A client can bind to a global object by using the bind request. This creates a client-side handle that lets the object emit events to the client and lets the client invoke requests on the object.

wl_registry:bind (name)

bind an object to the display Binds a new, client-created object to the server using the specified name as the identifier.

Parameters:

name uint unique numeric name of the object

Returns:

object

wl_registry:global

announce global object

Notify the client of global objects. The event notifies the client that a global object with the given name is now available, and it implements the given version of the given interface.

Parameters:

name uint numeric name of the global object
interface string interface implemented by the object
version uint interface version

wl_registry:global_remove

announce removal of global object

Notify the client of removed global objects. This event notifies the client that the global identified by name is no longer available. If the client bound to the global using the bind request, the client should now destroy that object. The object remains valid and requests to the object will be ignored until the client destroys it, to avoid races between the global going away and a client sending a request to it.

Parameters:

name uint numeric name of the global object

Class wl_callback

callback object

Clients can handle the 'done' event to get notified when the related request is done. Note, because wlcallback objects are created from multiple independent factory interfaces, the wlcallback interface is frozen at version 1.

wl_callback:done

done event Notify the client when the related request is done.

Parameters:

callback_data uint request-specific data for the callback

Class wl_compositor

the compositor singleton

A compositor. This object is a singleton global. The compositor is in charge of combining the contents of multiple surfaces into one displayable output.

wl_compositor:create_surface ()

create new surface Ask the compositor to create a new surface.

Returns:

wl_surface

wl_compositor:create_region ()

create new region Ask the compositor to create a new region.

Returns:

wl_region

Class wl_shm_pool

a shared memory pool

The wlshmpool object encapsulates a piece of memory shared between the compositor and client. Through the wlshmpool object, the client can allocate shared memory wl_buffer objects. All objects created through the same pool share the same underlying mapped memory. Reusing the mapped memory avoids the setup/teardown overhead and is useful when interactively resizing a surface or for many small buffers.

wl_shm_pool:create_buffer (offset, width, height, stride, format)

create a buffer from the pool

Create a wlbuffer object from the pool. The buffer is created offset bytes into the pool and has width and height as specified. The stride argument specifies the number of bytes from the beginning of one row to the beginning of the next. The format is the pixel format of the buffer and must be one of those advertised through the wlshm.format event. A buffer will keep a reference to the pool it was created from so it is valid to destroy the pool immediately after creating a buffer from it.

Parameters:

offset int buffer byte offset within the pool
width int buffer width, in pixels
height int buffer height, in pixels
stride int number of bytes from the beginning of one row to the beginning of the next row
format uint buffer pixel format

Returns:

wl_buffer

wl_shm_pool:destroy ()

destroy the pool

Destroy the shared memory pool. The mmapped memory will be released when all buffers that have been created from this pool are gone.

Returns:

wl_shm_pool

wl_shm_pool:resize (size)

change the size of the pool mapping

This request will cause the server to remap the backing memory for the pool from the file descriptor passed when the pool was created, but using the new size. This request can only be used to make the pool bigger. This request only changes the amount of bytes that are mmapped by the server and does not touch the file corresponding to the file descriptor passed at creation time. It is the client's responsibility to ensure that the file is at least as big as the new pool size.

Parameters:

size int new size of the pool, in bytes

Returns:

wl_shm_pool

Class wl_shm

shared memory support

A singleton global object that provides support for shared memory. Clients can create wlshmpool objects using the createpool request. On binding the wlshm object one or more format events are emitted to inform clients about the valid pixel formats that can be used for buffers.

wl_shm:create_pool (fd, size)

create a shm pool

Create a new wlshmpool object. The pool can be used to create shared memory based buffer objects. The server will mmap size bytes of the passed file descriptor, to use as backing memory for the pool.

Parameters:

fd fd file descriptor for the pool
size int pool size, in bytes

Returns:

wl_shm_pool

wl_shm:format

pixel format description

Informs the client about a valid pixel format that can be used for buffers. Known formats include argb8888 and xrgb8888.

Parameters:

format uint buffer pixel format

wl_shm.Error

wlshm error values These errors can be emitted in response to wlshm requests.

INVALID_FORMAT 0 buffer format is not known
INVALID_STRIDE 1 invalid size or stride during pool or buffer creation
INVALID_FD 2 mmapping the file descriptor failed

wl_shm.Format

pixel formats

This describes the memory layout of an individual pixel. All renderers should support argb8888 and xrgb8888 but any other formats are optional and may not be supported by the particular renderer in use. The drm format codes match the macros defined in drmfourcc.h, except argb8888 and xrgb8888. The formats actually supported by the compositor will be reported by the format event. For all wlshm formats and unless specified in another protocol extension, pre-multiplied alpha is used for pixel values.

ARGB8888 0 32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian
XRGB8888 1 32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian
C8 0x20203843 8-bit color index format, [7:0] C
RGB332 0x38424752 8-bit RGB format, [7:0] R:G:B 3:3:2
BGR233 0x38524742 8-bit BGR format, [7:0] B:G:R 2:3:3
XRGB4444 0x32315258 16-bit xRGB format, [15:0] x:R:G:B 4:4:4:4 little endian
XBGR4444 0x32314258 16-bit xBGR format, [15:0] x:B:G:R 4:4:4:4 little endian
RGBX4444 0x32315852 16-bit RGBx format, [15:0] R:G:B:x 4:4:4:4 little endian
BGRX4444 0x32315842 16-bit BGRx format, [15:0] B:G:R:x 4:4:4:4 little endian
ARGB4444 0x32315241 16-bit ARGB format, [15:0] A:R:G:B 4:4:4:4 little endian
ABGR4444 0x32314241 16-bit ABGR format, [15:0] A:B:G:R 4:4:4:4 little endian
RGBA4444 0x32314152 16-bit RBGA format, [15:0] R:G:B:A 4:4:4:4 little endian
BGRA4444 0x32314142 16-bit BGRA format, [15:0] B:G:R:A 4:4:4:4 little endian
XRGB1555 0x35315258 16-bit xRGB format, [15:0] x:R:G:B 1:5:5:5 little endian
XBGR1555 0x35314258 16-bit xBGR 1555 format, [15:0] x:B:G:R 1:5:5:5 little endian
RGBX5551 0x35315852 16-bit RGBx 5551 format, [15:0] R:G:B:x 5:5:5:1 little endian
BGRX5551 0x35315842 16-bit BGRx 5551 format, [15:0] B:G:R:x 5:5:5:1 little endian
ARGB1555 0x35315241 16-bit ARGB 1555 format, [15:0] A:R:G:B 1:5:5:5 little endian
ABGR1555 0x35314241 16-bit ABGR 1555 format, [15:0] A:B:G:R 1:5:5:5 little endian
RGBA5551 0x35314152 16-bit RGBA 5551 format, [15:0] R:G:B:A 5:5:5:1 little endian
BGRA5551 0x35314142 16-bit BGRA 5551 format, [15:0] B:G:R:A 5:5:5:1 little endian
RGB565 0x36314752 16-bit RGB 565 format, [15:0] R:G:B 5:6:5 little endian
BGR565 0x36314742 16-bit BGR 565 format, [15:0] B:G:R 5:6:5 little endian
RGB888 0x34324752 24-bit RGB format, [23:0] R:G:B little endian
BGR888 0x34324742 24-bit BGR format, [23:0] B:G:R little endian
XBGR8888 0x34324258 32-bit xBGR format, [31:0] x:B:G:R 8:8:8:8 little endian
RGBX8888 0x34325852 32-bit RGBx format, [31:0] R:G:B:x 8:8:8:8 little endian
BGRX8888 0x34325842 32-bit BGRx format, [31:0] B:G:R:x 8:8:8:8 little endian
ABGR8888 0x34324241 32-bit ABGR format, [31:0] A:B:G:R 8:8:8:8 little endian
RGBA8888 0x34324152 32-bit RGBA format, [31:0] R:G:B:A 8:8:8:8 little endian
BGRA8888 0x34324142 32-bit BGRA format, [31:0] B:G:R:A 8:8:8:8 little endian
XRGB2101010 0x30335258 32-bit xRGB format, [31:0] x:R:G:B 2:10:10:10 little endian
XBGR2101010 0x30334258 32-bit xBGR format, [31:0] x:B:G:R 2:10:10:10 little endian
RGBX1010102 0x30335852 32-bit RGBx format, [31:0] R:G:B:x 10:10:10:2 little endian
BGRX1010102 0x30335842 32-bit BGRx format, [31:0] B:G:R:x 10:10:10:2 little endian
ARGB2101010 0x30335241 32-bit ARGB format, [31:0] A:R:G:B 2:10:10:10 little endian
ABGR2101010 0x30334241 32-bit ABGR format, [31:0] A:B:G:R 2:10:10:10 little endian
RGBA1010102 0x30334152 32-bit RGBA format, [31:0] R:G:B:A 10:10:10:2 little endian
BGRA1010102 0x30334142 32-bit BGRA format, [31:0] B:G:R:A 10:10:10:2 little endian
YUYV 0x56595559 packed YCbCr format, [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian
YVYU 0x55595659 packed YCbCr format, [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian
UYVY 0x59565955 packed YCbCr format, [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian
VYUY 0x59555956 packed YCbCr format, [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian
AYUV 0x56555941 packed AYCbCr format, [31:0] A:Y:Cb:Cr 8:8:8:8 little endian
NV12 0x3231564e 2 plane YCbCr Cr:Cb format, 2x2 subsampled Cr:Cb plane
NV21 0x3132564e 2 plane YCbCr Cb:Cr format, 2x2 subsampled Cb:Cr plane
NV16 0x3631564e 2 plane YCbCr Cr:Cb format, 2x1 subsampled Cr:Cb plane
NV61 0x3136564e 2 plane YCbCr Cb:Cr format, 2x1 subsampled Cb:Cr plane
YUV410 0x39565559 3 plane YCbCr format, 4x4 subsampled Cb (1) and Cr (2) planes
YVU410 0x39555659 3 plane YCbCr format, 4x4 subsampled Cr (1) and Cb (2) planes
YUV411 0x31315559 3 plane YCbCr format, 4x1 subsampled Cb (1) and Cr (2) planes
YVU411 0x31315659 3 plane YCbCr format, 4x1 subsampled Cr (1) and Cb (2) planes
YUV420 0x32315559 3 plane YCbCr format, 2x2 subsampled Cb (1) and Cr (2) planes
YVU420 0x32315659 3 plane YCbCr format, 2x2 subsampled Cr (1) and Cb (2) planes
YUV422 0x36315559 3 plane YCbCr format, 2x1 subsampled Cb (1) and Cr (2) planes
YVU422 0x36315659 3 plane YCbCr format, 2x1 subsampled Cr (1) and Cb (2) planes
YUV444 0x34325559 3 plane YCbCr format, non-subsampled Cb (1) and Cr (2) planes
YVU444 0x34325659 3 plane YCbCr format, non-subsampled Cr (1) and Cb (2) planes
R8 0x20203852 [7:0] R
R16 0x20363152 [15:0] R little endian
RG88 0x38384752 [15:0] R:G 8:8 little endian
GR88 0x38385247 [15:0] G:R 8:8 little endian
RG1616 0x32334752 [31:0] R:G 16:16 little endian
GR1616 0x32335247 [31:0] G:R 16:16 little endian
XRGB16161616F 0x48345258 [63:0] x:R:G:B 16:16:16:16 little endian
XBGR16161616F 0x48344258 [63:0] x:B:G:R 16:16:16:16 little endian
ARGB16161616F 0x48345241 [63:0] A:R:G:B 16:16:16:16 little endian
ABGR16161616F 0x48344241 [63:0] A:B:G:R 16:16:16:16 little endian
XYUV8888 0x56555958 [31:0] X:Y:Cb:Cr 8:8:8:8 little endian
VUY888 0x34325556 [23:0] Cr:Cb:Y 8:8:8 little endian
VUY101010 0x30335556 Y followed by U then V, 10:10:10. Non-linear modifier only
Y210 0x30313259 [63:0] Cr0:0:Y1:0:Cb0:0:Y0:0 10:6:10:6:10:6:10:6 little endian per 2 Y pixels
Y212 0x32313259 [63:0] Cr0:0:Y1:0:Cb0:0:Y0:0 12:4:12:4:12:4:12:4 little endian per 2 Y pixels
Y216 0x36313259 [63:0] Cr0:Y1:Cb0:Y0 16:16:16:16 little endian per 2 Y pixels
Y410 0x30313459 [31:0] A:Cr:Y:Cb 2:10:10:10 little endian
Y412 0x32313459 [63:0] A:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian
Y416 0x36313459 [63:0] A:Cr:Y:Cb 16:16:16:16 little endian
XVYU2101010 0x30335658 [31:0] X:Cr:Y:Cb 2:10:10:10 little endian
XVYU12_16161616 0x36335658 [63:0] X:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian
XVYU16161616 0x38345658 [63:0] X:Cr:Y:Cb 16:16:16:16 little endian
Y0L0 0x304c3059 [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
X0L0 0x304c3058 [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
Y0L2 0x324c3059 [63:0] A3:A2:Y3:Cr0:Y2:A1:A0:Y1:Cb0:Y0 1:1:10:10:10:1:1:10:10:10 little endian
X0L2 0x324c3058 [63:0] X3:X2:Y3:Cr0:Y2:X1:X0:Y1:Cb0:Y0 1:1:10:10:10:1:1:10:10:10 little endian
YUV420_8BIT 0x38305559
YUV420_10BIT 0x30315559
XRGB8888_A8 0x38415258
XBGR8888_A8 0x38414258
RGBX8888_A8 0x38415852
BGRX8888_A8 0x38415842
RGB888_A8 0x38413852
BGR888_A8 0x38413842
RGB565_A8 0x38413552
BGR565_A8 0x38413542
NV24 0x3432564e non-subsampled Cr:Cb plane
NV42 0x3234564e non-subsampled Cb:Cr plane
P210 0x30313250 2x1 subsampled Cr:Cb plane, 10 bit per channel
P010 0x30313050 2x2 subsampled Cr:Cb plane 10 bits per channel
P012 0x32313050 2x2 subsampled Cr:Cb plane 12 bits per channel
P016 0x36313050 2x2 subsampled Cr:Cb plane 16 bits per channel
AXBXGXRX106106106106 0x30314241 [63:0] A:x:B:x:G:x:R:x 10:6:10:6:10:6:10:6 little endian
NV15 0x3531564e 2x2 subsampled Cr:Cb plane
Q410 0x30313451
Q401 0x31303451
XRGB16161616 0x38345258 [63:0] x:R:G:B 16:16:16:16 little endian
XBGR16161616 0x38344258 [63:0] x:B:G:R 16:16:16:16 little endian
ARGB16161616 0x38345241 [63:0] A:R:G:B 16:16:16:16 little endian
ABGR16161616 0x38344241 [63:0] A:B:G:R 16:16:16:16 little endian
C1 0x20203143 [7:0] C0:C1:C2:C3:C4:C5:C6:C7 1:1:1:1:1:1:1:1 eight pixels/byte
C2 0x20203243 [7:0] C0:C1:C2:C3 2:2:2:2 four pixels/byte
C4 0x20203443 [7:0] C0:C1 4:4 two pixels/byte
D1 0x20203144 [7:0] D0:D1:D2:D3:D4:D5:D6:D7 1:1:1:1:1:1:1:1 eight pixels/byte
D2 0x20203244 [7:0] D0:D1:D2:D3 2:2:2:2 four pixels/byte
D4 0x20203444 [7:0] D0:D1 4:4 two pixels/byte
D8 0x20203844 [7:0] D
R1 0x20203152 [7:0] R0:R1:R2:R3:R4:R5:R6:R7 1:1:1:1:1:1:1:1 eight pixels/byte
R2 0x20203252 [7:0] R0:R1:R2:R3 2:2:2:2 four pixels/byte
R4 0x20203452 [7:0] R0:R1 4:4 two pixels/byte
R10 0x20303152 [15:0] x:R 6:10 little endian
R12 0x20323152 [15:0] x:R 4:12 little endian
AVUY8888 0x59555641 [31:0] A:Cr:Cb:Y 8:8:8:8 little endian
XVUY8888 0x59555658 [31:0] X:Cr:Cb:Y 8:8:8:8 little endian
P030 0x30333050 2x2 subsampled Cr:Cb plane 10 bits per channel packed

Class wl_buffer

content for a wl_surface

A buffer provides the content for a wlsurface. Buffers are created through factory interfaces such as wlshm, wplinuxbufferparams (from the linux-dmabuf protocol extension) or similar. It has a width and a height and can be attached to a wlsurface, but the mechanism by which a client provides and updates the contents is defined by the buffer factory interface. If the buffer uses a format that has an alpha channel, the alpha channel is assumed to be premultiplied in the color channels unless otherwise specified. Note, because wlbuffer objects are created from multiple independent factory interfaces, the wlbuffer interface is frozen at version 1.

wl_buffer:destroy ()

destroy a buffer

Destroy a buffer. If and how you need to release the backing storage is defined by the buffer factory interface. For possible side-effects to a surface, see wl_surface.attach.

Returns:

wl_buffer

wl_buffer:release

compositor releases buffer

Sent when this wlbuffer is no longer used by the compositor. The client is now free to reuse or destroy this buffer and its backing storage. If a client receives a release event before the frame callback requested in the same wlsurface.commit that attaches this wlbuffer to a surface, then the client is immediately free to reuse the buffer and its backing storage, and does not need a second buffer for the next surface content update. Typically this is possible, when the compositor maintains a copy of the wlsurface contents, e.g. as a GL texture. This is an important optimization for GL(ES) compositors with wl_shm clients.

Class wl_data_offer

offer to transfer data

A wldataoffer represents a piece of data offered for transfer by another client (the source client). It is used by the copy-and-paste and drag-and-drop mechanisms. The offer describes the different mime types that the data can be converted to and provides the mechanism for transferring the data directly from the source client.

wl_data_offer:accept (serial, mime_type)

accept one of the offered mime types

Indicate that the client can accept the given mime type, or NULL for not accepted. For objects of version 2 or older, this request is used by the client to give feedback whether the client can receive the given mime type, or NULL if none is accepted; the feedback does not determine whether the drag-and-drop operation succeeds or not. For objects of version 3 or newer, this request determines the final result of the drag-and-drop operation. If the end result is that no mime types were accepted, the drag-and-drop operation will be cancelled and the corresponding drag source will receive wldatasource.cancelled. Clients may still use this event in conjunction with wldatasource.action for feedback.

Parameters:

serial uint serial number of the accept request
mime_type string mime type accepted by the client

Returns:

wl_data_offer

wl_data_offer:receive (mime_type, fd)

request that the data is transferred

To transfer the offered data, the client issues this request and indicates the mime type it wants to receive. The transfer happens through the passed file descriptor (typically created with the pipe system call). The source client writes the data in the mime type representation requested and then closes the file descriptor. The receiving client reads from the read end of the pipe until EOF and then closes its end, at which point the transfer is complete. This request may happen multiple times for different mime types, both before and after wldatadevice.drop. Drag-and-drop destination clients may preemptively fetch data or examine it more closely to determine acceptance.

Parameters:

mime_type string mime type desired by receiver
fd fd file descriptor for data transfer

Returns:

wl_data_offer

wl_data_offer:destroy ()

destroy data offer Destroy the data offer.

Returns:

wl_data_offer

wl_data_offer:finish ()

the offer will no longer be used

Notifies the compositor that the drag destination successfully finished the drag-and-drop operation. Upon receiving this request, the compositor will emit wldatasource.dndfinished on the drag source client. It is a client error to perform other requests than wldataoffer.destroy after this one. It is also an error to perform this request after a NULL mime type has been set in wldataoffer.accept or no action was received through wldataoffer.action. If wldataoffer.finish request is received for a non drag and drop operation, the invalidfinish protocol error is raised.

Returns:

wl_data_offer

wl_data_offer:set_actions (dnd_actions, preferred_action)

set the available/preferred drag-and-drop actions

Sets the actions that the destination side client supports for this operation. This request may trigger the emission of wldatasource.action and wldataoffer.action events if the compositor needs to change the selected action. This request can be called multiple times throughout the drag-and-drop operation, typically in response to wldatadevice.enter or wldatadevice.motion events. This request determines the final result of the drag-and-drop operation. If the end result is that no action is accepted, the drag source will receive wldatasource.cancelled. The dndactions argument must contain only values expressed in the wldatadevicemanager.dndactions enum, and the preferredaction argument must only contain one of those values set, otherwise it will result in a protocol error. While managing an "ask" action, the destination drag-and-drop client may perform further wldataoffer.receive requests, and is expected to perform one last wldataoffer.setactions request with a preferred action other than "ask" (and optionally wldataoffer.accept) before requesting wldataoffer.finish, in order to convey the action selected by the user. If the preferred action is not in the wldataoffer.sourceactions mask, an error will be raised. If the "ask" action is dismissed (e.g. user cancellation), the client is expected to perform wldataoffer.destroy right away. This request can only be made on drag-and-drop offers, a protocol error will be raised otherwise.

Parameters:

dnd_actions uint actions supported by the destination client
preferred_action uint action preferred by the destination client

Returns:

wl_data_offer

wl_data_offer:offer

advertise offered mime type

Sent immediately after creating the wldataoffer object. One event per offered mime type.

Parameters:

mime_type string offered mime type

wl_data_offer:source_actions

notify the source-side available actions

This event indicates the actions offered by the data source. It will be sent immediately after creating the wldataoffer object, or anytime the source side changes its offered actions through wldatasource.set_actions.

Parameters:

source_actions uint actions offered by the data source

wl_data_offer:action

notify the selected action

This event indicates the action selected by the compositor after matching the source/destination side actions. Only one action (or none) will be offered here. This event can be emitted multiple times during the drag-and-drop operation in response to destination side action changes through wldataoffer.setactions. This event will no longer be emitted after wldatadevice.drop happened on the drag-and-drop destination, the client must honor the last action received, or the last preferred one set through wldataoffer.setactions when handling an "ask" action. Compositors may also change the selected action on the fly, mainly in response to keyboard modifier changes during the drag-and-drop operation. The most recent action received is always the valid one. Prior to receiving wldatadevice.drop, the chosen action may change (e.g. due to keyboard modifiers being pressed). At the time of receiving wldatadevice.drop the drag-and-drop destination must honor the last action received. Action changes may still happen after wldatadevice.drop, especially on "ask" actions, where the drag-and-drop destination may choose another action afterwards. Action changes happening at this stage are always the result of inter-client negotiation, the compositor shall no longer be able to induce a different action. Upon "ask" actions, it is expected that the drag-and-drop destination may potentially choose a different action and/or mime type, based on wldataoffer.sourceactions and finally chosen by the user (e.g. popping up a menu with the available options). The final wldataoffer.setactions and wldataoffer.accept requests must happen before the call to wldataoffer.finish.

Parameters:

dnd_action uint action selected by the compositor

wl_data_offer.Error

error

INVALID_FINISH 0 finish request was called untimely
INVALID_ACTION_MASK 1 action mask contains invalid values
INVALID_ACTION 2 action argument has an invalid value
INVALID_OFFER 3 offer doesn't accept this request

Class wl_data_source

offer to transfer data

The wldatasource object is the source side of a wldataoffer. It is created by the source client in a data transfer and provides a way to describe the offered data and a way to respond to requests to transfer the data.

wl_data_source:offer (mime_type)

add an offered mime type

This request adds a mime type to the set of mime types advertised to targets. Can be called several times to offer multiple types.

Parameters:

mime_type string mime type offered by the data source

Returns:

wl_data_source

wl_data_source:destroy ()

destroy the data source Destroy the data source.

Returns:

wl_data_source

wl_data_source:set_actions (dnd_actions)

set the available drag-and-drop actions

Sets the actions that the source side client supports for this operation. This request may trigger wldatasource.action and wldataoffer.action events if the compositor needs to change the selected action. The dndactions argument must contain only values expressed in the wldatadevicemanager.dndactions enum, otherwise it will result in a protocol error. This request must be made once only, and can only be made on sources used in drag-and-drop, so it must be performed before wldatadevice.startdrag. Attempting to use the source other than for drag-and-drop will raise a protocol error.

Parameters:

dnd_actions uint actions supported by the data source

Returns:

wl_data_source

wl_data_source:target

a target accepts an offered mime type

Sent when a target accepts pointer_focus or motion events. If a target does not accept any of the offered types, type is NULL. Used for feedback during drag-and-drop.

Parameters:

mime_type string mime type accepted by the target

wl_data_source:send

send the data

Request for data from the client. Send the data as the specified mime type over the passed file descriptor, then close it.

Parameters:

mime_type string mime type for the data
fd fd file descriptor for the data

wl_data_source:cancelled

selection was cancelled

This data source is no longer valid. There are several reasons why this could happen: - The data source has been replaced by another data source. - The drag-and-drop operation was performed, but the drop destination did not accept any of the mime types offered through wldatasource.target. - The drag-and-drop operation was performed, but the drop destination did not select any of the actions present in the mask offered through wldatasource.action. - The drag-and-drop operation was performed but didn't happen over a surface. - The compositor cancelled the drag-and-drop operation (e.g. compositor dependent timeouts to avoid stale drag-and-drop transfers). The client should clean up and destroy this data source. For objects of version 2 or older, wldatasource.cancelled will only be emitted if the data source was replaced by another data source.

wl_data_source:dnd_drop_performed

the drag-and-drop operation physically finished

The user performed the drop action. This event does not indicate acceptance, wldatasource.cancelled may still be emitted afterwards if the drop destination does not accept any mime type. However, this event might however not be received if the compositor cancelled the drag-and-drop operation before this event could happen. Note that the data_source may still be used in the future and should not be destroyed here.

wl_data_source:dnd_finished

the drag-and-drop operation concluded

The drop destination finished interoperating with this data source, so the client is now free to destroy this data source and free all associated data. If the action used to perform the operation was "move", the source can now delete the transferred data.

wl_data_source:action

notify the selected action

Parameters:

dnd_action uint action selected by the compositor

wl_data_source.Error

error

INVALID_ACTION_MASK 0 action mask contains invalid values
INVALID_SOURCE 1 source doesn't accept this request

Class wl_data_device

data transfer device

There is one wldatadevice per seat which can be obtained from the global wldatadevicemanager singleton. A wldata_device provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop.

wl_data_device:start_drag (source, origin, icon, serial)

start drag-and-drop operation

This request asks the compositor to start a drag-and-drop operation on behalf of the client. The source argument is the data source that provides the data for the eventual data transfer. If source is NULL, enter, leave and motion events are sent only to the client that initiated the drag and the client is expected to handle the data passing internally. If source is destroyed, the drag-and-drop session will be cancelled. The origin surface is the surface where the drag originates and the client must have an active implicit grab that matches the serial. The icon surface is an optional (can be NULL) surface that provides an icon to be moved around with the cursor. Initially, the top-left corner of the icon surface is placed at the cursor hotspot, but subsequent wlsurface.attach request can move the relative position. Attach requests must be confirmed with wlsurface.commit as usual. The icon surface is given the role of a drag-and-drop icon. If the icon surface already has another role, it raises a protocol error. The input region is ignored for wlsurfaces with the role of a drag-and-drop icon. The given source may not be used in any further setselection or startdrag requests. Attempting to reuse a previously-used source may send a usedsource error.

Parameters:

source wl_data_source data source for the eventual transfer
origin wl_surface surface where the drag originates
icon wl_surface drag-and-drop icon surface
serial uint serial number of the implicit grab on the origin

Returns:

wl_data_device

wl_data_device:set_selection (source, serial)

copy data to the selection

This request asks the compositor to set the selection to the data from the source on behalf of the client. To unset the selection, set the source to NULL. The given source may not be used in any further setselection or startdrag requests. Attempting to reuse a previously-used source may send a used_source error.

Parameters:

source wl_data_source data source for the selection
serial uint serial number of the event that triggered this request

Returns:

wl_data_device

wl_data_device:release ()

destroy data device This request destroys the data device.

Returns:

wl_data_device

wl_data_device:data_offer

introduce a new wldataoffer

The dataoffer event introduces a new wldataoffer object, which will subsequently be used in either the datadevice.enter event (for drag-and-drop) or the datadevice.selection event (for selections). Immediately following the datadevice.dataoffer event, the new dataoffer object will send out data_offer.offer events to describe the mime types it offers.

Parameters:

id wl_data_offer the new data_offer object

wl_data_device:enter

initiate drag-and-drop session

This event is sent when an active drag-and-drop pointer enters a surface owned by the client. The position of the pointer at enter time is provided by the x and y arguments, in surface-local coordinates.

Parameters:

serial uint serial number of the enter event
surface wl_surface client surface entered
x fixed surface-local x coordinate
y fixed surface-local y coordinate
id wl_data_offer source data_offer object

wl_data_device:leave

end drag-and-drop session

This event is sent when the drag-and-drop pointer leaves the surface and the session ends. The client must destroy the wldataoffer introduced at enter time at this point.

wl_data_device:motion

drag-and-drop session motion

This event is sent when the drag-and-drop pointer moves within the currently focused surface. The new position of the pointer is provided by the x and y arguments, in surface-local coordinates.

Parameters:

time uint timestamp with millisecond granularity
x fixed surface-local x coordinate
y fixed surface-local y coordinate

wl_data_device:drop

end drag-and-drop session successfully

The event is sent when a drag-and-drop operation is ended because the implicit grab is removed. The drag-and-drop destination is expected to honor the last action received through wldataoffer.action, if the resulting action is "copy" or "move", the destination can still perform wldataoffer.receive requests, and is expected to end all transfers with a wldataoffer.finish request. If the resulting action is "ask", the action will not be considered final. The drag-and-drop destination is expected to perform one last wldataoffer.setactions request, or wldata_offer.destroy in order to cancel the operation.

wl_data_device:selection

advertise new selection

The selection event is sent out to notify the client of a new wldataoffer for the selection for this device. The datadevice.dataoffer and the dataoffer.offer events are sent out immediately before this event to introduce the data offer object. The selection event is sent to a client immediately before receiving keyboard focus and when a new selection is set while the client has keyboard focus. The dataoffer is valid until a new dataoffer or NULL is received or until the client loses keyboard focus. Switching surface with keyboard focus within the same client doesn't mean a new selection will be sent. The client must destroy the previous selection dataoffer, if any, upon receiving this event.

Parameters:

id wl_data_offer selection data_offer object

wl_data_device.Error

error

ROLE 0 given wl_surface has another role
USED_SOURCE 1 source has already been used

Class wl_data_device_manager

data transfer interface

The wldatadevicemanager is a singleton global object that provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop. These mechanisms are tied to a wlseat and this interface lets a client get a wldatadevice corresponding to a wlseat. Depending on the version bound, the objects created from the bound wldatadevicemanager object will have different requirements for functioning properly. See wldatasource.setactions, wldataoffer.accept and wldata_offer.finish for details.

wl_data_device_manager:create_data_source ()

create a new data source Create a new data source.

Returns:

wl_data_source

wl_data_device_manager:get_data_device (seat)

create a new data device Create a new data device for a given seat.

Parameters:

seat wl_seat seat associated with the data device

Returns:

wl_data_device

wl_data_device_manager.DndAction

drag and drop actions

This is a bitmask of the available/preferred actions in a drag-and-drop operation. In the compositor, the selected action is a result of matching the actions offered by the source and destination sides. "action" events with a "none" action will be sent to both source and destination if there is no match. All further checks will effectively happen on (source actions ∩ destination actions). In addition, compositors may also pick different actions in reaction to key modifiers being pressed. One common design that is used in major toolkits (and the behavior recommended for compositors) is: - If no modifiers are pressed, the first match (in bit order) will be used. - Pressing Shift selects "move", if enabled in the mask. - Pressing Control selects "copy", if enabled in the mask. Behavior beyond that is considered implementation-dependent. Compositors may for example bind other modifiers (like Alt/Meta) or drags initiated with other buttons than BTN_LEFT to specific actions (e.g. "ask").

NONE 0 no action
COPY 1 copy action
MOVE 2 move action
ASK 4 ask action

Class wl_shell

create desktop-style surfaces

This interface is implemented by servers that provide desktop-style user interfaces. It allows clients to associate a wlshellsurface with a basic surface. Note! This protocol is deprecated and not intended for production use. For desktop-style user interfaces, use xdg_shell. Compositors and clients should not implement this interface.

wl_shell:get_shell_surface (surface)

create a shell surface from a surface

Create a shell surface for an existing surface. This gives the wlsurface the role of a shell surface. If the wlsurface already has another role, it raises a protocol error. Only one shell surface can be associated with a given surface.

Parameters:

surface wl_surface surface to be given the shell surface role

Returns:

wl_shell_surface

wl_shell.Error

error

ROLE 0 given wl_surface has another role

Class wl_shell_surface

desktop-style metadata interface

An interface that may be implemented by a wlsurface, for implementations that provide a desktop-style user interface. It provides requests to treat surfaces like toplevel, fullscreen or popup windows, move, resize or maximize them, associate metadata like title and class, etc. On the server side the object is automatically destroyed when the related wlsurface is destroyed. On the client side, wlshellsurfacedestroy() must be called before destroying the wlsurface object.

wl_shell_surface:pong (serial)

respond to a ping event A client must respond to a ping event with a pong request or the client may be deemed unresponsive.

Parameters:

serial uint serial number of the ping event

Returns:

wl_shell_surface

wl_shell_surface:move (seat, serial)

start an interactive move

Start a pointer-driven move of the surface. This request must be used in response to a button press event. The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized).

Parameters:

seat wl_seat seat whose pointer is used
serial uint serial number of the implicit grab on the pointer

Returns:

wl_shell_surface

wl_shell_surface:resize (seat, serial, edges)

start an interactive resize

Start a pointer-driven resizing of the surface. This request must be used in response to a button press event. The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized).

Parameters:

seat wl_seat seat whose pointer is used
serial uint serial number of the implicit grab on the pointer
edges uint which edge or corner is being dragged

Returns:

wl_shell_surface

wl_shell_surface:set_toplevel ()

make the surface a toplevel surface

Map the surface as a toplevel surface. A toplevel surface is not fullscreen, maximized or transient.

Returns:

wl_shell_surface

wl_shell_surface:set_transient (parent, x, y, flags)

make the surface a transient surface

Map the surface relative to an existing surface. The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates. The flags argument controls details of the transient behaviour.

Parameters:

parent wl_surface parent surface
x int surface-local x coordinate
y int surface-local y coordinate
flags uint transient surface behavior

Returns:

wl_shell_surface

wl_shell_surface:set_fullscreen (method, framerate, output)

make the surface a fullscreen surface

Map the surface as a fullscreen surface. If an output parameter is given then the surface will be made fullscreen on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area. The client may specify a method to resolve a size conflict between the output size and the surface size - this is provided through the method parameter. The framerate parameter is used only when the method is set to "driver", to indicate the preferred framerate. A value of 0 indicates that the client does not care about framerate. The framerate is specified in mHz, that is framerate of 60000 is 60Hz. A method of "scale" or "driver" implies a scaling operation of the surface, either via a direct scaling operation or a change of the output mode. This will override any kind of output scaling, so that mapping a surface with a buffer size equal to the mode can fill the screen independent of bufferscale. A method of "fill" means we don't scale up the buffer, however any output scale is applied. This means that you may run into an edge case where the application maps a buffer with the same size of the output mode but bufferscale 1 (thus making a surface larger than the output). In this case it is allowed to downscale the results to fit the screen. The compositor must reply to this request with a configure event with the dimensions for the output on which the surface will be made fullscreen.

Parameters:

method uint method for resolving size conflict
framerate uint framerate in mHz
output wl_output output on which the surface is to be fullscreen

Returns:

wl_shell_surface

wl_shell_surface:set_popup (seat, serial, parent, x, y, flags)

make the surface a popup surface

Map the surface as a popup. A popup surface is a transient surface with an added pointer grab. An existing implicit grab will be changed to owner-events mode, and the popup grab will continue after the implicit grab ends (i.e. releasing the mouse button does not cause the popup to be unmapped). The popup grab continues until the window is destroyed or a mouse button is pressed in any other client's window. A click in any of the client's surfaces is reported as normal, however, clicks in other clients' surfaces will be discarded and trigger the callback. The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates.

Parameters:

seat wl_seat seat whose pointer is used
serial uint serial number of the implicit grab on the pointer
parent wl_surface parent surface
x int surface-local x coordinate
y int surface-local y coordinate
flags uint transient surface behavior

Returns:

wl_shell_surface

wl_shell_surface:set_maximized (output)

make the surface a maximized surface

Map the surface as a maximized surface. If an output parameter is given then the surface will be maximized on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area. The compositor will reply with a configure event telling the expected new surface size. The operation is completed on the next buffer attach to this surface. A maximized surface typically fills the entire output it is bound to, except for desktop elements such as panels. This is the main difference between a maximized shell surface and a fullscreen shell surface. The details depend on the compositor implementation.

Parameters:

output wl_output output on which the surface is to be maximized

Returns:

wl_shell_surface

wl_shell_surface:set_title (title)

set surface title

Set a short title for the surface. This string may be used to identify the surface in a task bar, window list, or other user interface elements provided by the compositor. The string must be encoded in UTF-8.

Parameters:

title string surface title

Returns:

wl_shell_surface

wl_shell_surface:set_class (class_)

set surface class

Set a class for the surface. The surface class identifies the general class of applications to which the surface belongs. A common convention is to use the file name (or the full path if it is a non-standard location) of the application's .desktop file as the class.

Parameters:

class_ string surface class

Returns:

wl_shell_surface

wl_shell_surface:ping

ping client

Ping a client to check if it is receiving events and sending requests. A client is expected to reply with a pong request.

Parameters:

serial uint serial number of the ping

wl_shell_surface:configure

suggest resize

The configure event asks the client to resize its surface. The size is a hint, in the sense that the client is free to ignore it if it doesn't resize, pick a smaller size (to satisfy aspect ratio or resize in steps of NxM pixels). The edges parameter provides a hint about how the surface was resized. The client may use this information to decide how to adjust its content to the new size (e.g. a scrolling area might adjust its content position to leave the viewable content unmoved). The client is free to dismiss all but the last configure event it received. The width and height arguments specify the size of the window in surface-local coordinates.

Parameters:

edges uint how the surface was resized
width int new width of the surface
height int new height of the surface

wl_shell_surface:popup_done

popup interaction is done The popup_done event is sent out when a popup grab is broken, that is, when the user clicks a surface that doesn't belong to the client owning the popup surface.

wl_shell_surface.Resize

edge values for resizing

These values are used to indicate which edge of a surface is being dragged in a resize operation. The server may use this information to adapt its behavior, e.g. choose an appropriate cursor image.

NONE 0 no edge
TOP 1 top edge
BOTTOM 2 bottom edge
LEFT 4 left edge
TOP_LEFT 5 top and left edges
BOTTOM_LEFT 6 bottom and left edges
RIGHT 8 right edge
TOP_RIGHT 9 top and right edges
BOTTOM_RIGHT 10 bottom and right edges

wl_shell_surface.Transient

details of transient behaviour

These flags specify details of the expected behaviour of transient surfaces. Used in the set_transient request.

INACTIVE 0x1 do not set keyboard focus

wl_shell_surface.FullscreenMethod

different method to set the surface fullscreen

Hints to indicate to the compositor how to deal with a conflict between the dimensions of the surface and the dimensions of the output. The compositor is free to ignore this parameter.

DEFAULT 0 no preference, apply default policy
SCALE 1 scale, preserve the surface's aspect ratio and center on output
DRIVER 2 switch output mode to the smallest mode that can fit the surface, add black borders to compensate size mismatch
FILL 3 no upscaling, center on output and add black borders to compensate size mismatch

Class wl_surface

an onscreen surface

A surface is a rectangular area that may be displayed on zero or more outputs, and shown any number of times at the compositor's discretion. They can present wlbuffers, receive user input, and define a local coordinate system. The size of a surface (and relative positions on it) is described in surface-local coordinates, which may differ from the buffer coordinates of the pixel content, in case a buffertransform or a bufferscale is used. A surface without a "role" is fairly useless: a compositor does not know where, when or how to present it. The role is the purpose of a wlsurface. Examples of roles are a cursor for a pointer (as set by wlpointer.setcursor), a drag icon (wldatadevice.startdrag), a sub-surface (wlsubcompositor.getsubsurface), and a window as defined by a shell protocol (e.g. wlshell.getshellsurface). A surface can have only one role at a time. Initially a wlsurface does not have a role. Once a wlsurface is given a role, it is set permanently for the whole lifetime of the wlsurface object. Giving the current role again is allowed, unless explicitly forbidden by the relevant interface specification. Surface roles are given by requests in other interfaces such as wlpointer.setcursor. The request should explicitly mention that this request gives a role to a wlsurface. Often, this request also creates a new protocol object that represents the role and adds additional functionality to wlsurface. When a client wants to destroy a wlsurface, they must destroy this role object before the wlsurface, otherwise a defunctroleobject error is sent. Destroying the role object does not remove the role from the wlsurface, but it may stop the wlsurface from "playing the role". For instance, if a wlsubsurface object is destroyed, the wlsurface it was created for will be unmapped and forget its position and z-order. It is allowed to create a wlsubsurface for the same wlsurface again, but it is not allowed to use the wlsurface as a cursor (cursor is a different role than sub-surface, and role switching is not allowed).

wl_surface:destroy ()

delete surface Deletes the surface and invalidates its object ID.

Returns:

wl_surface

wl_surface:attach (buffer, x, y)

set the surface contents

Set a buffer as the content of this surface. The new size of the surface is calculated based on the buffer size transformed by the inverse buffertransform and the inverse bufferscale. This means that at commit time the supplied buffer size must be an integer multiple of the bufferscale. If that's not the case, an invalidsize error is sent. The x and y arguments specify the location of the new pending buffer's upper left corner, relative to the current buffer's upper left corner, in surface-local coordinates. In other words, the x and y, combined with the new surface size define in which directions the surface's size changes. Setting anything other than 0 as x and y arguments is discouraged, and should instead be replaced with using the separate wlsurface.offset request. When the bound wlsurface version is 5 or higher, passing any non-zero x or y is a protocol violation, and will result in an 'invalidoffset' error being raised. The x and y arguments are ignored and do not change the pending state. To achieve equivalent semantics, use wlsurface.offset. Surface contents are double-buffered state, see wlsurface.commit. The initial surface contents are void; there is no content. wlsurface.attach assigns the given wlbuffer as the pending wlbuffer. wlsurface.commit makes the pending wlbuffer the new surface contents, and the size of the surface becomes the size calculated from the wlbuffer, as described above. After commit, there is no pending buffer until the next attach. Committing a pending wlbuffer allows the compositor to read the pixels in the wlbuffer. The compositor may access the pixels at any time after the wlsurface.commit request. When the compositor will not access the pixels anymore, it will send the wlbuffer.release event. Only after receiving wlbuffer.release, the client may reuse the wlbuffer. A wlbuffer that has been attached and then replaced by another attach instead of committed will not receive a release event, and is not used by the compositor. If a pending wlbuffer has been committed to more than one wlsurface, the delivery of wlbuffer.release events becomes undefined. A well behaved client should not rely on wlbuffer.release events in this case. Alternatively, a client could create multiple wlbuffer objects from the same backing storage or use wplinuxbufferrelease. Destroying the wlbuffer after wlbuffer.release does not change the surface contents. Destroying the wlbuffer before wlbuffer.release is allowed as long as the underlying buffer storage isn't re-used (this can happen e.g. on client process termination). However, if the client destroys the wlbuffer before receiving the wlbuffer.release event and mutates the underlying buffer storage, the surface contents become undefined immediately. If wlsurface.attach is sent with a NULL wlbuffer, the following wl_surface.commit will remove the surface content.

Parameters:

buffer wl_buffer buffer of surface contents
x int surface-local x coordinate
y int surface-local y coordinate

Returns:

wl_surface

wl_surface:damage (x, y, width, height)

mark part of the surface damaged

Parameters:

x int surface-local x coordinate
y int surface-local y coordinate
width int width of damage rectangle
height int height of damage rectangle

Returns:

wl_surface

wl_surface:frame ()

request a frame throttling hint

Request a notification when it is a good time to start drawing a new frame, by creating a frame callback. This is useful for throttling redrawing operations, and driving animations. When a client is animating on a wlsurface, it can use the 'frame' request to get notified when it is a good time to draw and commit the next frame of animation. If the client commits an update earlier than that, it is likely that some updates will not make it to the display, and the client is wasting resources by drawing too often. The frame request will take effect on the next wlsurface.commit. The notification will only be posted for one frame unless requested again. For a wlsurface, the notifications are posted in the order the frame requests were committed. The server must send the notifications so that a client will not send excessive updates, while still allowing the highest possible update rate for clients that wait for the reply before drawing again. The server should give some time for the client to draw and commit after sending the frame callback events to let it hit the next output refresh. A server should avoid signaling the frame callbacks if the surface is not visible in any way, e.g. the surface is off-screen, or completely obscured by other opaque surfaces. The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point. The callbackdata passed in the callback is the current time, in milliseconds, with an undefined base.

Returns:

wl_callback

wl_surface:set_opaque_region (region)

set opaque region

This request sets the region of the surface that contains opaque content. The opaque region is an optimization hint for the compositor that lets it optimize the redrawing of content behind opaque regions. Setting an opaque region is not required for correct behaviour, but marking transparent content as opaque will result in repaint artifacts. The opaque region is specified in surface-local coordinates. The compositor ignores the parts of the opaque region that fall outside of the surface. Opaque region is double-buffered state, see wlsurface.commit. wlsurface.setopaqueregion changes the pending opaque region. wlsurface.commit copies the pending region to the current region. Otherwise, the pending and current regions are never changed. The initial value for an opaque region is empty. Setting the pending opaque region has copy semantics, and the wlregion object can be destroyed immediately. A NULL wl_region causes the pending opaque region to be set to empty.

Parameters:

region wl_region opaque region of the surface

Returns:

wl_surface

wl_surface:set_input_region (region)

set input region

This request sets the region of the surface that can receive pointer and touch events. Input events happening outside of this region will try the next surface in the server surface stack. The compositor ignores the parts of the input region that fall outside of the surface. The input region is specified in surface-local coordinates. Input region is double-buffered state, see wlsurface.commit. wlsurface.setinputregion changes the pending input region. wlsurface.commit copies the pending region to the current region. Otherwise the pending and current regions are never changed, except cursor and icon surfaces are special cases, see wlpointer.setcursor and wldatadevice.startdrag. The initial value for an input region is infinite. That means the whole surface will accept input. Setting the pending input region has copy semantics, and the wlregion object can be destroyed immediately. A NULL wlregion causes the input region to be set to infinite.

Parameters:

region wl_region input region of the surface

Returns:

wl_surface

wl_surface:commit ()

commit pending surface state

Surface state (input, opaque, and damage regions, attached buffers, etc.) is double-buffered. Protocol requests modify the pending state, as opposed to the current state in use by the compositor. A commit request atomically applies all pending state, replacing the current state. After commit, the new pending state is as documented for each related request. On commit, a pending wlbuffer is applied first, and all other state second. This means that all coordinates in double-buffered state are relative to the new wlbuffer coming into use, except for wlsurface.attach itself. If there is no pending wlbuffer, the coordinates are relative to the current surface contents. All requests that need a commit to become effective are documented to affect double-buffered state. Other interfaces may add further double-buffered surface state.

Returns:

wl_surface

wl_surface:set_buffer_transform (transform)

sets the buffer transformation

This request sets an optional transformation on how the compositor interprets the contents of the buffer attached to the surface. The accepted values for the transform parameter are the values for wloutput.transform. Buffer transform is double-buffered state, see wlsurface.commit. A newly created surface has its buffer transformation set to normal. wlsurface.setbuffertransform changes the pending buffer transformation. wlsurface.commit copies the pending buffer transformation to the current one. Otherwise, the pending and current values are never changed. The purpose of this request is to allow clients to render content according to the output transform, thus permitting the compositor to use certain optimizations even if the display is rotated. Using hardware overlays and scanning out a client buffer for fullscreen surfaces are examples of such optimizations. Those optimizations are highly dependent on the compositor implementation, so the use of this request should be considered on a case-by-case basis. Note that if the transform value includes 90 or 270 degree rotation, the width of the buffer will become the surface height and the height of the buffer will become the surface width. If transform is not one of the values from the wloutput.transform enum the invalidtransform protocol error is raised.

Parameters:

transform int transform for interpreting buffer contents

Returns:

wl_surface

wl_surface:set_buffer_scale (scale)

sets the buffer scaling factor

This request sets an optional scaling factor on how the compositor interprets the contents of the buffer attached to the window. Buffer scale is double-buffered state, see wlsurface.commit. A newly created surface has its buffer scale set to 1. wlsurface.setbufferscale changes the pending buffer scale. wlsurface.commit copies the pending buffer scale to the current one. Otherwise, the pending and current values are never changed. The purpose of this request is to allow clients to supply higher resolution buffer data for use on high resolution outputs. It is intended that you pick the same buffer scale as the scale of the output that the surface is displayed on. This means the compositor can avoid scaling when rendering the surface on that output. Note that if the scale is larger than 1, then you have to attach a buffer that is larger (by a factor of scale in each dimension) than the desired surface size. If scale is not positive the invalidscale protocol error is raised.

Parameters:

scale int positive scale for interpreting buffer contents

Returns:

wl_surface

wl_surface:damage_buffer (x, y, width, height)

mark part of the surface damaged using buffer coordinates

This request is used to describe the regions where the pending buffer is different from the current surface contents, and where the surface therefore needs to be repainted. The compositor ignores the parts of the damage that fall outside of the surface. Damage is double-buffered state, see wlsurface.commit. The damage rectangle is specified in buffer coordinates, where x and y specify the upper left corner of the damage rectangle. The initial value for pending damage is empty: no damage. wlsurface.damagebuffer adds pending damage: the new pending damage is the union of old pending damage and the given rectangle. wlsurface.commit assigns pending damage as the current damage, and clears pending damage. The server will clear the current damage as it repaints the surface. This request differs from wlsurface.damage in only one way - it takes damage in buffer coordinates instead of surface-local coordinates. While this generally is more intuitive than surface coordinates, it is especially desirable when using wpviewport or when a drawing library (like EGL) is unaware of buffer scale and buffer transform. Note: Because buffer transformation changes and damage requests may be interleaved in the protocol stream, it is impossible to determine the actual mapping between surface and buffer damage until wlsurface.commit time. Therefore, compositors wishing to take both kinds of damage into account will have to accumulate damage from the two requests separately and only transform from one to the other after receiving the wlsurface.commit.

Parameters:

x int buffer-local x coordinate
y int buffer-local y coordinate
width int width of damage rectangle
height int height of damage rectangle

Returns:

wl_surface

wl_surface:offset (x, y)

set the surface contents offset

The x and y arguments specify the location of the new pending buffer's upper left corner, relative to the current buffer's upper left corner, in surface-local coordinates. In other words, the x and y, combined with the new surface size define in which directions the surface's size changes. Surface location offset is double-buffered state, see wlsurface.commit. This request is semantically equivalent to and the replaces the x and y arguments in the wlsurface.attach request in wlsurface versions prior to 5. See wlsurface.attach for details.

Parameters:

x int surface-local x coordinate
y int surface-local y coordinate

Returns:

wl_surface

wl_surface:enter

surface enters an output

This is emitted whenever a surface's creation, movement, or resizing results in some part of it being within the scanout region of an output. Note that a surface may be overlapping with zero or more outputs.

Parameters:

output wl_output output entered by the surface

wl_surface:leave

surface leaves an output

This is emitted whenever a surface's creation, movement, or resizing results in it no longer having any part of it within the scanout region of an output. Clients should not use the number of outputs the surface is on for frame throttling purposes. The surface might be hidden even if no leave event has been sent, and the compositor might expect new surface content updates even if no enter event has been sent. The frame event should be used instead.

Parameters:

output wl_output output left by the surface

wl_surface:preferred_buffer_scale

preferred buffer scale for the surface

This event indicates the preferred buffer scale for this surface. It is sent whenever the compositor's preference changes. It is intended that scaling aware clients use this event to scale their content and use wlsurface.setbuffer_scale to indicate the scale they have rendered with. This allows clients to supply a higher detail buffer.

Parameters:

factor int preferred scaling factor

wl_surface:preferred_buffer_transform

preferred buffer transform for the surface

This event indicates the preferred buffer transform for this surface. It is sent whenever the compositor's preference changes. It is intended that transform aware clients use this event to apply the transform to their content and use wlsurface.setbuffer_transform to indicate the transform they have rendered with.

Parameters:

transform uint preferred transform

wl_surface.Error

wlsurface error values These errors can be emitted in response to wlsurface requests.

INVALID_SCALE 0 buffer scale value is invalid
INVALID_TRANSFORM 1 buffer transform value is invalid
INVALID_SIZE 2 buffer size is invalid
INVALID_OFFSET 3 buffer offset is invalid
DEFUNCT_ROLE_OBJECT 4 surface was destroyed before its role object

Class wl_seat

group of input devices

A seat is a group of keyboards, pointer and touch devices. This object is published as a global during start up, or when such a device is hot plugged. A seat typically has a pointer and maintains a keyboard focus and a pointer focus.

wl_seat:get_pointer ()

return pointer object

The ID provided will be initialized to the wlpointer interface for this seat. This request only takes effect if the seat has the pointer capability, or has had the pointer capability in the past. It is a protocol violation to issue this request on a seat that has never had the pointer capability. The missingcapability error will be sent in this case.

Returns:

wl_pointer

wl_seat:get_keyboard ()

return keyboard object

The ID provided will be initialized to the wlkeyboard interface for this seat. This request only takes effect if the seat has the keyboard capability, or has had the keyboard capability in the past. It is a protocol violation to issue this request on a seat that has never had the keyboard capability. The missingcapability error will be sent in this case.

Returns:

wl_keyboard

wl_seat:get_touch ()

return touch object

The ID provided will be initialized to the wltouch interface for this seat. This request only takes effect if the seat has the touch capability, or has had the touch capability in the past. It is a protocol violation to issue this request on a seat that has never had the touch capability. The missingcapability error will be sent in this case.

Returns:

wl_touch

wl_seat:release ()

release the seat object Using this request a client can tell the server that it is not going to use the seat object anymore.

Returns:

wl_seat

wl_seat:capabilities

seat capabilities changed

This is emitted whenever a seat gains or loses the pointer, keyboard or touch capabilities. The argument is a capability enum containing the complete set of capabilities this seat has. When the pointer capability is added, a client may create a wlpointer object using the wlseat.getpointer request. This object will receive pointer events until the capability is removed in the future. When the pointer capability is removed, a client should destroy the wlpointer objects associated with the seat where the capability was removed, using the wlpointer.release request. No further pointer events will be received on these objects. In some compositors, if a seat regains the pointer capability and a client has a previously obtained wlpointer object of version 4 or less, that object may start sending pointer events again. This behavior is considered a misinterpretation of the intended behavior and must not be relied upon by the client. wlpointer objects of version 5 or later must not send events if created before the most recent event notifying the client of an added pointer capability. The above behavior also applies to wlkeyboard and wl_touch with the keyboard and touch capabilities, respectively.

Parameters:

capabilities uint capabilities of the seat

wl_seat:name

unique identifier for this seat

In a multi-seat configuration the seat name can be used by clients to help identify which physical devices the seat represents. The seat name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wlseat globals. The name is only guaranteed to be unique for the current compositor instance. The same seat names are used for all clients. Thus, the name can be shared across processes to refer to a specific wlseat global. The name event is sent after binding to the seat global. This event is only sent once per seat object, and the name does not change over the lifetime of the wlseat global. Compositors may re-use the same seat name if the wlseat global is destroyed and re-created later.

Parameters:

name string seat identifier

wl_seat.Capability

seat capability bitmask This is a bitmask of capabilities this seat has; if a member is set, then it is present on the seat.

POINTER 1 the seat has pointer devices
KEYBOARD 2 the seat has one or more keyboards
TOUCH 4 the seat has touch devices

wl_seat.Error

wlseat error values These errors can be emitted in response to wlseat requests.

MISSING_CAPABILITY 0 getpointer, getkeyboard or get_touch called on seat without the matching capability

Class wl_pointer

pointer input device

The wlpointer interface represents one or more input devices, such as mice, which control the pointer location and pointerfocus of a seat. The wl_pointer interface generates motion, enter and leave events for the surfaces that the pointer is located over, and button and axis events for button presses, button releases and scrolling.

wl_pointer:set_cursor (serial, surface, hotspot_x, hotspot_y)

set the pointer surface

Set the pointer surface, i.e., the surface that contains the pointer image (cursor). This request gives the surface the role of a cursor. If the surface already has another role, it raises a protocol error. The cursor actually changes only if the pointer focus for this device is one of the requesting client's surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request it is replaced. If surface is NULL, the pointer image is hidden. The parameters hotspotx and hotspoty define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspotx, hotspoty), where (x, y) are the coordinates of the pointer location, in surface-local coordinates. On surface.attach requests to the pointer surface, hotspotx and hotspoty are decremented by the x and y parameters passed to the request. Attach must be confirmed by wlsurface.commit as usual. The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspotx and hotspoty. The input region is ignored for wlsurfaces with the role of a cursor. When the use as a cursor ends, the wlsurface is unmapped. The serial parameter must match the latest wlpointer.enter serial number sent to the client. Otherwise the request will be ignored.

Parameters:

serial uint serial number of the enter event
surface wl_surface pointer surface
hotspot_x int surface-local x coordinate
hotspot_y int surface-local y coordinate

Returns:

wl_pointer

wl_pointer:release ()

release the pointer object

Using this request a client can tell the server that it is not going to use the pointer object anymore. This request destroys the pointer proxy object, so clients must not call wlpointerdestroy() after using this request.

Returns:

wl_pointer

wl_pointer:enter

enter event

Notification that this seat's pointer is focused on a certain surface. When a seat's focus enters a surface, the pointer image is undefined and a client should respond to this event by setting an appropriate pointer image with the set_cursor request.

Parameters:

serial uint serial number of the enter event
surface wl_surface surface entered by the pointer
surface_x fixed surface-local x coordinate
surface_y fixed surface-local y coordinate

wl_pointer:leave

leave event

Notification that this seat's pointer is no longer focused on a certain surface. The leave notification is sent before the enter notification for the new focus.

Parameters:

serial uint serial number of the leave event
surface wl_surface surface left by the pointer

wl_pointer:motion

pointer motion event

Notification of pointer location change. The arguments surfacex and surfacey are the location relative to the focused surface.

Parameters:

time uint timestamp with millisecond granularity
surface_x fixed surface-local x coordinate
surface_y fixed surface-local y coordinate

wl_pointer:button

pointer button event

Mouse button click and release notifications. The location of the click is given by the last motion or enter event. The time argument is a timestamp with millisecond granularity, with an undefined base. The button is a button code as defined in the Linux kernel's linux/input-event-codes.h header file, e.g. BTN_LEFT. Any 16-bit button code value is reserved for future additions to the kernel's event code list. All other button codes above 0xFFFF are currently undefined but may be used in future versions of this protocol.

Parameters:

serial uint serial number of the button event
time uint timestamp with millisecond granularity
button uint button that produced the event
state uint physical state of the button

wl_pointer:axis

axis event

Scroll and other axis notifications. For scroll events (vertical and horizontal scroll axes), the value parameter is the length of a vector along the specified axis in a coordinate space identical to those of motion events, representing a relative movement along the specified axis. For devices that support movements non-parallel to axes multiple axis events will be emitted. When applicable, for example for touch pads, the server can choose to emit scroll events where the motion vector is equivalent to a motion event vector. When applicable, a client can transform its content relative to the scroll distance.

Parameters:

time uint timestamp with millisecond granularity
axis uint axis type
value fixed length of vector in surface-local coordinate space

wl_pointer:frame

end of a pointer event sequence

Indicates the end of a set of events that logically belong together. A client is expected to accumulate the data in all events within the frame before proceeding. All wlpointer events before a wlpointer.frame event belong logically together. For example, in a diagonal scroll motion the compositor will send an optional wlpointer.axissource event, two wlpointer.axis events (horizontal and vertical) and finally a wlpointer.frame event. The client may use this information to calculate a diagonal vector for scrolling. When multiple wlpointer.axis events occur within the same frame, the motion vector is the combined motion of all events. When a wlpointer.axis and a wlpointer.axisstop event occur within the same frame, this indicates that axis movement in one axis has stopped but continues in the other axis. When multiple wlpointer.axisstop events occur within the same frame, this indicates that these axes stopped in the same instance. A wlpointer.frame event is sent for every logical event group, even if the group only contains a single wlpointer event. Specifically, a client may get a sequence: motion, frame, button, frame, axis, frame, axisstop, frame. The wlpointer.enter and wlpointer.leave events are logical events generated by the compositor and not the hardware. These events are also grouped by a wlpointer.frame. When a pointer moves from one surface to another, a compositor should group the wlpointer.leave event within the same wlpointer.frame. However, a client must not rely on wlpointer.leave and wlpointer.enter being in the same wlpointer.frame. Compositor-specific policies may require the wlpointer.leave and wlpointer.enter event being split across multiple wlpointer.frame groups.

wl_pointer:axis_source

axis source event

Source information for scroll and other axes. This event does not occur on its own. It is sent before a wlpointer.frame event and carries the source information for all events within that frame. The source specifies how this event was generated. If the source is wlpointer.axissource.finger, a wlpointer.axisstop event will be sent when the user lifts the finger off the device. If the source is wlpointer.axissource.wheel, wlpointer.axissource.wheeltilt or wlpointer.axissource.continuous, a wlpointer.axisstop event may or may not be sent. Whether a compositor sends an axisstop event for these sources is hardware-specific and implementation-dependent; clients must not rely on receiving an axisstop event for these scroll sources and should treat scroll sequences from these scroll sources as unterminated by default. This event is optional. If the source is unknown for a particular axis event sequence, no event is sent. Only one wlpointer.axissource event is permitted per frame. The order of wlpointer.axisdiscrete and wlpointer.axissource is not guaranteed.

Parameters:

axis_source uint source of the axis event

wl_pointer:axis_stop

axis stop event

Stop notification for scroll and other axes. For some wlpointer.axissource types, a wlpointer.axisstop event is sent to notify a client that the axis sequence has terminated. This enables the client to implement kinetic scrolling. See the wlpointer.axissource documentation for information on when this event may be generated. Any wlpointer.axis events with the same axissource after this event should be considered as the start of a new axis motion. The timestamp is to be interpreted identical to the timestamp in the wlpointer.axis event. The timestamp value may be the same as a preceding wlpointer.axis event.

Parameters:

time uint timestamp with millisecond granularity
axis uint the axis stopped with this event

wl_pointer:axis_discrete

axis click event

Discrete step information for scroll and other axes. This event carries the axis value of the wlpointer.axis event in discrete steps (e.g. mouse wheel clicks). This event is deprecated with wlpointer version 8 - this event is not sent to clients supporting version 8 or later. This event does not occur on its own, it is coupled with a wlpointer.axis event that represents this axis value on a continuous scale. The protocol guarantees that each axisdiscrete event is always followed by exactly one axis event with the same axis number within the same wlpointer.frame. Note that the protocol allows for other events to occur between the axisdiscrete and its coupled axis event, including other axisdiscrete or axis events. A wlpointer.frame must not contain more than one axisdiscrete event per axis type. This event is optional; continuous scrolling devices like two-finger scrolling on touchpads do not have discrete steps and do not generate this event. The discrete value carries the directional information. e.g. a value of -2 is two steps towards the negative direction of this axis. The axis number is identical to the axis number in the associated axis event. The order of wlpointer.axisdiscrete and wlpointer.axis_source is not guaranteed.

Parameters:

axis uint axis type
discrete int number of steps

wl_pointer:axis_value120

axis high-resolution scroll event

Discrete high-resolution scroll information. This event carries high-resolution wheel scroll information, with each multiple of 120 representing one logical scroll step (a wheel detent). For example, an axisvalue120 of 30 is one quarter of a logical scroll step in the positive direction, a value120 of -240 are two logical scroll steps in the negative direction within the same hardware event. Clients that rely on discrete scrolling should accumulate the value120 to multiples of 120 before processing the event. The value120 must not be zero. This event replaces the wlpointer.axisdiscrete event in clients supporting wlpointer version 8 or later. Where a wlpointer.axissource event occurs in the same wlpointer.frame, the axis source applies to this event. The order of wlpointer.axisvalue120 and wlpointer.axis_source is not guaranteed.

Parameters:

axis uint axis type
value120 int scroll distance as fraction of 120

wl_pointer:axis_relative_direction

axis relative physical direction event

Relative directional information of the entity causing the axis motion. For a wlpointer.axis event, the wlpointer.axisrelativedirection event specifies the movement direction of the entity causing the wlpointer.axis event. For example: - if a user's fingers on a touchpad move down and this causes a wlpointer.axis verticalscroll down event, the physical direction is 'identical' - if a user's fingers on a touchpad move down and this causes a wlpointer.axis verticalscroll up scroll up event ('natural scrolling'), the physical direction is 'inverted'. A client may use this information to adjust scroll motion of components. Specifically, enabling natural scrolling causes the content to change direction compared to traditional scrolling. Some widgets like volume control sliders should usually match the physical direction regardless of whether natural scrolling is active. This event enables clients to match the scroll direction of a widget to the physical direction. This event does not occur on its own, it is coupled with a wlpointer.axis event that represents this axis value. The protocol guarantees that each axisrelativedirection event is always followed by exactly one axis event with the same axis number within the same wlpointer.frame. Note that the protocol allows for other events to occur between the axisrelativedirection and its coupled axis event. The axis number is identical to the axis number in the associated axis event. The order of wlpointer.axisrelativedirection, wlpointer.axisdiscrete and wlpointer.axissource is not guaranteed.

Parameters:

axis uint axis type
direction uint physical direction relative to axis motion

wl_pointer.Error

error

ROLE 0 given wl_surface has another role

wl_pointer.ButtonState

physical button state Describes the physical state of a button that produced the button event.

RELEASED 0 the button is not pressed
PRESSED 1 the button is pressed

wl_pointer.Axis

axis types Describes the axis types of scroll events.

VERTICAL_SCROLL 0 vertical axis
HORIZONTAL_SCROLL 1 horizontal axis

wl_pointer.AxisSource

axis source types

Describes the source types for axis events. This indicates to the client how an axis event was physically generated; a client may adjust the user interface accordingly. For example, scroll events from a "finger" source may be in a smooth coordinate space with kinetic scrolling whereas a "wheel" source may be in discrete steps of a number of lines. The "continuous" axis source is a device generating events in a continuous coordinate space, but using something other than a finger. One example for this source is button-based scrolling where the vertical motion of a device is converted to scroll events while a button is held down. The "wheel tilt" axis source indicates that the actual device is a wheel but the scroll event is not caused by a rotation but a (usually sideways) tilt of the wheel.

WHEEL 0 a physical wheel rotation
FINGER 1 finger on a touch surface
CONTINUOUS 2 continuous coordinate space
WHEEL_TILT 3 a physical wheel tilt

wl_pointer.AxisRelativeDirection

axis relative direction This specifies the direction of the physical motion that caused a wlpointer.axis event, relative to the wlpointer.axis direction.

IDENTICAL 0 physical motion matches axis direction
INVERTED 1 physical motion is the inverse of the axis direction

Class wl_keyboard

keyboard input device The wl_keyboard interface represents one or more keyboards associated with a seat.

wl_keyboard:release ()

release the keyboard object

Returns:

wl_keyboard

wl_keyboard:keymap

keyboard mapping

This event provides a file descriptor to the client which can be memory-mapped in read-only mode to provide a keyboard mapping description. From version 7 onwards, the fd must be mapped with MAPPRIVATE by the recipient, as MAPSHARED may fail.

Parameters:

format uint keymap format
fd fd keymap file descriptor
size uint keymap size, in bytes

wl_keyboard:enter

enter event

Notification that this seat's keyboard focus is on a certain surface. The compositor must send the wl_keyboard.modifiers event after this event.

Parameters:

serial uint serial number of the enter event
surface wl_surface surface gaining keyboard focus
keys array the currently pressed keys

wl_keyboard:leave

leave event

Notification that this seat's keyboard focus is no longer on a certain surface. The leave notification is sent before the enter notification for the new focus. After this event client must assume that no keys are pressed, it must stop key repeating if there's some going on and until it receives the next wl_keyboard.modifiers event, the client must also assume no modifiers are active.

Parameters:

serial uint serial number of the leave event
surface wl_surface surface that lost keyboard focus

wl_keyboard:key

key event

A key was pressed or released. The time argument is a timestamp with millisecond granularity, with an undefined base. The key is a platform-specific key code that can be interpreted by feeding it to the keyboard mapping (see the keymap event). If this event produces a change in modifiers, then the resulting wl_keyboard.modifiers event must be sent after this event. The compositor must not send this event without a surface of the client having keyboard focus.

Parameters:

serial uint serial number of the key event
time uint timestamp with millisecond granularity
key uint key that produced the event
state uint physical state of the key

wl_keyboard:modifiers

modifier and group state

Notifies clients that the modifier and/or group state has changed, and it should update its local state. The compositor may send this event without a surface of the client having keyboard focus, for example to tie modifier information to pointer focus instead. If a modifier event with pressed modifiers is sent without a prior enter event, the client can assume the modifier state is valid until it receives the next wlkeyboard.modifiers event. In order to reset the modifier state again, the compositor can send a wlkeyboard.modifiers event with no pressed modifiers.

Parameters:

serial uint serial number of the modifiers event
mods_depressed uint depressed modifiers
mods_latched uint latched modifiers
mods_locked uint locked modifiers
group uint keyboard layout

wl_keyboard:repeat_info

repeat rate and delay

Informs the client about the keyboard's repeat rate and delay. This event is sent as soon as the wlkeyboard object has been created, and is guaranteed to be received by the client before any key press event. Negative values for either rate or delay are illegal. A rate of zero will disable any repeating (regardless of the value of delay). This event can be sent later on as well with a new value if necessary, so clients should continue listening for the event past the creation of wlkeyboard.

Parameters:

rate int the rate of repeating keys in characters per second
delay int delay in milliseconds since key down until repeating starts

wl_keyboard.KeymapFormat

keyboard mapping format This specifies the format of the keymap provided to the client with the wl_keyboard.keymap event.

NO_KEYMAP 0 no keymap; client must understand how to interpret the raw keycode
XKB_V1 1 libxkbcommon compatible, null-terminated string; to determine the xkb keycode, clients must add 8 to the key event keycode

wl_keyboard.KeyState

physical key state Describes the physical state of a key that produced the key event.

RELEASED 0 key is not pressed
PRESSED 1 key is pressed

Class wl_touch

touchscreen input device

The wl_touch interface represents a touchscreen associated with a seat. Touch interactions can consist of one or more contacts. For each contact, a series of events is generated, starting with a down event, followed by zero or more motion events, and ending with an up event. Events relating to the same contact point can be identified by the ID of the sequence.

wl_touch:release ()

release the touch object

Returns:

wl_touch

wl_touch:down

touch down event and beginning of a touch sequence

A new touch point has appeared on the surface. This touch point is assigned a unique ID. Future events from this touch point reference this ID. The ID ceases to be valid after a touch up event and may be reused in the future.

Parameters:

serial uint serial number of the touch down event
time uint timestamp with millisecond granularity
surface wl_surface surface touched
id int the unique ID of this touch point
x fixed surface-local x coordinate
y fixed surface-local y coordinate

wl_touch:up

end of a touch event sequence

The touch point has disappeared. No further events will be sent for this touch point and the touch point's ID is released and may be reused in a future touch down event.

Parameters:

serial uint serial number of the touch up event
time uint timestamp with millisecond granularity
id int the unique ID of this touch point

wl_touch:motion

update of touch point coordinates A touch point has changed coordinates.

Parameters:

time uint timestamp with millisecond granularity
id int the unique ID of this touch point
x fixed surface-local x coordinate
y fixed surface-local y coordinate

wl_touch:frame

end of touch frame event

Indicates the end of a set of events that logically belong together. A client is expected to accumulate the data in all events within the frame before proceeding. A wl_touch.frame terminates at least one event but otherwise no guarantee is provided about the set of events within a frame. A client must assume that any state not updated in a frame is unchanged from the previously known state.

wl_touch:cancel

touch session cancelled

Sent if the compositor decides the touch stream is a global gesture. No further events are sent to the clients from that particular gesture. Touch cancellation applies to all touch points currently active on this client's surface. The client is responsible for finalizing the touch points, future touch points on this surface may reuse the touch point ID.

wl_touch:shape

update shape of touch point

Sent when a touchpoint has changed its shape. This event does not occur on its own. It is sent before a wltouch.frame event and carries the new shape information for any previously reported, or new touch points of that frame. Other events describing the touch point such as wltouch.down, wltouch.motion or wltouch.orientation may be sent within the same wltouch.frame. A client should treat these events as a single logical touch point update. The order of wltouch.shape, wltouch.orientation and wltouch.motion is not guaranteed. A wltouch.down event is guaranteed to occur before the first wltouch.shape event for this touch ID but both events may occur within the same wltouch.frame. A touchpoint shape is approximated by an ellipse through the major and minor axis length. The major axis length describes the longer diameter of the ellipse, while the minor axis length describes the shorter diameter. Major and minor are orthogonal and both are specified in surface-local coordinates. The center of the ellipse is always at the touchpoint location as reported by wltouch.down or wl_touch.move. This event is only sent by the compositor if the touch device supports shape reports. The client has to make reasonable assumptions about the shape if it did not receive this event.

Parameters:

id int the unique ID of this touch point
major fixed length of the major axis in surface-local coordinates
minor fixed length of the minor axis in surface-local coordinates

wl_touch:orientation

update orientation of touch point

Sent when a touchpoint has changed its orientation. This event does not occur on its own. It is sent before a wltouch.frame event and carries the new shape information for any previously reported, or new touch points of that frame. Other events describing the touch point such as wltouch.down, wltouch.motion or wltouch.shape may be sent within the same wltouch.frame. A client should treat these events as a single logical touch point update. The order of wltouch.shape, wltouch.orientation and wltouch.motion is not guaranteed. A wltouch.down event is guaranteed to occur before the first wltouch.orientation event for this touch ID but both events may occur within the same wl_touch.frame. The orientation describes the clockwise angle of a touchpoint's major axis to the positive surface y-axis and is normalized to the -180 to +180 degree range. The granularity of orientation depends on the touch device, some devices only support binary rotation values between 0 and 90 degrees. This event is only sent by the compositor if the touch device supports orientation reports.

Parameters:

id int the unique ID of this touch point
orientation fixed angle between major axis and positive surface y-axis in degrees

Class wl_output

compositor output region

An output describes part of the compositor geometry. The compositor works in the 'compositor coordinate system' and an output corresponds to a rectangular area in that space that is actually visible. This typically corresponds to a monitor that displays part of the compositor space. This object is published as global during start up, or when a monitor is hotplugged.

wl_output:release ()

release the output object Using this request a client can tell the server that it is not going to use the output object anymore.

Returns:

wl_output

wl_output:geometry

properties of the output

The geometry event describes geometric properties of the output. The event is sent when binding to the output object and whenever any of the properties change. The physical size can be set to zero if it doesn't make sense for this output (e.g. for projectors or virtual outputs). The geometry event will be followed by a done event (starting from version 2). Note: wloutput only advertises partial information about the output position and identification. Some compositors, for instance those not implementing a desktop-style output layout or those exposing virtual outputs, might fake this information. Instead of using x and y, clients should use xdgoutput.logical_position. Instead of using make and model, clients should use name and description.

Parameters:

x int x position within the global compositor space
y int y position within the global compositor space
physical_width int width in millimeters of the output
physical_height int height in millimeters of the output
subpixel int subpixel orientation of the output
make string textual description of the manufacturer
model string textual description of the model
transform int transform that maps framebuffer to output

wl_output:mode

advertise available modes for the output

The mode event describes an available mode for the output. The event is sent when binding to the output object and there will always be one mode, the current mode. The event is sent again if an output changes mode, for the mode that is now current. In other words, the current mode is always the last mode that was received with the current flag set. Non-current modes are deprecated. A compositor can decide to only advertise the current mode and never send other modes. Clients should not rely on non-current modes. The size of a mode is given in physical hardware units of the output device. This is not necessarily the same as the output size in the global compositor space. For instance, the output may be scaled, as described in wloutput.scale, or transformed, as described in wloutput.transform. Clients willing to retrieve the output size in the global compositor space should use xdgoutput.logicalsize instead. The vertical refresh rate can be set to zero if it doesn't make sense for this output (e.g. for virtual outputs). The mode event will be followed by a done event (starting from version 2). Clients should not use the refresh rate to schedule frames. Instead, they should use the wl_surface.frame event or the presentation-time protocol. Note: this information is not always meaningful for all outputs. Some compositors, such as those exposing virtual outputs, might fake the refresh rate or the size.

Parameters:

flags uint bitfield of mode flags
width int width of the mode in hardware units
height int height of the mode in hardware units
refresh int vertical refresh rate in mHz

wl_output:done

sent all information about output

This event is sent after all other properties have been sent after binding to the output object and after any other property changes done after that. This allows changes to the output properties to be seen as atomic, even if they happen via multiple events.

wl_output:scale

output scaling properties

This event contains scaling geometry information that is not in the geometry event. It may be sent after binding the output object or if the output scale changes later. If it is not sent, the client should assume a scale of 1. A scale larger than 1 means that the compositor will automatically scale surface buffers by this amount when rendering. This is used for very high resolution displays where applications rendering at the native resolution would be too small to be legible. It is intended that scaling aware clients track the current output of a surface, and if it is on a scaled output it should use wlsurface.setbuffer_scale with the scale of the output. That way the compositor can avoid scaling the surface, and the client can supply a higher detail image. The scale event will be followed by a done event.

Parameters:

factor int scaling factor of output

wl_output:name

name of this output

Many compositors will assign user-friendly names to their outputs, show them to the user, allow the user to refer to an output, etc. The client may wish to know this name as well to offer the user similar behaviors. The name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wloutput globals. The name is only guaranteed to be unique for the compositor instance. The same output name is used for all clients for a given wloutput global. Thus, the name can be shared across processes to refer to a specific wloutput global. The name is not guaranteed to be persistent across sessions, thus cannot be used to reliably identify an output in e.g. configuration files. Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do not assume that the name is a reflection of an underlying DRM connector, X11 connection, etc. The name event is sent after binding the output object. This event is only sent once per output object, and the name does not change over the lifetime of the wloutput global. Compositors may re-use the same output name if the wl_output global is destroyed and re-created later. Compositors should avoid re-using the same name if possible. The name event will be followed by a done event.

Parameters:

name string output name

wl_output:description

human-readable description of this output

Many compositors can produce human-readable descriptions of their outputs. The client may wish to know this description as well, e.g. for output selection purposes. The description is a UTF-8 string with no convention defined for its contents. The description is not guaranteed to be unique among all wl_output globals. Examples might include 'Foocorp 11" Display' or 'Virtual X11 output via :1'. The description event is sent after binding the output object and whenever the description changes. The description is optional, and may not be sent at all. The description event will be followed by a done event.

Parameters:

description string output description

wl_output.Subpixel

subpixel geometry information This enumeration describes how the physical pixels on an output are laid out.

UNKNOWN 0 unknown geometry
NONE 1 no geometry
HORIZONTAL_RGB 2 horizontal RGB
HORIZONTAL_BGR 3 horizontal BGR
VERTICAL_RGB 4 vertical RGB
VERTICAL_BGR 5 vertical BGR

wl_output.Transform

transform from framebuffer to output

This describes the transform that a compositor will apply to a surface to compensate for the rotation or mirroring of an output device. The flipped values correspond to an initial flip around a vertical axis followed by rotation. The purpose is mainly to allow clients to render accordingly and tell the compositor, so that for fullscreen surfaces, the compositor will still be able to scan out directly from client surfaces.

NORMAL 0 no transform
90 1 90 degrees counter-clockwise
180 2 180 degrees counter-clockwise
270 3 270 degrees counter-clockwise
FLIPPED 4 180 degree flip around a vertical axis
FLIPPED_90 5 flip and rotate 90 degrees counter-clockwise
FLIPPED_180 6 flip and rotate 180 degrees counter-clockwise
FLIPPED_270 7 flip and rotate 270 degrees counter-clockwise

wl_output.Mode

mode information

These flags describe properties of an output mode. They are used in the flags bitfield of the mode event.

CURRENT 0x1 indicates this is the current mode
PREFERRED 0x2 indicates this is the preferred mode

Class wl_region

region interface

A region object describes an area. Region objects are used to describe the opaque and input regions of a surface.

wl_region:destroy ()

destroy region

Destroy the region. This will invalidate the object ID.

Returns:

wl_region

wl_region:add (x, y, width, height)

add rectangle to region Add the specified rectangle to the region.

Parameters:

x int region-local x coordinate
y int region-local y coordinate
width int rectangle width
height int rectangle height

Returns:

wl_region

wl_region:subtract (x, y, width, height)

subtract rectangle from region Subtract the specified rectangle from the region.

Parameters:

x int region-local x coordinate
y int region-local y coordinate
width int rectangle width
height int rectangle height

Returns:

wl_region

Class wl_subcompositor

sub-surface compositing

The global interface exposing sub-surface compositing capabilities. A wlsurface, that has sub-surfaces associated, is called the parent surface. Sub-surfaces can be arbitrarily nested and create a tree of sub-surfaces. The root surface in a tree of sub-surfaces is the main surface. The main surface cannot be a sub-surface, because sub-surfaces must always have a parent. A main surface with its sub-surfaces forms a (compound) window. For window management purposes, this set of wlsurface objects is to be considered as a single window, and it should also behave as such. The aim of sub-surfaces is to offload some of the compositing work within a window from clients to the compositor. A prime example is a video player with decorations and video in separate wl_surface objects. This should allow the compositor to pass YUV video buffer processing to dedicated overlay hardware when possible.

wl_subcompositor:destroy ()

unbind from the subcompositor interface

Informs the server that the client will not be using this protocol object anymore. This does not affect any other objects, wl_subsurface objects included.

Returns:

wl_subcompositor

wl_subcompositor:get_subsurface (surface, parent)

give a surface the role sub-surface

Create a sub-surface interface for the given surface, and associate it with the given parent surface. This turns a plain wlsurface into a sub-surface. The to-be sub-surface must not already have another role, and it must not have an existing wlsubsurface object. Otherwise the badsurface protocol error is raised. Adding sub-surfaces to a parent is a double-buffered operation on the parent (see wlsurface.commit). The effect of adding a sub-surface becomes visible on the next time the state of the parent surface is applied. The parent surface must not be one of the child surface's descendants, and the parent must be different from the child surface, otherwise the badparent protocol error is raised. This request modifies the behaviour of wlsurface.commit request on the sub-surface, see the documentation on wl_subsurface interface.

Parameters:

surface wl_surface the surface to be turned into a sub-surface
parent wl_surface the parent surface

Returns:

wl_subsurface

wl_subcompositor.Error

error

BAD_SURFACE 0 the to-be sub-surface is invalid
BAD_PARENT 1 the to-be sub-surface parent is invalid

Class wl_subsurface

sub-surface interface to a wl_surface

An additional interface to a wlsurface object, which has been made a sub-surface. A sub-surface has one parent surface. A sub-surface's size and position are not limited to that of the parent. Particularly, a sub-surface is not automatically clipped to its parent's area. A sub-surface becomes mapped, when a non-NULL wlbuffer is applied and the parent surface is mapped. The order of which one happens first is irrelevant. A sub-surface is hidden if the parent becomes hidden, or if a NULL wlbuffer is applied. These rules apply recursively through the tree of surfaces. The behaviour of a wlsurface.commit request on a sub-surface depends on the sub-surface's mode. The possible modes are synchronized and desynchronized, see methods wlsubsurface.setsync and wlsubsurface.setdesync. Synchronized mode caches the wlsurface state to be applied when the parent's state gets applied, and desynchronized mode applies the pending wlsurface state directly. A sub-surface is initially in the synchronized mode. Sub-surfaces also have another kind of state, which is managed by wlsubsurface requests, as opposed to wlsurface requests. This state includes the sub-surface position relative to the parent surface (wlsubsurface.setposition), and the stacking order of the parent and its sub-surfaces (wlsubsurface.placeabove and .placebelow). This state is applied when the parent surface's wlsurface state is applied, regardless of the sub-surface's mode. As the exception, setsync and setdesync are effective immediately. The main surface can be thought to be always in desynchronized mode, since it does not have a parent in the sub-surfaces sense. Even if a sub-surface is in desynchronized mode, it will behave as in synchronized mode, if its parent surface behaves as in synchronized mode. This rule is applied recursively throughout the tree of surfaces. This means, that one can set a sub-surface into synchronized mode, and then assume that all its child and grand-child sub-surfaces are synchronized, too, without explicitly setting them. Destroying a sub-surface takes effect immediately. If you need to synchronize the removal of a sub-surface to the parent surface update, unmap the sub-surface first by attaching a NULL wlbuffer, update parent, and then destroy the sub-surface. If the parent wlsurface object is destroyed, the sub-surface is unmapped.

wl_subsurface:destroy ()

remove sub-surface interface

The sub-surface interface is removed from the wlsurface object that was turned into a sub-surface with a wlsubcompositor.getsubsurface request. The wlsurface's association to the parent is deleted. The wl_surface is unmapped immediately.

Returns:

wl_subsurface

wl_subsurface:set_position (x, y)

reposition the sub-surface

This schedules a sub-surface position change. The sub-surface will be moved so that its origin (top left corner pixel) will be at the location x, y of the parent surface coordinate system. The coordinates are not restricted to the parent surface area. Negative values are allowed. The scheduled coordinates will take effect whenever the state of the parent surface is applied. When this happens depends on whether the parent surface is in synchronized mode or not. See wlsubsurface.setsync and wlsubsurface.setdesync for details. If more than one set_position request is invoked by the client before the commit of the parent surface, the position of a new request always replaces the scheduled position from any previous request. The initial position is 0, 0.

Parameters:

x int x coordinate in the parent surface
y int y coordinate in the parent surface

Returns:

wl_subsurface

wl_subsurface:place_above (sibling)

restack the sub-surface

This sub-surface is taken from the stack, and put back just above the reference surface, changing the z-order of the sub-surfaces. The reference surface must be one of the sibling surfaces, or the parent surface. Using any other surface, including this sub-surface, will cause a protocol error. The z-order is double-buffered. Requests are handled in order and applied immediately to a pending state. The final pending state is copied to the active state the next time the state of the parent surface is applied. When this happens depends on whether the parent surface is in synchronized mode or not. See wlsubsurface.setsync and wlsubsurface.setdesync for details. A new sub-surface is initially added as the top-most in the stack of its siblings and parent.

Parameters:

sibling wl_surface the reference surface

Returns:

wl_subsurface

wl_subsurface:place_below (sibling)

restack the sub-surface

The sub-surface is placed just below the reference surface. See wlsubsurface.placeabove.

Parameters:

sibling wl_surface the reference surface

Returns:

wl_subsurface

wl_subsurface:set_sync ()

set sub-surface to synchronized mode

Change the commit behaviour of the sub-surface to synchronized mode, also described as the parent dependent mode. In synchronized mode, wlsurface.commit on a sub-surface will accumulate the committed state in a cache, but the state will not be applied and hence will not change the compositor output. The cached state is applied to the sub-surface immediately after the parent surface's state is applied. This ensures atomic updates of the parent and all its synchronized sub-surfaces. Applying the cached state will invalidate the cache, so further parent surface commits do not (re-)apply old state. See wlsubsurface for the recursive effect of this mode.

Returns:

wl_subsurface

wl_subsurface:set_desync ()

set sub-surface to desynchronized mode

Change the commit behaviour of the sub-surface to desynchronized mode, also described as independent or freely running mode. In desynchronized mode, wlsurface.commit on a sub-surface will apply the pending state directly, without caching, as happens normally with a wlsurface. Calling wlsurface.commit on the parent surface has no effect on the sub-surface's wlsurface state. This mode allows a sub-surface to be updated on its own. If cached state exists when wlsurface.commit is called in desynchronized mode, the pending state is added to the cached state, and applied as a whole. This invalidates the cache. Note: even if a sub-surface is set to desynchronized, a parent sub-surface may override it to behave as synchronized. For details, see wlsubsurface. If a surface's parent surface behaves as desynchronized, then the cached state is applied on set_desync.

Returns:

wl_subsurface

wl_subsurface.Error

error

BAD_SURFACE 0 wl_surface is not a sibling or the parent

wau

Contents

Protocols

Classes

Manual

Examples

Module wayland

Class wl_display

Returns:

Returns:

Parameters:

Parameters:

Class wl_registry

Parameters:

Returns:

Parameters:

Parameters:

Class wl_callback

Parameters:

Class wl_compositor

Returns:

Returns:

Class wl_shm_pool

Parameters:

Returns:

Returns:

Parameters:

Returns:

Class wl_shm

Parameters:

Returns:

Parameters:

Class wl_buffer

Returns:

Class wl_data_offer

Parameters:

Returns:

Parameters:

Returns:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Parameters:

Parameters:

Class wl_data_source

Parameters:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Parameters:

Parameters:

Class wl_data_device

Parameters:

Returns:

Parameters:

Returns:

Returns:

Parameters:

Parameters:

Parameters:

Parameters:

Class wl_data_device_manager

Returns:

Parameters:

Returns:

Class wl_shell

Parameters:

Returns:

Class wl_shell_surface

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Returns:

Module `wayland`