Skip to content

wl_shell¤

wayland.wl_shell ¤

Create desktop-style surfaces

This interface is implemented by servers that provide desktop-style user interfaces.

It allows clients to associate a wl_shell_surface 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.

Methods:

error ¤

  • role
    Given `wl_surface` has another role

get_shell_surface ¤

get_shell_surface(surface: wl_surface) -> wl_shell_surface

Create a shell surface from a surface

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.

Parameters:

  • surface ¤

    (wl_surface) –

    Surface to be given the shell surface role

Returns: