Struct Canvas 

pub struct Canvas { /* private fields */ }

A canvas object that can be used to draw to the terminal using Braille characters.

Implementations

impl Canvas

pub fn new(width: u32, height: u32) -> Canvas

Creates a new Canvas with the given width and height.

Note that the Canvas can still draw outside the given dimensions (expanding the canvas) if a pixel is set outside the dimensions.

Examples found in repository

examples/draw_triangle.rs (line 6)

fn main() {
    let mut canvas = Canvas::new(100, 100);
    canvas.line(2, 2, 80, 80);
    canvas.line(2, 80, 80, 80);
    canvas.line(2, 2, 2, 80);
    println!("{}", canvas.frame());
}

examples/draw_rgb_triangles.rs (line 7)

fn main() {
    let mut canvas = Canvas::new(100, 100);
    canvas.line_colored(2, 2, 80, 80, PixelColor::Red);
    canvas.line_colored(2, 80, 80, 80, PixelColor::Green);
    canvas.line_colored(2, 2, 2, 80, PixelColor::Blue);

    canvas.line_colored(
        2 + 5,
        2 + 15,
        80 + 5,
        80 + 15,
        PixelColor::TrueColor { r: 255, g: 0, b: 0 },
    );
    canvas.line_colored(
        2 + 5,
        80 + 15,
        80 + 5,
        80 + 15,
        PixelColor::TrueColor { r: 0, g: 255, b: 0 },
    );
    canvas.line_colored(
        2 + 5,
        2 + 15,
        2 + 5,
        80 + 15,
        PixelColor::TrueColor { r: 0, g: 0, b: 255 },
    );
    println!("{}", canvas.frame());
}

pub fn clear(&mut self)

Clears the canvas.

pub fn set(&mut self, x: u32, y: u32)

Sets a pixel at the specified coordinates.

pub fn set_colored(&mut self, x: u32, y: u32, color: PixelColor)

Sets a pixel at the specified coordinates. specifying the color of the braille char

pub fn set_char(&mut self, x: u32, y: u32, c: char)

Sets a letter at the specified coordinates.

pub fn text(&mut self, x: u32, y: u32, max_width: u32, text: &str)

Draws text at the specified coordinates (top-left of the text) up to max_width length

pub fn unset(&mut self, x: u32, y: u32)

Deletes a pixel at the specified coordinates.

pub fn toggle(&mut self, x: u32, y: u32)

Toggles a pixel at the specified coordinates.

pub fn get(&self, x: u32, y: u32) -> bool

Detects whether the pixel at the given coordinates is set.

pub fn rows(&self) -> Vec<String>

Returns a Vec of each row of the Canvas.

Note that each row is actually four pixels high due to the fact that a single Braille character spans two by four pixels.

pub fn frame(&self) -> String

Draws the canvas to a String and returns it.

Examples found in repository

examples/draw_triangle.rs (line 10)

fn main() {
    let mut canvas = Canvas::new(100, 100);
    canvas.line(2, 2, 80, 80);
    canvas.line(2, 80, 80, 80);
    canvas.line(2, 2, 2, 80);
    println!("{}", canvas.frame());
}

examples/draw_rgb_triangles.rs (line 33)

fn main() {
    let mut canvas = Canvas::new(100, 100);
    canvas.line_colored(2, 2, 80, 80, PixelColor::Red);
    canvas.line_colored(2, 80, 80, 80, PixelColor::Green);
    canvas.line_colored(2, 2, 2, 80, PixelColor::Blue);

    canvas.line_colored(
        2 + 5,
        2 + 15,
        80 + 5,
        80 + 15,
        PixelColor::TrueColor { r: 255, g: 0, b: 0 },
    );
    canvas.line_colored(
        2 + 5,
        80 + 15,
        80 + 5,
        80 + 15,
        PixelColor::TrueColor { r: 0, g: 255, b: 0 },
    );
    canvas.line_colored(
        2 + 5,
        2 + 15,
        2 + 5,
        80 + 15,
        PixelColor::TrueColor { r: 0, g: 0, b: 255 },
    );
    println!("{}", canvas.frame());
}

pub fn line(&mut self, x1: u32, y1: u32, x2: u32, y2: u32)

Draws a line from (x1, y1) to (x2, y2) onto the Canvas.

Examples found in repository

examples/draw_triangle.rs (line 7)

fn main() {
    let mut canvas = Canvas::new(100, 100);
    canvas.line(2, 2, 80, 80);
    canvas.line(2, 80, 80, 80);
    canvas.line(2, 2, 2, 80);
    println!("{}", canvas.frame());
}

pub fn line_colored( &mut self, x1: u32, y1: u32, x2: u32, y2: u32, color: PixelColor, )

Draws a line from (x1, y1) to (x2, y2) onto the Canvas specifying the color of the line

Examples found in repository

examples/draw_rgb_triangles.rs (line 8)

fn main() {
    let mut canvas = Canvas::new(100, 100);
    canvas.line_colored(2, 2, 80, 80, PixelColor::Red);
    canvas.line_colored(2, 80, 80, 80, PixelColor::Green);
    canvas.line_colored(2, 2, 2, 80, PixelColor::Blue);

    canvas.line_colored(
        2 + 5,
        2 + 15,
        80 + 5,
        80 + 15,
        PixelColor::TrueColor { r: 255, g: 0, b: 0 },
    );
    canvas.line_colored(
        2 + 5,
        80 + 15,
        80 + 5,
        80 + 15,
        PixelColor::TrueColor { r: 0, g: 255, b: 0 },
    );
    canvas.line_colored(
        2 + 5,
        2 + 15,
        2 + 5,
        80 + 15,
        PixelColor::TrueColor { r: 0, g: 0, b: 255 },
    );
    println!("{}", canvas.frame());
}

Trait Implementations

impl Clone for Canvas

fn clone(&self) -> Canvas

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Canvas

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

Formats the value using the given formatter.

impl PartialEq for Canvas

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Canvas

impl StructuralPartialEq for Canvas