Wayland

https://wayland.freedesktop.org/docs/html
Admin
Wayland is a protocol and C library for a compositor to communicate with its clients, enabling a...
Tokens:52,939
Snippets:378
Trust Score:7.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### wl_shell_surface::resize

Source: https://wayland.freedesktop.org/docs/html/apa.html

Starts a pointer-driven resizing of the surface. Must be used in response to a button press event. The server may ignore the request depending on surface state.

```APIDOC
## wl_shell_surface::resize

### Description
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).

### Method
wl_shell_surface::resize

### Endpoint
wl_shell_surface::resize

### Parameters
#### Request Body
- **seat** (wl_seat) - Required - seat whose pointer is used
- **serial** (uint) - Required - serial number of the implicit grab on the pointer
- **edges** (wl_shell_surface::resize (uint)) - Required - which edge or corner is being dragged

### Response
#### Success Response (200)
No response body.

### Response Example
```json
{}
```

--------------------------------

### wl_shell_surface::move

Source: https://wayland.freedesktop.org/docs/html/apa.html

Starts a pointer-driven move of the surface. Must be used in response to a button press event. The server may ignore the request depending on surface state.

```APIDOC
## wl_shell_surface::move

### Description
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).

### Method
wl_shell_surface::move

### Endpoint
wl_shell_surface::move

### Parameters
#### Request Body
- **seat** (wl_seat) - Required - seat whose pointer is used
- **serial** (uint) - Required - serial number of the implicit grab on the pointer

### Response
#### Success Response (200)
No response body.

### Response Example
```json
{}
```

--------------------------------

### wl_data_device::start_drag

Source: https://wayland.freedesktop.org/docs/html/apa.html

Starts a drag-and-drop operation on behalf of the client. The source provides the data for the transfer, the origin is the surface where the drag starts, and an optional icon surface can be used as a drag-and-drop icon.

```APIDOC
## wl_data_device::start_drag

### Description
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.

### Parameters
#### Request Parameters
- **source** (wl_data_source) - Required - Data source for the eventual transfer
- **origin** (wl_surface) - Required - Surface where the drag originates
- **icon** (wl_surface) - Optional - Drag-and-drop icon surface
- **serial** (uint) - Required - Serial number of the implicit grab on the origin

### Request Example
```json
{
  "source": "wl_data_source",
  "origin": "wl_surface",
  "icon": "wl_surface",
  "serial": 0
}
```

### Response
No response is defined for this request.

### Errors
- **used_source** - The given source may not be used in any further set_selection or start_drag requests.
- **protocol error** - If the icon surface already has another role.
```

--------------------------------

### wl_display::get_registry

Source: https://wayland.freedesktop.org/docs/html/apa.html

Get global registry object. Creates a registry object to list and bind global objects available from the compositor.

```APIDOC
## wl_display::get_registry

### Description
Creates a registry object that allows the client to list and bind the global objects available from the compositor.

### Interface
wl_display

### Type
Request

### Parameters
#### Registry
- **registry** (id) - Required - id for the new wl_registry, global registry object.

### Notes
Server-side resources consumed in response to a get_registry request can only be released when the client disconnects, not when the client-side proxy is destroyed. Therefore, clients should invoke get_registry infrequently to avoid wasting memory.

### Response
No explicit response; the created wl_registry object is used for subsequent interactions.
```

--------------------------------

### wl_shell_surface::configure

Source: https://wayland.freedesktop.org/docs/html/apa.html

Suggest a resize of the surface. The configure event asks the client to resize its surface. The size is a hint, and the client is free to ignore it. The edges parameter provides a hint about how the surface was resized.

```APIDOC
## wl_shell_surface::configure

### Description
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
#### Event Parameters
- **edges** (wl_shell_surface::resize) - Required - how the surface was resized
- **width** (int) - Required - new width of the surface
- **height** (int) - Required - new height of the surface

```

--------------------------------

### wl_shell_surface::set_fullscreen

Source: https://wayland.freedesktop.org/docs/html/apa.html

Maps the surface as a fullscreen surface. The compositor will reply with a configure event with the dimensions for the output on which the surface will be made fullscreen.

```APIDOC
## wl_shell_surface::set_fullscreen

### Description
Makes the surface a fullscreen surface. The compositor will reply with a configure event with the dimensions for the output on which the surface will be made fullscreen.

### Method
wl_shell_surface::set_fullscreen

### Parameters
#### method
- **method** (uint) - Required - Method for resolving size conflict. Possible values: "driver", "scale", "fill".

#### framerate
- **framerate** (uint) - Required - Framerate in mHz. A value of 0 indicates that the client does not care about framerate.

#### output
- **output** (wl_output) - Optional - Output on which the surface is to be fullscreen. If not given, the compositor will apply its policy.

### Request Example
```
wl_shell_surface::set_fullscreen(method, framerate, output)
```

### Response
#### Success Response (200)
- **configure** (event) - The compositor will send a configure event with the dimensions for the output.

#### Response Example
```
configure(width, height)
```
```

--------------------------------

### wl_shell_surface::fullscreen_method (enum)

Source: https://wayland.freedesktop.org/docs/html/apa.html

Different methods 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.

```APIDOC
## wl_shell_surface::fullscreen_method (enum)

### Description
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.

### Values
- **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

```

--------------------------------

### wl_compositor::create_surface

Source: https://wayland.freedesktop.org/docs/html/apa.html

Creates a new surface. The client provides an id for the new wl_surface object, and the compositor will create the surface.

```APIDOC
## wl_compositor::create_surface - create new surface

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

### Method
wl_compositor::create_surface

### Endpoint
wl_compositor::create_surface

### Parameters
#### Request Parameters
- **id** (id) - Required - id for the new wl_surface - the new surface

### Request Example
No request body; this is a Wayland protocol request with parameters.

### Response
#### Success Response (200)
No response body; the new surface is created.

#### Response Example
No response body; the new surface is created.
```

--------------------------------

### wl_data_device::enter

Source: https://wayland.freedesktop.org/docs/html/apa.html

Initiates a drag-and-drop session when the pointer enters a client-owned surface. Provides the pointer position in surface-local coordinates.

```APIDOC
## wl_data_device::enter

### Description
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
#### Event Arguments
- **serial** (uint) - Required - serial number of the enter event
- **surface** (wl_surface) - Required - client surface entered
- **x** (fixed) - Required - surface-local x coordinate
- **y** (fixed) - Required - surface-local y coordinate
- **id** (wl_data_offer) - Required - source data_offer object
```

--------------------------------

### wl_shell_surface::set_toplevel

Source: https://wayland.freedesktop.org/docs/html/apa.html

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

```APIDOC
## wl_shell_surface::set_toplevel

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

### Method
wl_shell_surface::set_toplevel

### Endpoint
wl_shell_surface::set_toplevel

### Parameters
None.

### Response
#### Success Response (200)
No response body.

### Response Example
```json
{}
```

--------------------------------

### wl_shell::get_shell_surface

Source: https://wayland.freedesktop.org/docs/html/apa.html

Creates a shell surface for an existing wl_surface, giving it the shell surface role. Raises a protocol error if the surface already has another role.

```APIDOC
## wl_shell::get_shell_surface

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

### Method
wl_shell::get_shell_surface

### Endpoint
wl_shell::get_shell_surface

### Parameters
#### Request Body
- **id** (wl_shell_surface) - Required - id for the new wl_shell_surface - shell surface to create
- **surface** (wl_surface) - Required - wl_surface - surface to be given the shell surface role

### Response
#### Success Response (200)
- **id** (wl_shell_surface) - The newly created shell surface object.

### Response Example
```json
{
  "id": "new_shell_surface_id"
}
```
```

--------------------------------

### wl_data_offer::offer

Source: https://wayland.freedesktop.org/docs/html/apa.html

Advertises an offered MIME type. Sent immediately after creating the wl_data_offer object, one event per offered MIME type.

```APIDOC
## wl_data_offer::offer

### Description
Advertises an offered MIME type. Sent immediately after creating the wl_data_offer object, one event per offered MIME type.

### Event
wl_data_offer::offer

### Parameters
- **mime_type** (string) - Required - Offered MIME type.

```

--------------------------------

### wl_keyboard::keymap

Source: https://wayland.freedesktop.org/docs/html/apa.html

Provides a file descriptor to the client for memory-mapping a keyboard mapping description. The fd must be mapped with MAP_PRIVATE from version 7 onwards.

```APIDOC
## wl_keyboard::keymap

### Description
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 MAP_PRIVATE by the recipient, as MAP_SHARED may fail.

### Parameters
- **format** (wl_keyboard::keymap_format, uint) - Required - keymap format
- **fd** (fd) - Required - keymap file descriptor
- **size** (uint) - Required - keymap size, in bytes

```

--------------------------------

### wl_data_device::data_offer

Source: https://wayland.freedesktop.org/docs/html/apa.html

Introduces a new wl_data_offer object for use in drag-and-drop or selection operations. The new data_offer will subsequently send offer events to describe its mime types.

```APIDOC
## wl_data_device::data_offer

### Description
Introduces a new wl_data_offer object, which will subsequently be used in either the data_device.enter event (for drag-and-drop) or the data_device.selection event (for selections). Immediately following the data_device.data_offer event, the new data_offer object will send out data_offer.offer events to describe the mime types it offers.

### Parameters
#### Event Arguments
- **id** (id) - Required - id for the new wl_data_offer - the new data_offer object
```

--------------------------------

### wl_shell_surface::pong

Source: https://wayland.freedesktop.org/docs/html/apa.html

Responds to a ping event with a pong request to indicate the client is responsive. Required to avoid being deemed unresponsive.

```APIDOC
## wl_shell_surface::pong

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

### Method
wl_shell_surface::pong

### Endpoint
wl_shell_surface::pong

### Parameters
#### Request Body
- **serial** (uint) - Required - serial number of the ping event

### Response
#### Success Response (200)
No response body.

### Response Example
```json
{}
```

--------------------------------

### wl_surface::attach

Source: https://wayland.freedesktop.org/docs/html/apa.html

Sets a buffer as the content of the surface. The buffer size, position, and double-buffered state are managed through this request.

```APIDOC
## wl_surface::attach

### Description
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 buffer_transform and the inverse buffer_scale. 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.

### Method
wl_surface::attach

### Endpoint
wl_surface::attach

### Parameters
#### Request Body
- **buffer** (wl_buffer) - Required - Buffer of surface contents
- **x** (int) - Required - Surface-local x coordinate
- **y** (int) - Required - Surface-local y coordinate

### Request Example
```json
{
  "buffer": "wl_buffer",
  "x": 0,
  "y": 0
}
```

### Response
#### Success Response (200)
No response body. The request is asynchronous.

#### Response Example
```json
{}
```
```

--------------------------------

### wl_shell_surface::set_popup

Source: https://wayland.freedesktop.org/docs/html/apa.html

Maps the surface as a popup surface. A popup surface is a transient surface with an added pointer grab.

```APIDOC
## wl_shell_surface::set_popup

### Description
Maps the surface as a popup surface. A popup surface is a transient surface with an added pointer grab. The popup grab continues until the window is destroyed or a mouse button is pressed in any other client's window.

### Method
wl_shell_surface::set_popup

### Parameters
#### seat
- **seat** (wl_seat) - Required - Seat whose pointer is used.

#### serial
- **serial** (uint) - Required - Serial number of the implicit grab on the pointer.

#### parent
- **parent** (wl_surface) - Required - Parent surface.

#### x
- **x** (int) - Required - Surface-local x coordinate.

#### y
- **y** (int) - Required - Surface-local y coordinate.

#### flags
- **flags** (wl_shell_surface::transient) - Required - Transient surface behavior.

### Request Example
```
wl_shell_surface::set_popup(seat, serial, parent, x, y, flags)
```

### Response
#### Success Response (200)
No explicit response is defined. The popup grab continues until the window is destroyed or a mouse button is pressed in any other client's window.
```

--------------------------------

### wl_data_device_manager::create_data_source

Source: https://wayland.freedesktop.org/docs/html/apa.html

Creates a new data source object. This request is used to initiate a data transfer from the client side.

```APIDOC
## wl_data_device_manager::create_data_source

### Description
Creates a new data source object. This request is used to initiate a data transfer from the client side.

### Method
REQUEST

### Endpoint
wl_data_device_manager::create_data_source

### Parameters
#### Request Body
- **id** (wl_data_source) - Required - id for the new wl_data_source - data source to create

### Request Example
```
// No request body example provided in the source.
```

### Response
#### Success Response (200)
- **id** (wl_data_source) - The newly created data source object.

#### Response Example
```
// No response example provided in the source.
```
```

--------------------------------

### wl_registry::bind

Source: https://wayland.freedesktop.org/docs/html/apa.html

Binds a new, client-created object to the server using the specified name as the identifier. This request creates a client-side handle that lets the object emit events to the client and lets the client invoke requests on the object.

```APIDOC
## wl_registry::bind

### Description
Binds a new, client-created object to the server using the specified name as the identifier.

### Method
REQUEST

### Endpoint
wl_registry::bind

### Parameters
#### Request Body
- **name** (uint) - Required - unique numeric name of the object
- **id** (new_id) - Required - bound object

### Request Example
```json
{
  "name": 0,
  "id": "new_id"
}
```

### Response
#### Success Response (200)
No specific response data.

#### Response Example
```json
{}
```
```

--------------------------------

### wl_data_offer::source_actions

Source: https://wayland.freedesktop.org/docs/html/apa.html

Notifies the source-side available actions. Sent immediately after creating the wl_data_offer object, or anytime the source side changes its offered actions through wl_data_source.set_actions.

```APIDOC
## wl_data_offer::source_actions

### Description
Notifies the source-side available actions. Sent immediately after creating the wl_data_offer object, or anytime the source side changes its offered actions through wl_data_source.set_actions.

### Event
wl_data_offer::source_actions

### Parameters
- **source_actions** (wl_data_device_manager::dnd_action, uint) - Required - Actions offered by the data source.

```

--------------------------------

### wl_display::sync

Source: https://wayland.freedesktop.org/docs/html/apa.html

Asynchronous roundtrip request. Asks the server to emit 'done' on the returned wl_callback, used as a barrier for previous requests.

```APIDOC
## wl_display::sync

### Description
Asynchronous roundtrip request. Asks the server to emit the 'done' event on the returned wl_callback object, serving as a barrier to ensure all previous requests and resulting events have been handled.

### Interface
wl_display

### Type
Request

### Parameters
#### Callback
- **callback** (id) - Required - id for the new wl_callback, callback object for the sync request.

### Notes
The object returned by this request will be destroyed by the compositor after the callback is fired; the client must not use it afterward. The callback_data passed in the callback is undefined and should be ignored.

### Response
No explicit response; the compositor sends the 'done' event on the wl_callback object.
```

--------------------------------

### wl_keyboard::repeat_info

Source: https://wayland.freedesktop.org/docs/html/apa.html

Informs the client about the keyboard's repeat rate and delay. This event is sent as soon as the wl_keyboard object has been created, and is guaranteed to be received by the client before any key press event.

```APIDOC
## wl_keyboard::repeat_info

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

### Parameters
- **rate** (int) - Required - the rate of repeating keys in characters per second
- **delay** (int) - Required - delay in milliseconds since key down until repeating starts

```

--------------------------------

### wl_seat::get_keyboard

Source: https://wayland.freedesktop.org/docs/html/apa.html

Returns a new wl_keyboard object for the seat. The ID provided will be initialized to the wl_keyboard interface. This request only takes effect if the seat has the keyboard capability, or has had it in the past.

```APIDOC
## wl_seat::get_keyboard

### Description
Returns a new wl_keyboard object for the seat. The ID provided will be initialized to the wl_keyboard interface. This request only takes effect if the seat has the keyboard capability, or has had it in the past.

### Method
wl_seat::get_keyboard

### Parameters
#### Request Body
- **id** (wl_keyboard) - Required - id for the new wl_keyboard - seat keyboard

### Response
#### Success Response
No response body. The new wl_keyboard object is created.

### Errors
- **missing_capability** - get_keyboard called on seat without the matching capability
```

--------------------------------

### wl_shell_surface::set_title

Source: https://wayland.freedesktop.org/docs/html/apa.html

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

```APIDOC
## wl_shell_surface::set_title

### Description
Sets 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.

### Method
wl_shell_surface::set_title

### Parameters
#### title
- **title** (string) - Required - Surface title. Must be encoded in UTF-8.

### Request Example
```
wl_shell_surface::set_title(title)
```

### Response
#### Success Response (200)
No explicit response is defined.
```

--------------------------------

### wl_touch::up

Source: https://wayland.freedesktop.org/docs/html/apa.html

Event indicating the end of a touch event sequence.

```APIDOC
## wl_touch::up

### Description
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.

### Method
Event

### Endpoint
wl_touch::up

### Parameters
#### 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_shm::format (event)

Source: https://wayland.freedesktop.org/docs/html/apa.html

Informs the client about a valid pixel format that can be used for buffers. Emitted on binding the wl_shm object.

```APIDOC
## wl_shm::format (event)

### Description
Informs the client about a valid pixel format that can be used for buffers. Known formats include argb8888 and xrgb8888. Extensions to drm_fourcc.h (or the format enum) do not require increasing the wl_shm version; as a result, clients may receive format codes which were not in the list at the time the client was made.

### Parameters
#### Event Parameters
- **format** (wl_shm::format (uint)) - Required - buffer pixel format

```

--------------------------------

### wl_surface::get_release

Source: https://wayland.freedesktop.org/docs/html/apa.html

Creates a callback for the release of the buffer attached by the client. The compositor releases the buffer when it has finished using it.

```APIDOC
## wl_surface::get_release

### Description
Creates a callback for the release of the buffer attached by the client with wl_surface.attach. The compositor will release the buffer when it has finished its usage of the underlying storage for the relevant commit.

### Parameters
- **callback** (id) - Required - ID for the new wl_callback object.

### Notes
- Release callbacks are double-buffered state and associated with the pending buffer at wl_surface.commit time.
- The callback_data passed in the wl_callback.done event is unused and always zero.
- Sending this request without attaching a non-null buffer in the same content update is a protocol error; the compositor will send the no_buffer error.
```

--------------------------------

### wl_shm::create_pool

Source: https://wayland.freedesktop.org/docs/html/apa.html

Creates a new wl_shm_pool object using a file descriptor and size. The server mmaps the specified bytes to back the pool for shared memory buffers.

```APIDOC
## wl_shm::create_pool

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

### Parameters
#### Request Parameters
- **id** (new_id) - Required - id for the new wl_shm_pool
- **fd** (fd) - Required - file descriptor for the pool
- **size** (int) - Required - pool size, in bytes

```

--------------------------------

### wl_data_device::leave

Source: https://wayland.freedesktop.org/docs/html/apa.html

Ends a drag-and-drop session when the pointer leaves the surface. The client must destroy the wl_data_offer introduced at enter time.

```APIDOC
## wl_data_device::leave

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

### Parameters
#### Event Arguments
None.
```

--------------------------------

### wl_data_device::selection

Source: https://wayland.freedesktop.org/docs/html/apa.html

Advertises a new selection for the device. The client must destroy the previous selection data_offer, if any, upon receiving this event.

```APIDOC
## wl_data_device::selection

### Description
The selection event is sent out to notify the client of a new wl_data_offer for the selection for this device. The data_device.data_offer and the data_offer.offer events are sent out immediately before this event to introduce the data offer object. The selection event is sent to a client immediately before receiving keyboard focus and when a new selection is set while the client has keyboard focus. The data_offer is valid until a new data_offer or NULL is received or until the client loses keyboard focus. 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 data_offer, if any, upon receiving this event.

### Parameters
#### Event Arguments
- **id** (wl_data_offer) - Required - selection data_offer object
```

--------------------------------

### wl_keyboard::keymap_format

Source: https://wayland.freedesktop.org/docs/html/apa.html

Enum specifying the format of the keymap provided to the client with the wl_keyboard.keymap event.

```APIDOC
## wl_keyboard::keymap_format

### Description
This specifies the format of the keymap provided to the client with the wl_keyboard.keymap event.

### Values
- **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_pointer::enter

Source: https://wayland.freedesktop.org/docs/html/apa.html

Notification that the pointer has entered a surface. The client should respond by setting an appropriate cursor image using set_cursor.

```APIDOC
## wl_pointer::enter

### Description
Notification that the pointer has entered a surface. The client should respond by setting an appropriate cursor image using set_cursor.

### Method
wl_pointer::enter

### Endpoint
wl_pointer::enter

### Parameters
#### Event Data
- **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.

### Request Example
```json
{
  "serial": 1,
  "surface": "wl_surface",
  "surface_x": 0.0,
  "surface_y": 0.0
}
```

### Response
#### Success Response (200)
No response body.

#### Response Example
```json
{}
```
```

--------------------------------

### wl_output::mode

Source: https://wayland.freedesktop.org/docs/html/apa.html

Event advertising available modes for the output, including the current mode.

```APIDOC
## wl_output::mode

### Description
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.

### Method
Event

### Endpoint
wl_output::mode

### Parameters
#### Event Parameters
- **flags** (wl_output::mode, 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

### Response
No response (event)

```

--------------------------------

### wl_data_offer::set_actions

Source: https://wayland.freedesktop.org/docs/html/apa.html

Sets the actions that the destination side client supports for this operation. May trigger wl_data_source.action and wl_data_offer.action events if the compositor needs to change the selected action.

```APIDOC
## wl_data_offer::set_actions

### Description
Sets the actions that the destination side client supports for this operation. This request may trigger the emission of wl_data_source.action and wl_data_offer.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 wl_data_device.enter or wl_data_device.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 wl_data_source.cancelled. The dnd_actions argument must contain only values expressed in the wl_data_device_manager.dnd_actions enum, and the preferred_action 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 wl_data_offer.receive requests, and is expected to perform one last wl_data_offer.set_actions request with a preferred action other than "ask" (and optionally wl_data_offer.accept) before requesting wl_data_offer.finish, in order to convey the action selected by the user. If the preferred action is not in the wl_data_offer.source_actions mask, an error will be raised. If the "ask" action is dismissed (e.g. user cancellation), the client is expected to perform wl_data_offer.destroy right away. This request can only be made on drag-and-drop offers, a protocol error will be raised otherwise.

### Method
wl_data_offer::set_actions

### Parameters
#### Request Parameters
- **dnd_actions** (wl_data_device_manager::dnd_action (uint)) - Required - actions supported by the destination client
- **preferred_action** (wl_data_device_manager::dnd_action (uint)) - Required - action preferred by the destination client
```

--------------------------------

### wl_output::description

Source: https://wayland.freedesktop.org/docs/html/apa.html

Event sent after binding the output object and whenever the description changes, providing a human-readable description of the output. The description is optional and may not be sent at all.

```APIDOC
## wl_output::description

### Description
Event sent after binding the output object and whenever the description changes, providing a human-readable description of the output. The description is optional and may not be sent at all.

### Event
description

### Parameters
- **description** (string) - Required - Output description

### Notes
- Sent after binding the output object and on changes.
- Not guaranteed to be unique.
- Followed by a done event.
```

--------------------------------

### wl_output::done

Source: https://wayland.freedesktop.org/docs/html/apa.html

Event indicating that all output properties have been sent, allowing atomic updates.

```APIDOC
## wl_output::done

### Description
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.

### Method
Event

### Endpoint
wl_output::done

### Parameters
None

### Response
No response (event)

```

--------------------------------

### wl_output::name

Source: https://wayland.freedesktop.org/docs/html/apa.html

Event sent after binding the output object to provide a unique, user-friendly name for the output. The name is a UTF-8 string, unique among all wl_output globals, and is followed by a done event.

```APIDOC
## wl_output::name

### Description
Event sent after binding the output object to provide a unique, user-friendly name for the output. The name is a UTF-8 string, unique among all wl_output globals, and is followed by a done event.

### Event
name

### Parameters
- **name** (string) - Required - Output name

### Notes
- Sent once per output object.
- Name does not change over the lifetime of the wl_output global.
- Compositors may re-use the same name if the global is destroyed and re-created.
- Followed by a done event.
```

--------------------------------

### wl_registry::global

Source: https://wayland.freedesktop.org/docs/html/apa.html

Notifies the client that a global object with the given name is now available, and it implements the given version of the given interface. This event is emitted for each global currently in the registry and for new globals that appear later.

```APIDOC
## wl_registry::global

### Description
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.

### Method
EVENT

### Endpoint
wl_registry::global

### Parameters
#### Event Data
- **name** (uint) - Required - numeric name of the global object
- **interface** (string) - Required - interface implemented by the object
- **version** (uint) - Required - interface version

### Request Example
```json
{
  "name": 0,
  "interface": "string",
  "version": 0
}
```

### Response
No response data.
```
Tokens:
Raw