Struct andiskaz::screen::Screen

pub struct Screen<'terminal> { /* private fields */ }

A locked screen terminal with exclusive access to it. With this struct, a locked screen handle, one can execute many operations without locking and unlocking.

Implementations

impl<'terminal> Screen<'terminal>

pub fn size(&self) -> Vec2

Returns the current size of the screen.

pub fn valid_size(&self) -> bool

Returns whether the stored size is the actual size and the actual size is valid.

pub fn min_size(&self) -> Vec2

Returns the minimum size required for the screen.

pub fn set<T>(&mut self, point: Vec2, updater: T)where T: Updater,

Applies an update function to a Tile. An update function gets access to a mutable reference of a Tile, updates it, and then the screen handles any changes made to it. A regular Tile can be used as an updater, in which the case a simple replacement is made. This operation is buffered.

pub fn get(&self, point: Vec2) -> &Tile

Gets the attributes of a given Tile, regardless of being flushed to the screen yet or not.

pub fn clear(&mut self, background: Color)

Sets every Tile into a whitespace grapheme with the given color.

pub fn styled_text<C>(&mut self, tstring: &TermString, style: Style<C>) -> Coordwhere C: Updater,

Prints a grapheme-encoded text (a TermString) using some style options like ratio to the screen, color, margin and others. See Style.

Trait Implementations

impl<'terminal> Debug for Screen<'terminal>

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

Formats the value using the given formatter.