Struct Image 

pub struct Image {
    pub width: u32,
    pub height: u32,
    pub pixels: Vec<u8>,
}

a decoded image in RGBA format.

contains the image dimensions and raw pixel data (RGBA8 order). use decode to load a .li file into this type.

Fields

width: u32

image width in pixels.

height: u32

image height in pixels.

pixels: Vec<u8>

raw pixel data in RGBA order, width * height * 4 bytes.

Implementations

impl Image

pub fn new(width: u32, height: u32) -> Self

create a new blank image filled with transparent black pixels.

pub const fn len(&self) -> usize

get the number of pixels in the image.

pub const fn is_empty(&self) -> bool

check if the image has zero width or height.

pub const fn byte_len(&self) -> usize

get the total byte count of the pixel buffer.

pub const fn contains(&self, x: u32, y: u32) -> bool

check if a pixel coordinate is within the image bounds.

pub fn get_pixel(&self, x: u32, y: u32) -> [u8; 4]

get the RGBA value at a pixel coordinate.

Panics

panics if the coordinate is out of bounds. use try_get_pixel to handle out-of-bounds without panicking.

pub fn try_get_pixel(&self, x: u32, y: u32) -> Option<[u8; 4]>

get the RGBA value at a pixel coordinate, or None if out of bounds.

pub fn set_pixel(&mut self, x: u32, y: u32, rgba: [u8; 4])

set the RGBA value at a pixel coordinate.

Panics

panics if the coordinate is out of bounds. use try_set_pixel to handle out-of-bounds without panicking.

pub fn try_set_pixel(&mut self, x: u32, y: u32, rgba: [u8; 4]) -> Option<()>

set the RGBA value at a pixel coordinate. returns None if out of bounds.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Image

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.