Skip to content

xwayland_shell_v1¤

wayland.xwayland_shell_v1 ¤

Context object for xwayland shell

xwayland_shell_v1 is a singleton global object that provides the ability to create a xwayland_surface_v1 object for a given wl_surface.

This interface is intended to be bound by the Xwayland server.

A compositor must not allow clients other than Xwayland to bind to this interface. A compositor should hide this global from other clients' wl_registry. A client the compositor does not consider to be an Xwayland server attempting to bind this interface will result in an implementation-defined error.

An Xwayland server that has bound this interface must not set the WL_SURFACE_ID atom on a window.

Methods:

error ¤

  • role
    Given `wl_surface` has another role

destroy ¤

destroy() -> None

Destroy the xwayland shell object

Destroy the xwayland_shell_v1 object.

The child objects created via this interface are unaffected.

get_xwayland_surface ¤

get_xwayland_surface(surface: wl_surface) -> xwayland_surface_v1

Assign the xwayland_surface surface role

Create 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 and this will result in the role protocol error.

See the documentation of xwayland_surface_v1 for more details about what an xwayland_surface_v1 is and how it is used.

Returns: