Struct andrew::Canvas[][src]

pub struct Canvas<'a> {
    pub buffer: &'a mut [u8],
    pub width: usize,
    pub height: usize,
    pub stride: usize,
    pub pixel_size: usize,
    pub endianness: Endian,
}

The canvas object acts as a wrapper around a buffer, providing information and functions for drawing

Fields

buffer: &'a mut [u8]

A buffer for the canvas to draw to

width: usize

The width in pixels of the canvas

height: usize

The height in pixels of the canvas

stride: usize

The number of bytes between each line of pixels on the canvas

pixel_size: usize

The number of bytes contained in each pixel

endianness: Endian

The endianness of the canvas

Implementations

impl<'a> Canvas<'a>[src]

pub fn new(
    buffer: &'a mut [u8],
    width: usize,
    height: usize,
    stride: usize,
    endianness: Endian
) -> Canvas<'a>
[src]

Creates a new canvas object

pub fn draw<D: Drawable>(&mut self, drawable: &D)[src]

Draws an object that implements the Drawable trait to the buffer

pub fn draw_point(&mut self, x: usize, y: usize, color: [u8; 4])[src]

Draws a pixel at the x and y coordinate

pub fn clear(&mut self)[src]

Clears the entire canvas buffer by zeroing it

Auto Trait Implementations

impl<'a> RefUnwindSafe for Canvas<'a>

impl<'a> Send for Canvas<'a>

impl<'a> Sync for Canvas<'a>

impl<'a> Unpin for Canvas<'a>

impl<'a> !UnwindSafe for Canvas<'a>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.