Struct LayerSurface

pub struct LayerSurface { /* private fields */ }

Available on crate feature wayland_frontend only.

A handle to a layer surface

Implementations

impl LayerSurface

pub fn alive(&self) -> bool

Checks if the surface is still alive

pub fn send_pending_configure(&self) -> Option<Serial>

Send a pending configure event to this layer surface to suggest it a new configuration

If changes have occurred a configure event will be send to the clients and the serial will be returned (for tracking the configure in WlrLayerShellHandler::ack_configure if desired). If no changes occurred no event will be send and None will be returned.

See send_configure and has_pending_changes for more information.

pub fn send_configure(&self) -> Serial

Send a configure event to this layer surface to suggest it a new configuration

The serial of this configure will be tracked waiting for the client to ACK it.

You can manipulate the state that will be sent to the client with the with_pending_state method.

Note: This will always send a configure event, if you intend to only send a configure event on changes take a look at send_pending_configure

pub fn ensure_configured(&self) -> bool

Make sure this surface was configured

Returns true if it was, if not, returns false and raise a protocol error to the associated layer surface. Also returns false if the surface is already destroyed.

pub fn send_close(&self)

Send a “close” event to the client

pub fn wl_surface(&self) -> &WlSurface

Access the underlying wl_surface of this layer surface

Returns None if the layer surface actually no longer exists.

pub fn with_pending_state<F, T>(&self, f: F) -> T

where F: FnOnce(&mut LayerSurfaceState) -> T,

Allows the pending state of this layer to be manipulated.

This should be used to inform the client about size and state changes, for example after a resize request from the client.

The state will be sent to the client when calling send_configure.

pub fn has_pending_changes(&self) -> bool

Tests this LayerSurface for pending changes

Returns true if with_pending_state was used to manipulate the state and resulted in a different state or if the initial configure is still pending.

pub fn current_state(&self) -> LayerSurfaceState

Gets a copy of the current state of this layer

Returns None if the underlying surface has been destroyed

pub fn shell_surface(&self) -> &ZwlrLayerSurfaceV1

Access the underlying zwlr_layer_surface_v1 of this layer surface

Trait Implementations

impl Clone for LayerSurface

fn clone(&self) -> LayerSurface

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LayerSurface

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for LayerSurface

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.