Struct Image 

pub struct Image<'a> { /* private fields */ }

A loaded image file.

Can be loaded as [FileBuf] from ROM with [load_file_buf] and then cast using Into.

Implementations

impl<'a> Image<'a>

pub const unsafe fn from_bytes(raw: &'a [u8]) -> Self

Reinterpret raw bytes as an image.

Safety

Using this function requires a good understanding of the internal Firefly Zero binary image format. In 99% cases, you should not construct a raw image but instead load it from a File or generate using Canvas.

pub const fn sub(&self, p: Point, s: Size) -> SubImage<'a>

Get a rectangle subregion of the image.

pub const fn bpp(&self) -> u8

Bits per pixel. One of: 1, 2, or 4.

pub fn transparency(&self) -> Color

The color used for transparency. If no transparency, returns Color::None.

pub const fn pixels(&self) -> usize

The number of pixels the image has.

pub fn width(&self) -> u16

The image width in pixels.

pub fn height(&self) -> u16

The image height in pixels.

pub fn size(&self) -> Size

The image size in pixels.

pub fn get_color(&self, p: u8) -> Color

Get the color used to represent the given pixel value.

Trait Implementations

impl<'a> From<Canvas<'a>> for Image<'a>

fn from(value: Canvas<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<File<'a>> for Image<'a>

fn from(value: File<'a>) -> Self

Converts to this type from the input type.