Enum DynImage 

pub enum DynImage<Fmt: ColorFmt> {
    Direct(DirectImage<Fmt>),
    Paletted(PalettedImage<Fmt>),
}

Either a DirectImage, or a PalettedImage.

Like both of these types, most of DynImage’s API is provided by the Image trait.

Variants

Direct(DirectImage<Fmt>)

The image is not paletted.

Paletted(PalettedImage<Fmt>)

The image is paletted.

Implementations

impl<Fmt: ColorFmt> DynImage<Fmt>

pub fn load<Src: ImageSource>( input: Src, flags: LoadFlags, alpha_mode: AlphaMode, prefer_palette: bool, ) -> Result<Self>

Loads an image from an image source.

If prefer_palette is true, this will attempt to generate a palette from a direct-color image; however, failure to do so (typically because the image contains more than 256 colours) is not considered an error, and instead returns a DirectImage.

If you don’t want to deal with the overhead of checking which image type is contained each time, consider either DirectImage::load() or PalettedImage::load().

pub fn load_limited<Src: ImageSource>( input: Src, flags: LoadFlags, alpha_mode: AlphaMode, prefer_palette: bool, nb_pixels_max: usize, ) -> Result<Self>

Loads an image from an image source, limiting the amount of memory that can be allocated.

If prefer_palette is true, this will attempt to generate a palette from a direct-color image; however, failure to do so (typically because the image contains more than 256 colours) is not considered an error, and instead returns a DirectImage.

Memory limit

Note that the nb_pixels_max argument only limits how much memory is allocated for the pixel data itself, not for the entire image or for temporary buffers.

The image struct, as well as the metadata nodes and other bookkeeping, can push the total allocation a little higher than that, though not much.

pub fn as_dyn_image(&self) -> &dyn Image<Fmt>

Returns a trait object for accessing the Image API of the underlying image.

Using this instead of simply casting self as &dyn Image<Fmt> is a little faster, because it inspects the enumeration only once instead of at every method call.

pub fn as_mut_dyn_image(&mut self) -> &mut dyn Image<Fmt>

Returns a trait object for accessing the Image API of the underlying image.

Using this instead of simply casting self as &mut dyn Image<Fmt> is a little faster, because it inspects the enumeration only once instead of at every method call.

Trait Implementations

impl<Fmt: Clone + ColorFmt> Clone for DynImage<Fmt>

fn clone(&self) -> DynImage<Fmt>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Fmt: Debug + ColorFmt> Debug for DynImage<Fmt>

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

Formats the value using the given formatter.

impl<Fmt: ColorFmt> From<DirectImage<Fmt>> for DynImage<Fmt>

fn from(value: DirectImage<Fmt>) -> Self

Converts to this type from the input type.

impl<Fmt: ColorFmt> From<PalettedImage<Fmt>> for DynImage<Fmt>

fn from(value: PalettedImage<Fmt>) -> Self

Converts to this type from the input type.

impl<Fmt: ColorFmt> Image<Fmt> for DynImage<Fmt>

fn nb_frames(&self) -> usize

Returns how many frames the image contains.

fn width(&self) -> usize

Returns how many pixels wide the image is.

fn height(&self) -> usize

Returns how many pixels tall the image is.

fn format(&self) -> ImageFormat

The image’s format (PNG, JPEG…).

fn set_format(&mut self, format: ImageFormat)

Sets a different format to store the image as.

fn alpha_mode(&self) -> AlphaMode

The image’s alpha mode.

fn set_alpha_mode(&mut self, mode: AlphaMode)

Sets a different alpha mode to store the image as.

fn palette(&self) -> Option<&[Fmt]>

Retrieves the image’s embedded colour palette, if there is one.

fn pixel(&self, frame_idx: usize, x: usize, y: usize) -> Fmt

Retrieves the pixel at the given position in the image.

fn pixel_mut(&mut self, frame_idx: usize, x: usize, y: usize) -> &mut Fmt

Retrieves the pixel at the given position in the image.

fn store<Dest: ImageDest>(&self, output: Dest) -> Result<NonZeroUsize>

Stores the image to an image destination.

fn metadata(&self) -> Metadata<'_>

Iterates through the image’s metadata nodes.

fn metadata_mut(&mut self) -> MetadataMut<'_>

Iterates through the image’s metadata nodes, allowing in-place modification of them.

fn nb_pixels(&self) -> usize

How many pixels are in each frame.

fn frame(&self, frame_idx: usize) -> Frame<'_, Fmt, Self>

where Self: Sized,

Provides more convenient access to a specific frame of the image’s.

fn frame_mut(&mut self, frame_idx: usize) -> FrameMut<'_, Fmt, Self>

where Self: Sized,

Provides more convenient access to a specific frame of the image’s.

fn frames(&self) -> Frames<'_, Fmt, Self>

where Self: Sized,

Iterates through the image’s frames.

fn foreach_frame_mut<F: FnMut(FrameMut<'_, Fmt, Self>)>(&mut self, f: F)

where Self: Sized,

Iterates through the image’s frames, with a callback that is allowed to mutate the image.

fn try_foreach_frame_mut<E, F: FnMut(FrameMut<'_, Fmt, Self>) -> Result<(), E>>( &mut self, f: F, ) -> Result<(), E>

where Self: Sized,

Iterates through the image’s frames, with a faillible callback that is allowed to mutate the image.