Struct Layer 

pub struct Layer {
    pub components: Vec<Box<dyn Component>>,
    pub layout: Option<Layout>,
    pub shadow: Shadow,
    pub visible: bool,
    pub kind: LayerKind,
}

A full-terminal-size surface that holds its own components and layout.

Layers stack from index 0 (bottom/floor) to N (top/front). The TUI renders each layer independently and then composites them front-to-back, stripping cells that are hidden by higher layers.

Fields

components: Vec<Box<dyn Component>>

Components owned by this layer.

layout: Option<Layout>

Optional layout for splitting the layer among its components.

shadow: Shadow

Visual effect applied to lower layers behind this layer.

visible: bool

Whether this layer participates in rendering.

kind: LayerKind

TUI classification of this layer.

Implementations

impl Layer

pub fn new() -> Self

Create a new empty layer.

pub fn with_component(component: Box<dyn Component>) -> Self

Create a layer that already contains a single component.

pub fn set_layout(&mut self, layout: Layout)

Assign a layout to this layer.

pub fn mount(&mut self, component: Box<dyn Component>)

Append a component to this layer.

pub fn with_kind(self, kind: LayerKind) -> Self

Set the layer kind.

pub fn render( &self, width: u16, height: u16, focused_index: Option<usize>, ) -> Rendered

Render this layer to a full-terminal-size buffer.

The returned Rendered has exactly height lines. focused_index identifies which of this layer’s components currently has focus so that its cursor can be translated into screen coordinates.

Trait Implementations

impl Default for Layer

fn default() -> Layer

Returns the “default value” for a type.