Struct Canvas

pub struct Canvas { /* private fields */ }

Logical clone of Frame that exposes backend functionality for users without breaking the API rules

Examples

use oxide::Canvas;

let mut canvas = Canvas::new(60, 10);

let (rows, cols) = canvas.size();
// Set the entire canvas to '-' character
for i in 0..cols*rows {
    let y = i / cols;
    let x = i % cols;
    let mut cell = canvas.get_mut(x, y).unwrap();
    cell.set_ch('-');
}

Implementations

impl Canvas

pub fn new(cols: usize, rows: usize) -> Canvas

Constructs a new Canvas object cols wide by rows high

Examples

use oxide::Canvas;

let mut canvas = Canvas::new(60, 10); 

pub fn size(&self) -> Size

Returns the size of the canvas

Examples

use oxide::Canvas;

let mut canvas = Canvas::new(60, 10);

assert_eq!(canvas.size(), (60, 10));

pub fn cellvec(&self) -> &Vec<Cell>

Returns a reference to the vector of cells that lie within the canvas

pub fn cellvec_mut(&mut self) -> &mut Vec<Cell>

Returns a mutable reference to the vector of cells that lie within the canvas

pub fn clear(&mut self, blank: Cell)

Clears the canvas with a blank Cell

pub fn pos_to_index(&self, x: usize, y: usize) -> Option<usize>

Converts a position on the screen to the relative coordinate within the Canvas cell buffer

pub fn get(&self, x: usize, y: usize) -> Option<&Cell>

Returns a reference to the cell at the specified position (x,y), in the form of an Option. If no cell exists at that position, then None

pub fn get_mut(&mut self, x: usize, y: usize) -> Option<&mut Cell>

Returns a mutable reference to the cell at the specified position (x, y), in the form of an Option. If no cell exists at that position, then None

pub fn origin(&self) -> Pos

The location of the canvas

pub fn set_origin(&mut self, new_origin: Pos)

Mantually sets the location of the canvas

Trait Implementations

impl Widget for Canvas

fn draw(&mut self, parent: &mut dyn CellAccessor)

Draws the widget to the valid CellAccessor passed

fn pack( &mut self, parent: &dyn HasSize, halign: HorizontalAlign, valign: VerticalAlign, margin: (usize, usize), )

Aligns the widget with the parent as reference

fn resize(&mut self, new_size: Size)

Resize the given widget to new dimensions given by Size

fn draw_box(&mut self)

Expose the painter trait draw_box for all widgets, which outlines the space enclosed within the widget

fn frame(&self) -> &Frame

Return a reference the renderer, Base in general cases

fn frame_mut(&mut self) -> &mut Frame

Return a mutable reference to the renderer, Base in general cases