Struct ScaleFitView

#[non_exhaustive]
pub struct ScaleFitView {
    pub view: View,
    pub empty_row_count: i64,
}

A wrapper around a View which auto resizes to fit the terminal window

ScaleFitView’s update() function should be used in place of View’s clear() function to handle auto-resizing and clearing

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

view: View

The View that this struct wraps around

empty_row_count: i64

How many rows to leave clear below the rendered view. You might want to set this if you have more than one line of text after rendered text

Implementations

impl ScaleFitView

pub fn new(background_char: ColChar) -> Self

Create a new ScaleFitView with the given background ColChar

Examples found in repository

examples/self-resizing.rs (line 17)

fn main() {
    let mut scale_view = ScaleFitView::new(ColChar::BACKGROUND);

    let mut text = Text::new(Vec2D::ZERO, "This is some centered text!", Modifier::None)
        .with_align(TextAlign::Centered);

    let mut sprite =
        Sprite::new(Vec2D::ZERO, TEXTURE, Modifier::None).with_align(TextAlign2D::CENTERED);

    loop {
        text.pos = scale_view.intended_size() / 2;
        sprite.pos = scale_view.intended_size() / 2;
        sprite.pos.y -= 5;

        scale_view.update();
        scale_view.view.draw(&text);
        scale_view.view.draw(&sprite);
        let _ = scale_view.view.display_render();

        thread::sleep(Duration::from_millis(10));
    }
}

pub const fn with_empty_row_count(self, empty_row_count: i64) -> Self

Return the ScaleFitView with an updated empty_row_count property. Consumes the original ScaleFitView

pub fn intended_size(&self) -> Vec2D

Returns the size of the terminal, with the y adjusted as intended using the empty_row_count property

Panics

Panics if there is no TTY to get the terminal size of, as per terminal_size::terminal_size()

Examples found in repository

examples/self-resizing.rs (line 26)

fn main() {
    let mut scale_view = ScaleFitView::new(ColChar::BACKGROUND);

    let mut text = Text::new(Vec2D::ZERO, "This is some centered text!", Modifier::None)
        .with_align(TextAlign::Centered);

    let mut sprite =
        Sprite::new(Vec2D::ZERO, TEXTURE, Modifier::None).with_align(TextAlign2D::CENTERED);

    loop {
        text.pos = scale_view.intended_size() / 2;
        sprite.pos = scale_view.intended_size() / 2;
        sprite.pos.y -= 5;

        scale_view.update();
        scale_view.view.draw(&text);
        scale_view.view.draw(&sprite);
        let _ = scale_view.view.display_render();

        thread::sleep(Duration::from_millis(10));
    }
}

pub fn update(&mut self)

Resize and clear the View

Panics

Panics if there is no TTY to get the terminal size of, as per terminal_size::terminal_size()

Examples found in repository

examples/self-resizing.rs (line 30)

fn main() {
    let mut scale_view = ScaleFitView::new(ColChar::BACKGROUND);

    let mut text = Text::new(Vec2D::ZERO, "This is some centered text!", Modifier::None)
        .with_align(TextAlign::Centered);

    let mut sprite =
        Sprite::new(Vec2D::ZERO, TEXTURE, Modifier::None).with_align(TextAlign2D::CENTERED);

    loop {
        text.pos = scale_view.intended_size() / 2;
        sprite.pos = scale_view.intended_size() / 2;
        sprite.pos.y -= 5;

        scale_view.update();
        scale_view.view.draw(&text);
        scale_view.view.draw(&sprite);
        let _ = scale_view.view.display_render();

        thread::sleep(Duration::from_millis(10));
    }
}

Trait Implementations

impl Canvas for ScaleFitView

fn plot(&mut self, pos: Vec2D, c: ColChar)

Plot a ColChar to the Canvas at pos