Struct tuig_iosys::Screen

source ·
pub struct Screen { /* private fields */ }
Expand description

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§

source§

impl Screen

source

pub fn new(size: XY) -> Self

Create a new Screen in the given size.

Examples found in repository?
examples/list-actions.rs (line 7)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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();
}
More examples
Hide additional examples
examples/color-demo.rs (line 31)
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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();
}
source

pub fn size(&self) -> XY

How big this Screen is, in characters.

Examples found in repository?
examples/list-actions.rs (line 10)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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();
}
More examples
Hide additional examples
examples/color-demo.rs (line 44)
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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();
}
source

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].

source

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

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

source

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

Returns an iterator over the rows in a screen.

source

pub fn clear(&mut self)

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

source

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)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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();
}
More examples
Hide additional examples
examples/color-demo.rs (line 45)
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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();
}
source

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§

source§

impl Clone for Screen

source§

fn clone(&self) -> Screen

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for Screen

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Index<usize> for Screen

§

type Output = [Cell]

The returned type after indexing.
source§

fn index(&self, row: usize) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
source§

impl IndexMut<usize> for Screen

source§

fn index_mut(&mut self, row: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
source§

impl PartialEq for Screen

source§

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

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

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.
source§

impl Eq for Screen

source§

impl StructuralEq for Screen

source§

impl StructuralPartialEq for Screen

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.