Struct tuig_ui::Screen

pub struct Screen { /* private fields */ }

A text framebuffer.

Allows you to render things onto it, then can be rendered onto the screen. This strategy avoids flickering, partial renders, etc. and helps deduplicate rendering effort.

Implementations

impl Screen

pub fn new(size: XY) -> Screen

Create a new Screen in the given size.

pub fn size(&self) -> XY

How big this Screen is, in characters.

pub fn cells(&self) -> &[Cell]

All of the cells of this screen, in row-major order.

i.e. for the screen:

1 2
3 4

this will return &[1, 2, 3, 4].

pub fn cells_mut(&mut self) -> &mut [Cell]

All of the cells of this screen, in row-major order, mutably.

pub fn rows(&self) -> impl Iterator<Item = &[Cell]>

Returns an iterator over the rows in a screen.

pub fn clear(&mut self)

Clear this screen’s contents, resetting it to the default and filling it with blank cells.

pub fn resize(&mut self, size: XY)

Resize the screen, clearing its contents at the same time. Does not reallocate unless the screen is growing.

pub fn write(&mut self, pos: XY, text: Vec<Text>)

Write some formatted text to the position on screen.

This does not handle newlines or anything else. If you want that, use a UI widget.

Trait Implementations

impl Clone for Screen

fn clone(&self) -> Screen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Screen

fn default() -> Screen

Returns the “default value” for a type.

impl Index<usize> for Screen

type Output = [Cell]

The returned type after indexing.

fn index(&self, row: usize) -> &<Screen as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Screen

fn index_mut(&mut self, row: usize) -> &mut <Screen as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq for Screen

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Screen

impl StructuralEq for Screen

impl StructuralPartialEq for Screen