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

#[non_exhaustive]
pub enum Request<'a> {
    GetLayerSurface {
        surface: WlSurface,
        output: Option<WlOutput>,
        layer: WEnum<Layer>,
        namespace: String,
    },
    Destroy,
}

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.

GetLayerSurface

create a layer_surface from a surface

Create a layer surface for an existing surface. This assigns the role of layer_surface, or raises a protocol error if another role is already assigned.

Creating a layer surface from a wl_surface which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first layer_surface.configure call must also be treated as errors.

After creating a layer_surface object and setting it up, the client must perform an initial commit without any buffer attached. The compositor will reply with a layer_surface.configure event. The client must acknowledge it and is then allowed to attach a buffer to map the surface.

You may pass NULL for output to allow the compositor to decide which output to use. Generally this will be the one that the user most recently interacted with.

Clients can specify a namespace that defines the purpose of the layer surface.

Fields

surface: WlSurface

output: Option<WlOutput>

layer: WEnum<Layer>

layer to add this surface to

namespace: String

namespace for the layer surface

Destroy

destroy the layer_shell object

This request indicates that the client will not use the layer_shell object any more. Objects that have been created through this instance are not affected.

This is a destructor, once sent this object cannot be used any longer. Only available since version 3 of the interface

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.