Struct Renderer

pub struct Renderer { /* private fields */ }

This is the core of the library. It will send commands to the rendering server to print on screen.

Usage

// get the renderer
let rdr = Renderer::get();
 
...
 
// start drawing on a frame
rdr.begin_draw();
 
... // use drawing functions (eg. draw_rect, draw_point...)
 
rdr.end_draw(); // this pushes the frame to the screen
 
...
 
Renderer::exit(); // to quit the program and reset terminal settings

Screen coordinates start in the top left at (0, 0)

Implementations

impl Renderer

pub fn exit()

Exits the program and reset terminal setttings (should be called before the program ends).

pub fn get() -> &'static mut Renderer

Returns the Renderer instance.

pub fn get_size() -> Vec2

Returns the screen dimension.

let size = Renderer::get_size();
 
size.x // width of the screen
size.y // height of the screen

pub fn begin_draw(&mut self)

Starts drawing a frame.

Will panic if called twice before an end_draw

pub fn end_draw(&mut self)

Ends drawing a frame and pushes it to the screen.

pub fn clear(&mut self, c: Color)

Clears the screen (color and text).

pub fn clear_color(&mut self, c: Color)

Sets all the pixels’ color in the screen to c (does not clear text).

pub fn clear_text(&mut self)

Removes all text from the screen.

pub fn draw_line<A, B>(&mut self, p1: A, p2: B, c: Color)

where A: AsRef<Vec2>, B: AsRef<Vec2>,

Draws a line of color c between p1 and p2.

pub fn draw_rect<A, B>(&mut self, p: A, s: B, c: Color)

where A: AsRef<Vec2>, B: AsRef<Vec2>,

Draws a rectangle of color c and of size s. p is the coordinate of the top left corner of the rectangle.

pub fn draw_rect_boundary<A, B>(&mut self, p: A, s: B, c: Color)

where A: AsRef<Vec2>, B: AsRef<Vec2>,

Same as draw_rect but draws only the four sides of the rectangle.

pub fn draw_ellipse_boundary<A, B>(&mut self, c: A, s: B, col: Color)

where A: AsRef<Vec2>, B: AsRef<Vec2>,

Draws an ellipse of color col. c is the center of the ellipse and s is the size of the rectangle in which the ellipse is inscribed.

pub fn draw_point<A>(&mut self, p: A, c: Color)

where A: AsRef<Vec2>,

Sets the color of the pixel at p to c.

pub fn draw_image<A, B, C>( &mut self, img: Arc<Mutex<Image>>, pos: A, size: B, offset: C, alpha: Option<Color>, )

where A: AsRef<Vec2>, B: AsRef<Vec2>, C: AsRef<Vec2>,

Draws an image at position pos.

Negative size results in flipped image. Alpha is used to ignore a given color while drawing.

pub fn draw_whole_image_alpha<A>( &mut self, img: Arc<Mutex<Image>>, pos: A, alpha: Color, )

where A: AsRef<Vec2>,

Draws the whole image at pos, ignoring the color alpha.

Equivalent to:

rdr.image(img, pos, img.size(), Vec2::ZERO, Some(alpha));

pub fn draw_whole_image<A>(&mut self, img: Arc<Mutex<Image>>, pos: A)

where A: AsRef<Vec2>,

Draws the whole image at pos.

Equivalent to:

rdr.image(img, pos, img.size(), Vec2::ZERO, None);

pub fn print_text_raw<A>( &mut self, text: &String, pos: A, background_mode: CharBackgroundMode, foreground_mode: CharForegroundMode, )

where A: AsRef<Vec2>,

pub fn print_blended_text_raw<A>(&mut self, text: &String, pos: A)

where A: AsRef<Vec2>,

pub fn print_colored_text_raw<A>( &mut self, text: &String, pos: A, background_color: Color, foreground_color: Color, )

where A: AsRef<Vec2>,

pub fn ring_bell(&self)

Rings the terminal bell. Can only be called during the creation of a frame

Technical note: the bell will ring when calling end_draw

Trait Implementations

impl Drop for Renderer

fn drop(&mut self)

When the renderer singleton is droped, reset terminal settings and exit.