Struct pixels_graphics_lib::drawing::PixelWrapper

pub struct PixelWrapper {
    pub pixels: Pixels,
    // some fields omitted
}

Fields

pixels: Pixels

Implementations

impl PixelWrapper

pub fn new(pixels: Pixels, width: usize, height: usize) -> Self

impl PixelWrapper

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

impl PixelWrapper

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(
    &self,
    x: usize,
    y: usize,
    size: TextSize
) -> (usize, usize)

Get top left pixel coord for letter px coord

pub fn get_text_size(
    &self,
    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

impl PixelWrapper

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

Sets every pixel to the same color, this ignores translate

pub fn draw_image(&mut self, start_x: isize, start_y: isize, image: &Image)

Draw an image at x, y

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

Draw a letter at a letter coord See TextSize::get_max_characters for maximum x and y

pub fn draw_letter_px(
    &mut self,
    x: isize,
    y: isize,
    chr: char,
    size: TextSize,
    color: Color
)

Draw a letter at pixel coord

pub fn draw_text_px(
    &mut self,
    text: &str,
    line_width: usize,
    x: isize,
    y: isize,
    size: TextSize,
    color: Color
)

Draws text in lines at most width chars long at pixel coord

Width should be max chars - x See TextSize::get_max_characters for maximum chars

pub fn draw_text(
    &mut self,
    text: &str,
    line_width: usize,
    x: isize,
    y: isize,
    size: TextSize,
    color: Color
)

Draws text in lines at most width chars long at letter coord

Width must be max chars - x See TextSize::get_max_characters for maximum x and y

pub fn get_pixel(
    &mut self,
    x: isize,
    y: isize,
    use_translate: bool
) -> Option<Color>

Get the RGB values for a pixel Alpha will always be 255

If use_translate is true than the x,y will be updated with self.translate

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

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 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

pub fn draw_rect(
    &mut self,
    x1: isize,
    y1: isize,
    x2: isize,
    y2: isize,
    color: Color
)

Draw a filled rectangle from x1,y1 to x2,y2 in color

pub fn draw_frame(
    &mut self,
    x1: isize,
    y1: isize,
    x2: isize,
    y2: isize,
    color: Color
)

Draw a hollow rectangle from x1,y1 to x2,y2 in color

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

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

pub fn draw_line(
    &mut self,
    x1: isize,
    y1: isize,
    x2: isize,
    y2: isize,
    color: Color
)

Draw line from x1,y1 to x2,y2 in color