Enum smithay::wayland::shell::legacy::ShellSurfaceKind

pub enum ShellSurfaceKind {
    Toplevel,
    Transient {
        parent: WlSurface,
        location: Point<i32, Logical>,
        inactive: bool,
    },
    Fullscreen {
        method: FullscreenMethod,
        framerate: u32,
        output: Option<WlOutput>,
    },
    Popup {
        parent: WlSurface,
        serial: Serial,
        inactive: bool,
        location: Point<i32, Logical>,
        seat: WlSeat,
    },
    Maximized {
        output: Option<WlOutput>,
    },
}

Possible kinds of shell surface of the wl_shell protocol

Variants

Toplevel

Toplevel, a regular window displayed somewhere in the compositor space

Transient

Transient, this surface has a parent surface

These are sub-windows of an application (for example a configuration window), and as such should only be visible in their parent window is, and on top of it.

Fields of Transient

parent: WlSurface

The surface considered as parent

location: Point<i32, Logical>

Location relative to the parent

inactive: bool

Weather this window should be marked as inactive

Fullscreen

Fullscreen surface, covering an entire output

Fields of Fullscreen

method: FullscreenMethod

Method used for fullscreen

framerate: u32

Framerate (relevant only for driver fullscreen)

output: Option<WlOutput>

Requested output if any

Popup

A popup surface

Short-lived surface, typically referred as “tooltips” in many contexts.

Fields of Popup

parent: WlSurface

The parent surface of this popup

serial: Serial

The serial of the input event triggering the creation of this popup

inactive: bool

Weather this popup should be marked as inactive

location: Point<i32, Logical>

Location of the popup relative to its parent

seat: WlSeat

Seat associated this the input that triggered the creation of the popup. Used to define when the “popup done” event is sent.

Maximized

A maximized surface

Like a toplevel surface, but as big as possible on a single output while keeping any relevant desktop-environment interface visible.

Fields of Maximized

output: Option<WlOutput>

Requested output for maximization

Trait Implementations

impl Debug for ShellSurfaceKind

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

Formats the value using the given formatter.