Module layer_shell 

Layer Shell Protocol (zwlr_layer_shell_v1)

Provides surfaces anchored to screen edges for panels, notifications, screen locks, and overlays. Based on wlr-layer-shell-unstable-v1.

Layer surfaces are positioned relative to the output edges using anchor flags and can claim exclusive zones that reduce the usable area for normal windows. The rendering order from bottom to top is:

Background -> Bottom -> Top -> Overlay

This ensures that overlay surfaces (screen locks) always appear above everything, while background surfaces (wallpaper) sit behind all windows.

Structs

Anchor

Anchor edges for layer surface positioning.

LayerShellManager

Layer shell manager.

LayerSurface

Layer surface configuration.

UsableArea

Usable screen area after exclusive zones are subtracted.

Enums

KeyboardInteractivity

Keyboard interactivity mode for layer surfaces.

Layer

Layer shell layers (bottom to top rendering order).

Constants

ZWLR_LAYER_SHELL_V1

Wayland global interface name for layer shell

ZWLR_LAYER_SHELL_V1_DESTROY

destroy

ZWLR_LAYER_SHELL_V1_GET_LAYER_SURFACE

get_layer_surface(id, surface, output, layer, namespace)

ZWLR_LAYER_SHELL_V1_VERSION

Protocol version

ZWLR_LAYER_SURFACE_V1_ACK_CONFIGURE

ack_configure(serial)

ZWLR_LAYER_SURFACE_V1_CLOSED

closed

ZWLR_LAYER_SURFACE_V1_CONFIGURE

configure(serial, width, height)

ZWLR_LAYER_SURFACE_V1_DESTROY

destroy

ZWLR_LAYER_SURFACE_V1_GET_POPUP

get_popup(popup)

ZWLR_LAYER_SURFACE_V1_SET_ANCHOR

set_anchor(anchor)

ZWLR_LAYER_SURFACE_V1_SET_EXCLUSIVE_ZONE

set_exclusive_zone(zone)

ZWLR_LAYER_SURFACE_V1_SET_KEYBOARD_INTERACTIVITY

set_keyboard_interactivity(mode)

ZWLR_LAYER_SURFACE_V1_SET_LAYER

set_layer(layer) – since version 2

ZWLR_LAYER_SURFACE_V1_SET_MARGIN

set_margin(top, right, bottom, left)

ZWLR_LAYER_SURFACE_V1_SET_SIZE

set_size(width, height)