Struct prototty_elements::elements::Canvas

pub struct Canvas { /* fields omitted */ }

A rectangular drawing element.

Methods

impl Canvas

fn new<D: Into<Vector2<u16>>>(size: D) -> Self

fn get_mut(&mut self, coord: Vector2<i16>) -> Option<&mut CanvasCell>

Returns a mutable reference to a cell at the given coordinate.

fn get(&self, coord: Vector2<i16>) -> Option<&CanvasCell>

Returns a reference to a cell at the given coordinate.

fn coords(&self) -> CoordIter

Returns an iterator over the coordinates of the canvas.

fn iter(&self) -> Iter

Returns an iterator over the cells in the canvas.

fn iter_mut(&mut self) -> IterMut

Returns a iterator that allows modifying each cell.

fn enumerate(&self) -> CoordEnumerate<CanvasCell>

Returns an iterator over pairs of coordinates and cells.

fn enumerate_mut(&mut self) -> CoordEnumerateMut<CanvasCell>

Returns an iterator over pairs of coordinates and cells allowing modification of the cells.

Trait Implementations

impl Debug for Canvas

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Canvas

fn clone(&self) -> Canvas

Returns a copy of the value.

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

Performs copy-assignment from source.

impl View for Canvas

fn view<G: ViewGrid>(&self, offset: Vector2<i16>, depth: i16, grid: &mut G)

Update the cells in grid to describe how a type should be rendered. Implementations of view for low level ui components will typically involve updating cells directly. Implementations for higer level components, such as an entire application's ui, will typically call the view methed of lower level components which make up the ui.

impl ViewSize for Canvas

fn size(&self) -> Vector2<u16>

Returns the size in cells of the rectangle containing a ui element. This allows for the implementation of decorator ui components that render a border around some inner element.