Struct LayerShellOptions 

pub struct LayerShellOptions {
    pub namespace: String,
    pub layer: Layer,
    pub anchor: Anchor,
    pub exclusive_zone: Option<Pixels>,
    pub exclusive_edge: Option<Anchor>,
    pub margin: Option<(Pixels, Pixels, Pixels, Pixels)>,
    pub keyboard_interactivity: KeyboardInteractivity,
}

Configures a Wayland layer-shell surface, such as a panel, dock, or wallpaper.

Set this on WindowKind::LayerShell when you open a window. Chain setters on LayerShellOptions::default to configure the surface. Pass None to clear the exclusive zone, exclusive edge, or margins.

The compositor applies the namespace, layer, anchor and margins. Opening the window fails with LayerShellNotSupportedError when the compositor doesn’t support the layer-shell protocol. Layer shell exists only on Wayland, so this module is available only on Linux builds with the wayland feature.

Examples

use gpui::{
    layer_shell::{Anchor, KeyboardInteractivity, Layer, LayerShellOptions},
    px,
};

// A 40 px bar along the bottom edge, stretched across the screen.
let options = LayerShellOptions::default()
    .namespace("panel")
    .layer(Layer::Top)
    .anchor(Anchor::LEFT | Anchor::RIGHT | Anchor::BOTTOM)
    .exclusive_zone(px(40.0))
    .keyboard_interactivity(KeyboardInteractivity::None);

assert_eq!(options.namespace, "panel");
assert_eq!(options.layer, Layer::Top);
assert_eq!(options.exclusive_zone, Some(px(40.0)));

Fields

namespace: String

The namespace for the surface, mostly used by compositors to apply rules, can not be changed after the surface is created.

layer: Layer

The layer the surface is rendered on.

anchor: Anchor

The anchor point of the surface.

exclusive_zone: Option<Pixels>

Requests that the compositor avoids occluding an area with other surfaces.

exclusive_edge: Option<Anchor>

The anchor point of the exclusive zone, will be determined using the anchor if left unspecified.

margin: Option<(Pixels, Pixels, Pixels, Pixels)>

Margins between the surface and its anchor point(s). Specified in CSS order: top, right, bottom, left.

keyboard_interactivity: KeyboardInteractivity

How keyboard events should be delivered to the surface.

Implementations

impl LayerShellOptions

pub fn namespace(self, value: impl Into<String>) -> Self

Sets the namespace field of this struct.

pub fn layer(self, value: impl Into<Layer>) -> Self

Sets the layer field of this struct.

pub fn anchor(self, value: impl Into<Anchor>) -> Self

Sets the anchor field of this struct.

pub fn exclusive_zone(self, value: impl Into<Option<Pixels>>) -> Self

Sets the exclusive_zone field of this struct.

pub fn exclusive_edge(self, value: impl Into<Option<Anchor>>) -> Self

Sets the exclusive_edge field of this struct.

pub fn margin( self, value: impl Into<Option<(Pixels, Pixels, Pixels, Pixels)>>, ) -> Self

Sets the margin field of this struct.

pub fn keyboard_interactivity( self, value: impl Into<KeyboardInteractivity>, ) -> Self

Sets the keyboard_interactivity field of this struct.

Trait Implementations

impl Clone for LayerShellOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LayerShellOptions

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

Formats the value using the given formatter.

impl Default for LayerShellOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for LayerShellOptions

impl FluentBuilder for LayerShellOptions

fn map<U>(self, f: impl FnOnce(Self) -> U) -> U

where Self: Sized,

Passes self to f, and returns the result. Use it to continue a chain with a closure.

fn when(self, condition: bool, then: impl FnOnce(Self) -> Self) -> Self

where Self: Sized,

Calls then with self if condition is true. Otherwise returns self unchanged.

fn when_else( self, condition: bool, then: impl FnOnce(Self) -> Self, else_fn: impl FnOnce(Self) -> Self, ) -> Self

where Self: Sized,

Calls then with self if condition is true, and else_fn with self otherwise.

fn when_some<T>( self, option: Option<T>, then: impl FnOnce(Self, T) -> Self, ) -> Self

where Self: Sized,

Calls then with self and the value inside option if the option is Some. Returns self unchanged for None.

fn when_none<T>( self, option: &Option<T>, then: impl FnOnce(Self) -> Self, ) -> Self

where Self: Sized,

Calls then with self if option is None. The option is taken by reference, so you can still use it afterward.

impl PartialEq for LayerShellOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LayerShellOptions