Struct buffer_graphics_lib::Graphics

pub struct Graphics<'buffer> { /* private fields */ }

Implementations

impl Graphics<'_>

pub fn index(&self, x: usize, y: usize) -> usize

Convert an x,y coord to idx for use with self.pixels

pub fn width(&self) -> usize

pub fn height(&self) -> usize

pub fn is_on_screen(&self, point: Coord) -> bool

impl Graphics<'_>

pub fn get_translate(&self) -> Coord

Get the canvas offset in pixels

pub fn set_translate(&mut self, new_value: Coord)

Set the canvas offset in pixels

All drawing commands will be offset by this value

pub fn update_translate(&mut self, delta: Coord)

Adds delta to the current canvas offset

pub fn copy_to_image(&mut self) -> Image

Copy entire pixels array to an image

Although the method takes &mut self it doesn’t mutate anything

pub fn get_px_for_char(x: usize, y: usize, size: TextSize) -> (usize, usize)

Get top left pixel coord for letter px coord

pub fn get_text_size(text: &str, width: usize, size: TextSize) -> (usize, usize)

Get width and height for string

Arguments

• text - The string to be measured
• width - The line width in characters
• size - The text size to use when measuring

Returns

The width and height of the string in pixels

pub fn draw_image<P: Into<Coord>>(&mut self, xy: P, image: &Image)

Draw an image at x, y

pub fn draw_line<P1: Into<Coord>, P2: Into<Coord>>(
    &mut self,
    start: P1,
    end: P2,
    color: Color
)

pub fn draw_at<P: Into<Coord>>(&mut self, xy: P, shape: &dyn Renderable)

Draw renderable

pub fn draw(&mut self, shape: &dyn Renderable)

Draw renderable

pub fn update_pixel(&mut self, x: isize, y: isize, color: Color)

Update a pixel color, using [PixelWrapper::set_pixel] or [PixelWrapper::blend_pixel] depending on whether colors alpha is 255 or not

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

Sets every pixel to the same color, this ignores translate

pub fn draw_letter(
    &mut self,
    pos: (isize, isize),
    chr: char,
    size: TextSize,
    color: Color
)

Draw a letter at pos

pub fn draw_ascii_letter(
    &mut self,
    pos: (isize, isize),
    code: u8,
    size: TextSize,
    color: Color
)

pub fn draw_ascii<P: Into<TextPos>, F: Into<TextFormat>>(
    &mut self,
    text: &[Vec<u8>],
    pos: P,
    format: F
)

Should only be used by Text::render text param must already be corrected wrapped

pub fn draw_text<P: Into<TextPos>, F: Into<TextFormat>>(
    &mut self,
    text: &str,
    pos: P,
    format: F
)

pub fn blend_pixel(&mut self, x: isize, y: isize, color: Color)

Set the RGB values for a pixel by blending it with the provided color This method uses alpha blending, note that the canvas pixels always have 255 alpha

pub fn set_pixel(&mut self, x: isize, y: isize, color: Color)

Set the RGB values for a pixel This ignores alpha, so 255,0,0,0 will draw a red pixel

impl<'buffer> Graphics<'_>

pub fn new(
    buffer: &'buffer mut [u8],
    width: usize,
    height: usize
) -> Result<Graphics<'buffer>, GraphicsError>

pub fn new_unchecked(
    buffer: &'buffer mut [u8],
    width: usize,
    height: usize
) -> Graphics<'buffer>