Canvas (`canvas`)

A canvas is an element that can be drawn on.

The canvas accepts no children.

The canvas should be manipulated in Rust code:

The element will consume all available space and expand to fit inside the parent.

Hot reloading will clear the canvas as the cells are not stored as state. Since components (but not prototype components) are restored upon hot reloading it is possible to save the buffer from the canvas to the component using canvas.take_buffer() using unmount on the component, and to restore it using mount.

restore, take buffer

Example

#![allow(unused)]
fn main() {
use anathema::backend::tui::{Color, Style};

fn on_key(
    &mut self,
    key: KeyEvent,
    state: &mut Self::State,
    elements: Elements<'_, '_>,
) {
    let mut style = Style::reset();
    style.fg = Some(Color::Red);

    elements.by_tag("canvas").first(|el, _| {
        let canvas = el.to::<Canvas>();
        canvas.put('a', style, (0, 0));
        canvas.put('b', style, (1, 1));
        canvas.put('c', style, (2, 2));
    });
}
}

border [width: 16, height: 5]
    canvas

┌──────────────┐
│ a            │
│  b           │
│   c          │
└──────────────┘

Attributes

`width`

`height`

Methods

`erase(pos: impl Into<LocalPos>)`

Erase a character at a given position in local canvas space

`get(pos: impl Into<LocalPos>) -> Option<(&mut char, &mut CanvasAttribs)>`

Get a mutable reference to the character and attributes at a given position.

`put(c: char, style: Style, pos: LocalPos)`

Put a character with a style at a given position.

`translate(pos: Pos) -> LocalPos`

Translate global coords to local (to the canvas) coords.

`clear()`

Clear the canvas

`take_buffer()`

Remove the buffer from the canvas

`restore(buffer)`

Sets a buffer to the canvas

Anathema