Skip to main content

ImageRef

Struct ImageRef 

Source
pub struct ImageRef<'a> { /* private fields */ }
Expand description

A loaded image file.

Can be loaded as FileRef from ROM with load_file and then cast using Into.

Implementations§

Source§

impl<'a> ImageRef<'a>

Source

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

Trait Implementations§

Source§

impl<'a> From<CanvasRef<'a>> for ImageRef<'a>

Source§

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

Converts to this type from the input type.
Source§

impl<'a> From<FileRef<'a>> for ImageRef<'a>

Source§

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

Converts to this type from the input type.
Source§

impl Image for ImageRef<'_>

Source§

unsafe fn as_bytes(&self) -> &[u8]

Get the raw image representation. Read more
Source§

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

Get a rectangle subregion of the image.
Source§

fn transparency(&self) -> Color

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

fn pixels(&self) -> usize

The number of pixels the image has.
Source§

fn width(&self) -> u16

The image width in pixels.
Source§

fn height(&self) -> u16

The image height in pixels.
Source§

fn size(&self) -> Size

The image size in pixels.

Auto Trait Implementations§

§

impl<'a> Freeze for ImageRef<'a>

§

impl<'a> RefUnwindSafe for ImageRef<'a>

§

impl<'a> Send for ImageRef<'a>

§

impl<'a> Sync for ImageRef<'a>

§

impl<'a> Unpin for ImageRef<'a>

§

impl<'a> UnsafeUnpin for ImageRef<'a>

§

impl<'a> UnwindSafe for ImageRef<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.