Enum wayland_protocols_wlr::layer_shell::v1::generated::client::zwlr_layer_surface_v1::Request

#[non_exhaustive]
pub enum Request<'a> {
    SetSize {
        width: u32,
        height: u32,
    },
    SetAnchor {
        anchor: WEnum<Anchor>,
    },
    SetExclusiveZone {
        zone: i32,
    },
    SetMargin {
        top: i32,
        right: i32,
        bottom: i32,
        left: i32,
    },
    SetKeyboardInteractivity {
        keyboard_interactivity: WEnum<KeyboardInteractivity>,
    },
    GetPopup {
        popup: XdgPopup,
    },
    AckConfigure {
        serial: u32,
    },
    Destroy,
    SetLayer {
        layer: WEnum<Layer>,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SetSize

sets the size of the surface

Sets the size of the surface in surface-local coordinates. The compositor will display the surface centered with respect to its anchors.

If you pass 0 for either value, the compositor will assign it and inform you of the assignment in the configure event. You must set your anchor to opposite edges in the dimensions you omit; not doing so is a protocol error. Both values are 0 by default.

Size is double-buffered, see wl_surface.commit.

Fields

width: u32

height: u32

SetAnchor

configures the anchor point of the surface

Requests that the compositor anchor the surface to the specified edges and corners. If two orthogonal edges are specified (e.g. ‘top’ and ‘left’), then the anchor point will be the intersection of the edges (e.g. the top left corner of the output); otherwise the anchor point will be centered on that edge, or in the center if none is specified.

Anchor is double-buffered, see wl_surface.commit.

Fields

anchor: WEnum<Anchor>

SetExclusiveZone

configures the exclusive geometry of this surface

Requests that the compositor avoids occluding an area with other surfaces. The compositor’s use of this information is implementation-dependent - do not assume that this region will not actually be occluded.

A positive value is only meaningful if the surface is anchored to one edge or an edge and both perpendicular edges. If the surface is not anchored, anchored to only two perpendicular edges (a corner), anchored to only two parallel edges or anchored to all edges, a positive value will be treated the same as zero.

A positive zone is the distance from the edge in surface-local coordinates to consider exclusive.

Surfaces that do not wish to have an exclusive zone may instead specify how they should interact with surfaces that do. If set to zero, the surface indicates that it would like to be moved to avoid occluding surfaces with a positive exclusive zone. If set to -1, the surface indicates that it would not like to be moved to accommodate for other surfaces, and the compositor should extend it all the way to the edges it is anchored to.

For example, a panel might set its exclusive zone to 10, so that maximized shell surfaces are not shown on top of it. A notification might set its exclusive zone to 0, so that it is moved to avoid occluding the panel, but shell surfaces are shown underneath it. A wallpaper or lock screen might set their exclusive zone to -1, so that they stretch below or over the panel.

The default value is 0.

Exclusive zone is double-buffered, see wl_surface.commit.

Fields

zone: i32

SetMargin

sets a margin from the anchor point

Requests that the surface be placed some distance away from the anchor point on the output, in surface-local coordinates. Setting this value for edges you are not anchored to has no effect.

The exclusive zone includes the margin.

Margin is double-buffered, see wl_surface.commit.

Fields

top: i32

right: i32

bottom: i32

left: i32

SetKeyboardInteractivity

requests keyboard events

Set how keyboard events are delivered to this surface. By default, layer shell surfaces do not receive keyboard events; this request can be used to change this.

This setting is inherited by child surfaces set by the get_popup request.

Layer surfaces receive pointer, touch, and tablet events normally. If you do not want to receive them, set the input region on your surface to an empty region.

Keyboard interactivity is double-buffered, see wl_surface.commit.

Fields

keyboard_interactivity: WEnum<KeyboardInteractivity>

GetPopup

assign this layer_surface as an xdg_popup parent

This assigns an xdg_popup’s parent to this layer_surface. This popup should have been created via xdg_surface::get_popup with the parent set to NULL, and this request must be invoked before committing the popup’s initial state.

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

Fields

popup: XdgPopup

AckConfigure

ack a configure event

When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event.

If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event.

A client is not required to commit immediately after sending an ack_configure request - it may even ack_configure several times before its next surface commit.

A client may send multiple ack_configure requests before committing, but only the last request sent before a commit indicates which configure event the client really is responding to.

Fields

serial: u32

the serial from the configure event

Destroy

destroy the layer_surface

This request destroys the layer surface.

This is a destructor, once sent this object cannot be used any longer.

SetLayer

change the layer of the surface

Change the layer that the surface is rendered on.

Layer is double-buffered, see wl_surface.commit.

Only available since version 2 of the interface

Fields

layer: WEnum<Layer>

layer to move this surface to

Implementations

impl<'a> Request<'a>

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.