Struct Canvas 

pub struct Canvas { /* private fields */ }

The basic canvas

Paint anything on the canvas anywhere you want. Don’t worry about the (x, y), the size of canvas will auto increase, and it support the negative number.

Example

Draw the y = 1.5*sin(x) and y = cos(x)

use rsille::Canvas;
let mut c = Canvas::new();
for x in 0..1000 {
    let x = x as f64;
    c.set(x / 10.0, x.to_radians().sin() * 15.0);
    c.set(x / 10.0, x.to_radians().cos() * 10.0);
}
c.print();

NOTE

Take a look at the extra module, there are some useful things can paint on the canvas

Implementations

impl Canvas

pub fn new() -> Self

Make a new empty canvas

The size of the canvas will auto increase

pub fn paint<T, N>(&mut self, target: &T, x: N, y: N) -> Result<(), RsilleErr>

where T: Paint, N: Into<f64>,

Paint those Paint object on the location (x, y)

pub fn print(&self)

Print the canvas to the terminal

If you want to print the canvas to a buffer, use the print_on

pub fn print_on<W>(&self, w: &mut W, is_raw: bool) -> Result<(), RsilleErr>

where W: Write,

Print the canvas to the buffer

If you want to print the canvas to the terminal, use the print

pub fn clear(&mut self)

Clear the canvas

This method only clear those dots on the canvas, the size of the canvas will not change If you want to clear the size too, use the reset

pub fn reset(&mut self)

Reset the canvas to a new empty canvas

pub fn set_size<T>(&mut self, width: T, height: T)

where T: Into<f64>,

Set the size of the canvas

This method can’t fix the size of the canvas, it’s just set the canvas size. When the size isn’t enough, the canvas will auto increase. And the (width, height) isn’t the size of the terminal, it’s the size of the canvas! For example, an object x from -30 to 30, then it’s 60 in width. On the terminal, it’s 30 in width(because braille code), but you should set the width to 60 not 30.

pub fn set_minx<T>(&mut self, minx: T)

where T: Into<f64>,

Set the min x of th canvas

In most time, no need to call this, only when the animation is moved when running

pub fn set_maxy<T>(&mut self, maxy: T)

where T: Into<f64> + Copy,

Set the max y of the canvas

In most time, no need to call this, only when the animation is moved when running

pub fn set<T>(&mut self, x: T, y: T)

where T: Into<f64> + Copy,

Draw a dot on (x, y)

Just use the (x, y) in your object, the algorithm will find the right location

pub fn set_colorful<T>(&mut self, x: T, y: T, color: Color)

where T: Into<f64> + Copy,

Similar to set

But it’s support color

pub fn toggle<T>(&mut self, x: T, y: T)

where T: Into<f64> + Copy,

If the (x, y) is already set, then unset it

If the (x, y) is unset, then set it

pub fn line<T>(&mut self, xy1: (T, T), xy2: (T, T))

where T: Into<f64>,

Draw a line on the canvas

• xy1 - the start location
• xy2 - the end location

pub fn line_any<T>( &mut self, xy1: (T, T), xy2: (T, T), c: char, color: Option<Color>, )

where T: Into<f64>,

Draw a line on the canvas

• xy1 - the start location
• xy2 - the end location
• c - the char used in line
• color - optional, the color

It can draw any character on canvas, and when there are both a braille code and any char on (x, y), the character will cover the braille code!

pub fn line_colorful<T>(&mut self, xy1: (T, T), xy2: (T, T), color: Color)

where T: Into<f64> + Copy,

Draw a line on the canvas with the color

• xy1 - the start location
• xy2 - the end location

pub fn put_text<T>(&mut self, x: T, y: T, text: &str, color: Option<Color>)

where T: Into<f64>,

Put text on canvas

It can draw any character on canvas, and when there are both a braille code and any char on (x, y), the character will cover the braille code!

pub fn put<T>(&mut self, x: T, y: T, c: char, color: Option<Color>)

where T: Into<f64>,

Put char on canvas

It can draw any character on canvas, and when there are both a braille code and any char on (x, y), the character will cover the braille code!

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 Default for Canvas

fn default() -> Self

Returns the “default value” for a type.