Struct tuig_iosys::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) -> Self

Create a new Screen in the given size.

Examples found in repository

examples/list-actions.rs (line 7)

fn list_events(mut sys: Box<dyn IoSystem>) {
    let mut log = vec!["press escape to exit when you're done".to_owned()];
    let mut screen = Screen::new(sys.size());
    loop {
        screen.resize(sys.size());
        for (line, row) in log.iter().rev().zip((0..screen.size().y()).rev()) {
            for (char, col) in line.chars().zip(0..screen.size().x()) {
                screen[row][col] = Cell::of(char);
            }
        }
        sys.draw(&screen).expect("failed to render screen");
        match sys.input().expect("failed to get input") {
            Action::Closed | Action::KeyPress { key: Key::Escape } => break,
            Action::Error(e) => panic!("{1}: {:?}", e, "got an error for input"),
            other => log.push(format!("{:?}", other)),
        }
        if log.len() > screen.size().y() {
            let diff = log.len() - screen.size().y();
            log.drain(..diff);
        }
    }
    sys.stop();
}

examples/color-demo.rs (line 31)

fn color_demo(mut sys: Box<dyn IoSystem>) {
    let color_width = Color::all()
        .into_iter()
        .map(|c| format!("{:?}", c).len())
        .max()
        .unwrap();

    let mut lines: Vec<Vec<Cell>> = Color::all()
        .into_iter()
        .map(|bg| {
            let mut line = vec![];
            for fg in Color::all() {
                let text = format!("{:?} on {1:<2$} ", fg, format!("{:?}", bg), color_width);
                line.extend(text.chars().map(move |c| Cell::of(c).fg(fg).bg(bg)));
            }
            line
        })
        .collect();
    let width: usize = lines.iter().map(|l| l.len()).max().unwrap() + 5;
    for line in &mut lines {
        let bg = line[0].get_fmt().bg;
        line.extend(repeat(Cell::of(' ').bg(bg)).take(width - line.len()));
    }
    let mut screen = Screen::new(XY(0, 0));
    let mut pos = 0;
    let mut moving = true;
    'main: loop {
        while let Some(action) = sys.poll_input().unwrap() {
            match action {
                Action::Closed | Action::KeyPress { key: Key::Escape } => break 'main,
                Action::KeyPress {
                    key: Key::Char(' '),
                } => moving = !moving,
                _ => (),
            }
        }
        if moving || sys.size() != screen.size() {
            screen.resize(sys.size());
            for row in 0..screen.size().y() {
                let o_row = (row + pos) % lines.len();
                for col in 0..screen.size().x() {
                    let o_col = (col + pos * 3) % width;
                    screen[row][col] = lines[o_row][o_col].clone();
                }
            }
            sys.draw(&screen).expect("failed to render screen");
        }
        if moving {
            pos += 1;
            thread::sleep(Duration::from_millis(250));
        } else {
            thread::sleep(Duration::from_millis(50));
        }
    }
    sys.stop();
}

pub fn size(&self) -> XY

How big this Screen is, in characters.

Examples found in repository

examples/list-actions.rs (line 10)

fn list_events(mut sys: Box<dyn IoSystem>) {
    let mut log = vec!["press escape to exit when you're done".to_owned()];
    let mut screen = Screen::new(sys.size());
    loop {
        screen.resize(sys.size());
        for (line, row) in log.iter().rev().zip((0..screen.size().y()).rev()) {
            for (char, col) in line.chars().zip(0..screen.size().x()) {
                screen[row][col] = Cell::of(char);
            }
        }
        sys.draw(&screen).expect("failed to render screen");
        match sys.input().expect("failed to get input") {
            Action::Closed | Action::KeyPress { key: Key::Escape } => break,
            Action::Error(e) => panic!("{1}: {:?}", e, "got an error for input"),
            other => log.push(format!("{:?}", other)),
        }
        if log.len() > screen.size().y() {
            let diff = log.len() - screen.size().y();
            log.drain(..diff);
        }
    }
    sys.stop();
}

examples/color-demo.rs (line 44)

fn color_demo(mut sys: Box<dyn IoSystem>) {
    let color_width = Color::all()
        .into_iter()
        .map(|c| format!("{:?}", c).len())
        .max()
        .unwrap();

    let mut lines: Vec<Vec<Cell>> = Color::all()
        .into_iter()
        .map(|bg| {
            let mut line = vec![];
            for fg in Color::all() {
                let text = format!("{:?} on {1:<2$} ", fg, format!("{:?}", bg), color_width);
                line.extend(text.chars().map(move |c| Cell::of(c).fg(fg).bg(bg)));
            }
            line
        })
        .collect();
    let width: usize = lines.iter().map(|l| l.len()).max().unwrap() + 5;
    for line in &mut lines {
        let bg = line[0].get_fmt().bg;
        line.extend(repeat(Cell::of(' ').bg(bg)).take(width - line.len()));
    }
    let mut screen = Screen::new(XY(0, 0));
    let mut pos = 0;
    let mut moving = true;
    'main: loop {
        while let Some(action) = sys.poll_input().unwrap() {
            match action {
                Action::Closed | Action::KeyPress { key: Key::Escape } => break 'main,
                Action::KeyPress {
                    key: Key::Char(' '),
                } => moving = !moving,
                _ => (),
            }
        }
        if moving || sys.size() != screen.size() {
            screen.resize(sys.size());
            for row in 0..screen.size().y() {
                let o_row = (row + pos) % lines.len();
                for col in 0..screen.size().x() {
                    let o_col = (col + pos * 3) % width;
                    screen[row][col] = lines[o_row][o_col].clone();
                }
            }
            sys.draw(&screen).expect("failed to render screen");
        }
        if moving {
            pos += 1;
            thread::sleep(Duration::from_millis(250));
        } else {
            thread::sleep(Duration::from_millis(50));
        }
    }
    sys.stop();
}

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.

Examples found in repository

examples/list-actions.rs (line 9)

fn list_events(mut sys: Box<dyn IoSystem>) {
    let mut log = vec!["press escape to exit when you're done".to_owned()];
    let mut screen = Screen::new(sys.size());
    loop {
        screen.resize(sys.size());
        for (line, row) in log.iter().rev().zip((0..screen.size().y()).rev()) {
            for (char, col) in line.chars().zip(0..screen.size().x()) {
                screen[row][col] = Cell::of(char);
            }
        }
        sys.draw(&screen).expect("failed to render screen");
        match sys.input().expect("failed to get input") {
            Action::Closed | Action::KeyPress { key: Key::Escape } => break,
            Action::Error(e) => panic!("{1}: {:?}", e, "got an error for input"),
            other => log.push(format!("{:?}", other)),
        }
        if log.len() > screen.size().y() {
            let diff = log.len() - screen.size().y();
            log.drain(..diff);
        }
    }
    sys.stop();
}

examples/color-demo.rs (line 45)

fn color_demo(mut sys: Box<dyn IoSystem>) {
    let color_width = Color::all()
        .into_iter()
        .map(|c| format!("{:?}", c).len())
        .max()
        .unwrap();

    let mut lines: Vec<Vec<Cell>> = Color::all()
        .into_iter()
        .map(|bg| {
            let mut line = vec![];
            for fg in Color::all() {
                let text = format!("{:?} on {1:<2$} ", fg, format!("{:?}", bg), color_width);
                line.extend(text.chars().map(move |c| Cell::of(c).fg(fg).bg(bg)));
            }
            line
        })
        .collect();
    let width: usize = lines.iter().map(|l| l.len()).max().unwrap() + 5;
    for line in &mut lines {
        let bg = line[0].get_fmt().bg;
        line.extend(repeat(Cell::of(' ').bg(bg)).take(width - line.len()));
    }
    let mut screen = Screen::new(XY(0, 0));
    let mut pos = 0;
    let mut moving = true;
    'main: loop {
        while let Some(action) = sys.poll_input().unwrap() {
            match action {
                Action::Closed | Action::KeyPress { key: Key::Escape } => break 'main,
                Action::KeyPress {
                    key: Key::Char(' '),
                } => moving = !moving,
                _ => (),
            }
        }
        if moving || sys.size() != screen.size() {
            screen.resize(sys.size());
            for row in 0..screen.size().y() {
                let o_row = (row + pos) % lines.len();
                for col in 0..screen.size().x() {
                    let o_col = (col + pos * 3) % width;
                    screen[row][col] = lines[o_row][o_col].clone();
                }
            }
            sys.draw(&screen).expect("failed to render screen");
        }
        if moving {
            pos += 1;
            thread::sleep(Duration::from_millis(250));
        } else {
            thread::sleep(Duration::from_millis(50));
        }
    }
    sys.stop();
}

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() -> Self

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) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Screen

fn index_mut(&mut self, row: usize) -> &mut Self::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