Wayland

https://wayland.app/protocols/
Admin
Wayland is a modern display server protocol that provides a more efficient and secure alternative to...
Tokens:791,787
Snippets:6,140
Trust Score:8.6
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### tizen_screenmirror::start

Source: https://wayland.app/protocols/tizen-extension

Starts the screenmirror.

```APIDOC
## tizen_screenmirror::start

### Description
Starts the screenmirror.

### Method
start

### Signature
```
start()
```

```

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

### zaura_surface::set_server_start_resize

Source: https://wayland.app/protocols/aura-shell

Requests server-side start of resize for the surface.

```APIDOC
## zaura_surface::set_server_start_resize

### Description
Suggests a surface to have client-side decoration, but server-side decides when and where to start the resize. The server may also apply visual effects to indicate that the resize operation is ongoing.

### Method
set_server_start_resize

### Endpoint
zaura_surface::set_server_start_resize

### Parameters
None

### Request Example
```
set_server_start_resize()
```

```

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

### zaura_surface::start_throttle

Source: https://wayland.app/protocols/aura-shell

start throttling on the surface

```APIDOC
## zaura_surface::start_throttle

### Description
Informs the client to start throttling on the surface.

### Method
zaura_surface::start_throttle

### Endpoint
zaura_surface::start_throttle

### Parameters
No parameters.

### Request Example
```
start_throttle()
```

### Response
No response specified.
```

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

### wl_shell_surface::resize

Source: https://wayland.app/protocols/wayland

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

```APIDOC
## [wl_shell_surface::resize]

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

### Method
wl_shell_surface::resize

### Endpoint
wl_shell_surface::resize

### Parameters
#### Request Arguments
- **seat** (object<wl_seat>) - Required - Seat whose pointer is used
- **serial** (uint) - Required - Serial number of the implicit grab on the pointer
- **edges** (uint<wl_shell_surface.resize>) - Required - Which edge or corner is being dragged

### Request Example
```
resize(seat: object<wl_seat>, serial: uint, edges: uint<wl_shell_surface.resize>)
```

### Response
No response data.

```

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

### river_window_manager_v1::manage_dirty

Source: https://wayland.app/protocols/river-window-management-v1

Ensures a manage sequence is started and that a manage_start event is sent by the server. If a manage sequence is already ongoing, a new one will start after the current one completes.

```APIDOC
## river_window_manager_v1::manage_dirty

### Description
Ensures a manage sequence is started and that a manage_start event is sent by the server. If a manage sequence is already ongoing, a new one will start after the current one completes.

### Method
Request

### Request
No arguments.

### Response
No response.
```

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

### weston_desktop_shell::desktop_ready

Source: https://wayland.app/protocols/weston-desktop-shell

Tells the server that the desktop elements have been drawn and the desktop is ready to be shown.

```APIDOC
## weston_desktop_shell::desktop_ready

### Description
Tells the server that the desktop elements have been drawn and the desktop is ready to be shown.

### Method
Request

### Endpoint
weston_desktop_shell::desktop_ready

### Parameters
None.

### Request Example
```
desktop_ready()
```

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

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

### kde_output_configuration_v2::apply

Source: https://wayland.app/protocols/kde-output-management-v2

Applies configuration changes to all output devices.

```APIDOC
## apply()

### Description
Asks the server to apply property changes requested through this outputconfiguration object to all outputs on the server side. The output configuration can be applied only once. The already_applied protocol error will be posted if the apply request is called the second time.

### Method
apply

```

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

### get_window_opacity

Source: https://wayland.app/protocols/treeland-personalization-manager-v1

Gets the window opacity.

```APIDOC
## get_window_opacity

### Description
Get the window opacity.

### Method
get_window_opacity

### Request Example
```
get_window_opacity()
```

```

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

### ivi_hmi_controller::UI_ready

Source: https://wayland.app/protocols/ivi-hmi-controller

Request to inform the server that the client is ready to draw the desktop.

```APIDOC
## ivi_hmi_controller::UI_ready

### Description
Informs the server that the client is ready to draw the desktop.

### Method
Request

### Interface
ivi_hmi_controller

### Request
No arguments.

### Response
No response.

```

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

### get_window_titlebar_height

Source: https://wayland.app/protocols/treeland-personalization-manager-v1

Gets the window titlebar height.

```APIDOC
## get_window_titlebar_height

### Description
Get the window titlebar height.

### Method
get_window_titlebar_height

### Request Example
```
get_window_titlebar_height()
```

```

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

### kde_output_device_v2::capabilities

Source: https://wayland.app/protocols/kde-output-device-v2

Event that indicates what capabilities this device has. Sent on startup before the first done event.

```APIDOC
## kde_output_device_v2::capabilities

### Description
What capabilities this device has, sent on startup before the first done event.

### Event
kde_output_device_v2::capabilities

### Parameters
- **flags** (uint<kde_output_device_v2.capability>) - Required - capability flags

### Response
No response event is defined for this event.
```

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

### get_window_theme_type

Source: https://wayland.app/protocols/treeland-personalization-manager-v1

Gets the window theme type.

```APIDOC
## get_window_theme_type

### Description
Get the window theme type.

### Method
get_window_theme_type

### Request Example
```
get_window_theme_type()
```

```

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

### agl_shell::ready

Source: https://wayland.app/protocols/agl-shell

Tells the server that the client is ready to be shown. The server delays presentation until all shell clients are ready, showing a black screen during start-up.

```APIDOC
## agl_shell::ready

### Description
Tells the server that this client is ready to be shown. The server will delay presentation during start-up until all shell clients are ready, and will display a black screen instead. This gives the client an opportunity to set up and configure several surfaces into a coherent interface. The client that binds to this interface must send this request, otherwise they may stall the compositor unnecessarily. If this request is called after the compositor has already finished start-up, no operation is performed.

### Method
Request

### Endpoint
agl_shell::ready

### Parameters
None

### Request Example
No request body.

### Response
No response.
```

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

### get_active_color

Source: https://wayland.app/protocols/treeland-personalization-manager-v1

Gets the system active color.

```APIDOC
## get_active_color

### Description
Get the system active color.

### Method
get_active_color

### Request Example
```
get_active_color()
```

```

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

### org_kde_plasma_window::request_enter_new_virtual_desktop

Source: https://wayland.app/protocols/kde-plasma-window-management

Makes the window enter a new virtual desktop.

```APIDOC
## org_kde_plasma_window::request_enter_new_virtual_desktop

### Description
Make the window enter a new virtual desktop. If the server consents the request, it will create a new virtual desktop and assign the window to it. Available since version 8.

### Method
Request

### Interface
org_kde_plasma_window

### Request Example
```
request_enter_new_virtual_desktop()
```
```

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

### get_icon_theme

Source: https://wayland.app/protocols/treeland-personalization-manager-v1

Gets the system icon theme.

```APIDOC
## get_icon_theme

### Description
Get the system icon theme.

### Method
get_icon_theme

### Request Example
```
get_icon_theme()
```

```

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

### zwp_fullscreen_shell_v1

Source: https://wayland.app/protocols/fullscreen-shell-unstable-v1

Documentation for the zwp_fullscreen_shell_v1 protocol interface, including the present_surface_for_mode request, the capability event, and the present_method enum.

```APIDOC
## zwp_fullscreen_shell_v1::present_surface_for_mode

### Description
Presents a surface on the given output for a particular mode. The compositor will attempt to change the output size to match the surface. The result is returned via the provided feedback object.

### Method
Request

### Interface
zwp_fullscreen_shell_v1

### Request
#### Arguments
- **surface** (object<wl_surface>) - Required - The surface to present.
- **output** (object<wl_output>) - Required - The output on which to present.
- **framerate** (int) - Required - Desired framerate in mHz; 0 indicates no preference.
- **feedback** (new_id<zwp_fullscreen_shell_mode_feedback_v1>) - Required - Feedback object for mode-switch result.

### Events
- **mode_successful** - Sent when the mode switch succeeds and the output contains the surface.
- **mode_failed** - Sent when the compositor cannot match the output size to the surface size.
- **present_cancelled** - Sent if another surface is presented before the operation completes.

### Errors
- **role** - Raised if the surface already has another role.

### Notes
- The surface gets the role of a fullscreen shell surface.
- The compositor may ignore the framerate parameter.
- No mode-switch operation is guaranteed to succeed.

## zwp_fullscreen_shell_v1::capability (event)

### Description
Advertises a single capability of the compositor. Emitted once for each capability when the interface is bound.

### Event
#### Arguments
- **capability** (uint<zwp_fullscreen_shell_v1.capability>) - Required - The advertised capability.

### Enum: zwp_fullscreen_shell_v1.capability
- **arbitrary_modes** (1) - Compositor is capable of almost any output mode.
- **cursor_plane** (2) - Compositor has a separate cursor plane.

### Notes
- Clients should use wl_display.sync after binding to ensure all capability events are received.

## zwp_fullscreen_shell_v1::present_method (enum)

### Description
Enumeration of presentation methods for the fullscreen shell.

### Values
- **default** - Default presentation method.
- **center** - Center the surface.
- **zoom** - Zoom the surface.
- **zoom_crop** - Zoom and crop the surface.
- **stretch** - Stretch the surface to fill the output.
```

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

### get_round_corner_radius

Source: https://wayland.app/protocols/treeland-personalization-manager-v1

Gets the window round corner radius.

```APIDOC
## get_round_corner_radius

### Description
Get window round corner radius.

### Method
get_round_corner_radius

### Request Example
```
get_round_corner_radius()
```

```

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

### wl_compositor::create_surface

Source: https://wayland.app/protocols/wayland

Creates a new surface through the compositor singleton.

```APIDOC
## wl_compositor::create_surface

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

### Method
Request

### Endpoint
wl_compositor::create_surface

### Parameters
#### Request Arguments
- **id** (new_id<wl_surface>) - Required - the new surface

### Response
No response body.

```

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

### treeland_output_manager_v1::get_color_control

Source: https://wayland.app/protocols/treeland-output-manager-v1

Get color control interface for output.

```APIDOC
## treeland_output_manager_v1::get_color_control

### Description
Get color control interface for output.

### Method
get_color_control

### Parameters
- **id** (new_id<treeland_output_color_control_v1>) - Required - 
- **output** (object<wl_output>) - Required - 

### Request Example
```
get_color_control(id: new_id<treeland_output_color_control_v1>, output: object<wl_output>)
```

```

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

### xdg_toplevel::show_window_menu

Source: https://wayland.app/protocols/wayland-protocols/535

Requests the compositor to show a window menu for the toplevel at the given position.

```APIDOC
## xdg_toplevel::show_window_menu

### Description
Requests the compositor to show a window menu for the toplevel at the given position. The menu is typically shown at the top-left corner of the toplevel, or at the pointer location if the seat has a pointer.

### Method
Request

### Request
```
show_window_menu(seat: object<wl_seat>, serial: uint, x: int, y: int)
```

### Parameters
#### Request Arguments
- **seat** (object<wl_seat>) - Required - The seat that the window menu should be shown for.
- **serial** (uint) - Required - The serial of the event that triggered the menu.
- **x** (int) - Required - The x position of the menu in surface-local coordinates.
- **y** (int) - Required - The y position of the menu in surface-local coordinates.

```

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

### get_font

Source: https://wayland.app/protocols/treeland-personalization-manager-v1

Gets the system font. This method takes no arguments.

```APIDOC
## get_font

### Description
Get the system font.

### Method
get_font

### Endpoint
treeland_personalization_font_context_v1::get_font

### Parameters
None

### Request Example
```
get_font()
```

```

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

### zwp_linux_buffer_params_v1

Source: https://wayland.app/protocols/linux-dmabuf-v1

Documentation for the zwp_linux_buffer_params_v1 interface, including the create, create_immed, and set_sampling_device requests.

```APIDOC
## zwp_linux_buffer_params_v1::create

### Description
Creates a wl_buffer from the added dmabuf buffers. The wl_buffer is not created immediately but returned via the 'created' event if the dmabuf sharing succeeds. The sharing may fail at runtime, in which case the 'failed' event is triggered.

### Method
Request

### Endpoint
zwp_linux_buffer_params_v1::create

### Parameters
#### Request Body
- **width** (int) - Required - Base plane width in pixels.
- **height** (int) - Required - Base plane height in pixels.
- **format** (uint) - Required - DRM_FORMAT code.
- **flags** (uint<zwp_linux_buffer_params_v1.flags>) - Required - See enum flags.

### Request Example
```
create(width: int, height: int, format: uint, flags: uint<zwp_linux_buffer_params_v1.flags>)
```

### Response
#### Success Response
- **created** event - The wl_buffer is created successfully.

#### Error Response
- **failed** event - The dmabuf sharing failed.
- **INCOMPLETE** protocol error - Argument errors.
- **INVALID_FORMAT** protocol error - Bad format.
- **INVALID_DIMENSIONS** protocol error - Non-positive width or height.
- **OUT_OF_BOUNDS** protocol error - Bad offset or stride.
- **ALREADY_USED** protocol error - Attempting to use this object after issuing 'create'.

## zwp_linux_buffer_params_v1::create_immed

### Description
Immediately creates a wl_buffer by importing the added dmabufs. In case of import success, no event is sent from the server, and the wl_buffer is ready to be used by the client. Upon import failure, the client may be terminated with fatal protocol errors or the server creates an invalid wl_buffer and sends a 'failed' event.

### Method
Request

### Endpoint
zwp_linux_buffer_params_v1::create_immed

### Parameters
#### Request Body
- **buffer_id** (new_id<wl_buffer>) - Required - ID for the newly created wl_buffer.
- **width** (int) - Required - Base plane width in pixels.
- **height** (int) - Required - Base plane height in pixels.
- **format** (uint) - Required - DRM_FORMAT code.
- **flags** (uint<zwp_linux_buffer_params_v1.flags>) - Required - See enum flags.

### Request Example
```
create_immed(buffer_id: new_id<wl_buffer>, width: int, height: int, format: uint, flags: uint<zwp_linux_buffer_params_v1.flags>)
```

### Response
#### Success Response
No event is sent; the wl_buffer is ready to use.

#### Error Response
- **INCOMPLETE** protocol error - Argument errors.
- **INVALID_FORMAT** protocol error - Bad format.
- **INVALID_DIMENSIONS** protocol error - Non-positive width or height.
- **OUT_OF_BOUNDS** protocol error - Bad offset or stride.
- **INVALID_WL_BUFFER** protocol error - Unknown or platform-specific cause.
- **failed** event - The server creates an invalid wl_buffer and marks it as failed.

## zwp_linux_buffer_params_v1::set_sampling_device

### Description
Sets the sampling device for the buffer. This request is available since version 6.

### Method
Request

### Endpoint
zwp_linux_buffer_params_v1::set_sampling_device

### Parameters
#### Request Body
- **device** (array) - Required - The sampling device.

### Request Example
```
set_sampling_device(device: array)
```

### Response
No response is defined in the source.
```

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

### wp_fifo_v1::set_barrier

Source: https://wayland.app/protocols/fifo-v1

Sets the start point for a fifo constraint on the surface.

```APIDOC
## wp_fifo_v1::set_barrier

### Description
Sets the start point for a fifo constraint. When the content update containing the "set_barrier" is applied, it sets a "fifo_barrier" condition on the surface associated with the fifo object. The condition is cleared immediately after the following latching deadline for non-tearing presentation.

### Method
Request

### Endpoint
wp_fifo_v1::set_barrier

### Parameters
None

### Request Example
```
set_barrier()
```

### Response
No response.

### Errors
- **surface_destroyed** (0) - The associated surface no longer exists. Generated if the fifo object's surface is destroyed before this request.

```

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

### get_monospace_font

Source: https://wayland.app/protocols/treeland-personalization-manager-v1

Gets the system monospace font. This method takes no arguments.

```APIDOC
## get_monospace_font

### Description
Get the system monospace font.

### Method
get_monospace_font

### Endpoint
treeland_personalization_font_context_v1::get_monospace_font

### Parameters
None

### Request Example
```
get_monospace_font()
```

```

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

### xwayland_shell_v1

Source: https://wayland.app/protocols/xwayland-shell-v1

The xwayland_shell_v1 interface provides a singleton global object that allows the Xwayland server to create xwayland_surface_v1 objects for given wl_surfaces. It includes a destructor and a request to create an xwayland_surface_v1.

```APIDOC
## xwayland_shell_v1::destroy

### Description
Destroys the xwayland_shell_v1 object. The child objects created via this interface are unaffected.

### Method
Destructor

### Request
```
destroy()
```

### Response
No response.

```

```APIDOC
## xwayland_shell_v1::get_xwayland_surface

### Description
Creates an xwayland_surface_v1 interface for a given wl_surface object and gives it the xwayland_surface role. It is illegal to create an xwayland_surface_v1 for a wl_surface which already has an assigned role, which will result in the `role` protocol error.

### Method
Request

### Request
```
get_xwayland_surface(id: new_id<xwayland_surface_v1>, surface: object<wl_surface>)
```

### Parameters
- **id** (new_id<xwayland_surface_v1>) - Required - The new xwayland_surface_v1 object.
- **surface** (object<wl_surface>) - Required - The wl_surface to assign the xwayland_surface role.

### Response
No response.

```

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

### get_font_size

Source: https://wayland.app/protocols/treeland-personalization-manager-v1

Gets the system font size. This method takes no arguments.

```APIDOC
## get_font_size

### Description
Get the system font size.

### Method
get_font_size

### Endpoint
treeland_personalization_font_context_v1::get_font_size

### Parameters
None

### Request Example
```
get_font_size()
```

```

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

### zwp_fullscreen_shell_v1

Source: https://wayland.app/protocols/fullscreen-shell-unstable-v1

The zwp_fullscreen_shell_v1 interface provides methods for presenting full-screen surfaces on outputs. It includes release, present_surface, and present_surface_for_mode requests.

```APIDOC
## zwp_fullscreen_shell_v1::release

### Description
Release the binding from the wl_fullscreen_shell interface. This destroys the server-side object and frees this binding. If the client binds to wl_fullscreen_shell multiple times, it may wish to free some of those bindings.

### Method
release

### Request
```
release()
```

### Parameters
None

### Response
None
```

```APIDOC
## zwp_fullscreen_shell_v1::present_surface

### Description
Present a surface on the given output. If the output is null, the compositor will present the surface on whatever display (or displays) it thinks best. The method parameter is a hint to the compositor for how the surface is to be presented. This request gives the surface the role of a fullscreen shell surface; if the surface already has another role, it raises a role protocol error.

### Method
present_surface

### Request
```
present_surface(surface: object<wl_surface>, method: uint<zwp_fullscreen_shell_v1.present_method>, output: object<wl_output>)
```

### Parameters
- **surface** (object<wl_surface>) - allow null - The surface to present.
- **method** (uint<zwp_fullscreen_shell_v1.present_method>) - Hint for how to handle size mismatch.
- **output** (object<wl_output>) - allow null - The output on which to present; if null, compositor chooses.

### Response
None
```

```APIDOC
## zwp_fullscreen_shell_v1::present_surface_for_mode

### Description
Present a surface for a specific mode on the given output. This request is used to present a surface with a specific framerate and mode. The feedback object is used to receive mode feedback.

### Method
present_surface_for_mode

### Request
```
present_surface_for_mode(surface: object<wl_surface>, output: object<wl_output>, framerate: int, feedback: new_id<zwp_fullscreen_shell_mode_feedback_v1>)
```

### Parameters
- **surface** (object<wl_surface>) - The surface to present.
- **output** (object<wl_output>) - The output on which to present.
- **framerate** (int) - The desired framerate.
- **feedback** (new_id<zwp_fullscreen_shell_mode_feedback_v1>) - The feedback object for mode information.

### Response
None
```

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

### zcosmic_output_manager_v1::get_configuration_head

Source: https://wayland.app/protocols/cosmic-output-management-unstable-v1

Gets a zcosmic_output_configuration_head_v1 extension object for an existing zwlr_output_configuration_head_v1.

```APIDOC
## zcosmic_output_manager_v1::get_configuration_head

### Description
Gets an extension object for zwlr_output_configuration_head_v1. Trying to create more than one zcosmic_output_configuration_head_v1 per zwlr_output_configuration_head_v1 will raise an "already_extended" error.

### Method
Request

### Endpoint
zcosmic_output_manager_v1::get_configuration_head

### Parameters
#### Request Arguments
- **extended** (new_id<zcosmic_output_configuration_head_v1>) - Required - The new zcosmic_output_configuration_head_v1 object.
- **config_head** (object<zwlr_output_configuration_head_v1>) - Required - The existing zwlr_output_configuration_head_v1 to extend.

### Request Example
```
zcosmic_output_manager_v1::get_configuration_head(extended: new_id<zcosmic_output_configuration_head_v1>, config_head: object<zwlr_output_configuration_head_v1>)
```

### Response
No direct response.
```

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

### zcosmic_output_manager_v1::get_configuration

Source: https://wayland.app/protocols/cosmic-output-management-unstable-v1

Gets a zcosmic_output_configuration_v1 extension object for an existing zwlr_output_configuration_v1.

```APIDOC
## zcosmic_output_manager_v1::get_configuration

### Description
Gets an extension object for zwlr_output_configuration_v1. Trying to create more than one zcosmic_output_configuration_v1 per zwlr_output_configuration_v1 will raise an "already_extended" error.

### Method
Request

### Endpoint
zcosmic_output_manager_v1::get_configuration

### Parameters
#### Request Arguments
- **extended** (new_id<zcosmic_output_configuration_v1>) - Required - The new zcosmic_output_configuration_v1 object.
- **config** (object<zwlr_output_configuration_v1>) - Required - The existing zwlr_output_configuration_v1 to extend.

### Request Example
```
zcosmic_output_manager_v1::get_configuration(extended: new_id<zcosmic_output_configuration_v1>, config: object<zwlr_output_configuration_v1>)
```

### Response
No direct response.
```

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

### org_kde_plasma_window::request_enter_virtual_desktop

Source: https://wayland.app/protocols/kde-plasma-window-management

Makes the window enter a virtual desktop.

```APIDOC
## org_kde_plasma_window::request_enter_virtual_desktop

### Description
Make the window enter a virtual desktop. A window can enter more than one virtual desktop. If the id is empty or invalid, no action will be performed. Available since version 8.

### Method
Request

### Interface
org_kde_plasma_window

### Arguments
- **id** (string) - Required - desktop id

### Request Example
```
request_enter_virtual_desktop(id: string)
```
```

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

### zwlr_output_configuration_v1::apply

Source: https://wayland.app/protocols/wlr-output-management-unstable-v1

Applies the new output configuration. The compositor will respond with a succeeded, failed, or cancelled event.

```APIDOC
## apply

### Description
Apply the new output configuration. In case the configuration is successfully applied, there is no guarantee that the new output state matches completely the requested configuration. For instance, a compositor might round the scale if it doesn't support fractional scaling. After this request has been sent, the compositor must respond with a succeeded, failed, or cancelled event. Sending a request that isn't the destructor is a protocol error.

### Method
Request

### Signature
```
apply()
```

```

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

### wl_data_device::start_drag

Source: https://wayland.app/protocols/wayland

Requests the compositor to start a drag-and-drop operation on behalf of the client.

```APIDOC
## [REQUEST] 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.

### Method
wl_data_device::start_drag

### Endpoint
wl_data_device::start_drag

### Parameters
#### Request Body
- **source** (object<wl_data_source>, allow null) - Required - data source for the eventual transfer
- **origin** (object<wl_surface>) - Required - surface where the drag originates
- **icon** (object<wl_surface>, allow null) - Required - drag-and-drop icon surface
- **serial** (uint) - Required - serial number of the implicit grab on the origin

### Request Example
```
start_drag(source: object<wl_data_source>, origin: object<wl_surface>, icon: object<wl_surface>, serial: uint)
```

### Response
No response is specified for this request.
```

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

### apply

Source: https://wayland.app/protocols/kde-output-management

Asks the server to apply property changes requested through this outputconfiguration object to all outputs on the server side.

```APIDOC
## apply

### Description
Asks the server to apply property changes requested through this outputconfiguration object to all outputs on the server side.

### Method
apply

### Request
No arguments.

```

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

### zaura_toplevel::set_float_to_location

Source: https://wayland.app/protocols/aura-shell

Request to set the float start location for the toplevel surface.

```APIDOC
## zaura_toplevel::set_float_to_location

### Description
Hints to the window manager that the toplevel surface should not be enter fullscreen. Note that the window manager might still request the client enter fullscreen. In such an event, the client should respect the window manager's request and enter fullscreen. It may exit fullscreen afterwards.

### Method
Request

### Endpoint
zaura_toplevel::set_float_to_location

### Parameters
#### Request Body
- **mode** (uint<zaura_toplevel.float_start_location>) - Required - 

### Request Example
```
set_float_to_location(mode: uint<zaura_toplevel.float_start_location>)
```

### Response
No response specified.
```

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

### tizen_launch_image::show

Source: https://wayland.app/protocols/tizen-extension

Shows the launch image.

```APIDOC
## tizen_launch_image::show

### Description
Shows the launch image.

### Method
show

```

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

### tizen_policy::get_supported_aux_hints

Source: https://wayland.app/protocols/tizen-extension

Get the ids of the aux hints which the given surface supports.

```APIDOC
## tizen_policy::get_supported_aux_hints

### Description
Get the ids of the aux hints which the given surface supports. The display server sends the supported_aux_hints events as the reply of this request.

### Method
Request

### Interface
tizen_policy

### Parameters
- **surface** (object<wl_surface>) - Required - The surface object

### Request Example
```
get_supported_aux_hints(surface: object<wl_surface>)
```
```

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

### agl_shell_desktop::activate_app

Source: https://wayland.app/protocols/agl-shell-desktop

Asks the compositor to make a toplevel window the current/focused window for window management purposes.

```APIDOC
## agl_shell_desktop::activate_app

### Description
Ask the compositor to make a toplevel to become the current/focused window for window management purposes.

### Method
activate_app

### Parameters
- **app_id** (string) - Required - The application identifier.
- **app_data** (string, allow null) - Required - Additional data.
- **output** (object<wl_output>) - Required - The output object.

### Notes
See xdg_toplevel.set_app_id from the xdg-shell protocol for a description of app_id.
```

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

### tizen_policy::get_subsurface

Source: https://wayland.app/protocols/tizen-extension

Get the subsurface of the given surface with the global resource parent_id.

```APIDOC
## tizen_policy::get_subsurface

### Description
Get the subsurface of the given surface with the global resource parent_id.

### Method
Request

### Interface
tizen_policy

### Parameters
- **id** (new_id<wl_subsurface>) - Required - The new subsurface object
- **surface** (object<wl_surface>) - Required - The surface object
- **parent_id** (uint) - Required - The global resource id

### Request Example
```
get_subsurface(id: new_id<wl_subsurface>, surface: object<wl_surface>, parent_id: uint)
```
```

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

### xdg_toplevel::resize

Source: https://wayland.app/protocols/wayland-protocols/534

Starts an interactive resize of the surface, specifying which edge or corner is being dragged.

```APIDOC
## xdg_toplevel::resize

### Description
Starts a user-driven, interactive resize of the surface. This request must be used in response to a user action such as a button press, key press, or touch down event. The passed serial is used to determine the type of interactive resize (touch, pointer, etc).

### Method
resize

### Parameters
- **seat** (object<wl_seat>) - Required - The wl_seat of the user event.
- **serial** (uint) - Required - The serial of the user event.
- **edges** (uint<xdg_toplevel.resize_edge>) - Required - Which edge or corner is being dragged.

### Request Example
```
resize(seat, serial, edges)
```
```

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

### xdg_toplevel::resize

Source: https://wayland.app/protocols/wayland-protocols/535

Start a user-driven, interactive resize of the surface. This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive resize (touch, pointer, etc).

```APIDOC
## xdg_toplevel::resize

### Description
Start a user-driven, interactive resize of the surface. This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive resize (touch, pointer, etc). The server may ignore the request depending on surface state. The edges parameter specifies the edge or corner being dragged.

### Method
Request

### Endpoint
xdg_toplevel::resize

### Parameters
- **seat** (object<wl_seat>) - Required - the wl_seat of the user event
- **serial** (uint) - Required - the serial of the user event
- **edges** (uint<xdg_toplevel.resize_edge>) - Required - which edge or corner is being dragged

### Request Example
```
resize(seat: object<wl_seat>, serial: uint, edges: uint<xdg_toplevel.resize_edge>)
```

### Response
If triggered, the client will receive configure events with the "resize" state enum value and expected sizes. The client must acknowledge configure events using "ack_configure". After resize is completed, another "configure" event without the resize state is sent. The surface loses focus of the device used.
```

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

### river_seat_v1::op_delta

Source: https://wayland.app/protocols/river-window-management-v1

Event sent to indicate total cumulative motion since the start of an operation.

```APIDOC
## river_seat_v1::op_delta

### Description
This event indicates the total change in position since the start of the operation of the pointer/touch point/etc.

### Event
op_delta

### Arguments
- **dx** (int) - Total change in x.
- **dy** (int) - Total change in y.

### Notes
This event will be followed by a manage_start event after all other new state has been sent by the server.
```
Tokens:
Raw