Enum fimg::DynImage

pub enum DynImage<T> {
    Y(Image<T, 1>),
    Ya(Image<T, 2>),
    Rgb(Image<T, 3>),
    Rgba(Image<T, 4>),
}

Dynamic image. Can be any of {Y8, YA8, RGB8, RGB16}.

Variants

Y(Image<T, 1>)

Y image

Ya(Image<T, 2>)

YA image

Rgb(Image<T, 3>)

RGB image

Rgba(Image<T, 4>)

RGBA image

Implementations

impl<T: AsMut<[u8]> + AsRef<[u8]>> DynImage<T>

pub unsafe fn rot_90(&mut self)

Rotate this image 90 degrees clockwise.

Safety

UB if this image is not square

pub fn rot_180(&mut self)

Rotate this image 180 degrees clockwise.

pub unsafe fn rot_270(&mut self)

Rotate this image 270 degrees clockwise.

Safety

UB if this image is not square

pub fn flip_h(&mut self)

Flip this image horizontally.

pub fn flip_v(&mut self)

Flip this image vertically.

impl<T> DynImage<T>

pub fn get_y(self) -> Result<Image<T, 1>, Self>

Gets out the Y image, if its there, else returning self.

If you want to convert, see DynImage::to_y.

pub fn get_ya(self) -> Result<Image<T, 2>, Self>

Gets out the YA image, if its there, else returning self.

If you want to convert, see DynImage::to_ya.

pub fn get_rgb(self) -> Result<Image<T, 3>, Self>

Gets out the RGB image, if its there, else returning self.

If you want to convert, see DynImage::to_rgb.

pub fn get_rgba(self) -> Result<Image<T, 4>, Self>

Gets out the RGBA image, if its there, else returning self.

If you want to convert, see DynImage::to_rgba.

impl DynImage<Box<[u8]>>

pub fn to_y(self) -> Image<Box<[u8]>, 1>

Convert this dyn image into a Y image.

pub fn to_ya(self) -> Image<Box<[u8]>, 2>

Convert this dyn image into a YA image.

pub fn to_rgb(self) -> Image<Box<[u8]>, 3>

Convert this dyn image into a RGB image.

pub fn to_rgba(self) -> Image<Box<[u8]>, 4>

Convert this dyn image into a RGBA image.

impl<T: AsRef<[u8]>> DynImage<T>

pub fn y(&self) -> Image<Box<[u8]>, 1>

Produce a Y image from this dyn image.

pub fn ya(&self) -> Image<Box<[u8]>, 2>

Produce a YA image from this dyn image.

pub fn rgb(&self) -> Image<Box<[u8]>, 3>

Produce a RGB image from this dyn image.

pub fn rgba(&self) -> Image<Box<[u8]>, 4>

Produce a RGBA image from this dyn image.

impl<T: AsMut<[u8]> + AsRef<[u8]>> DynImage<T>

pub fn scale<A: ScalingAlgorithm>( &mut self, width: u32, height: u32 ) -> DynImage<Box<[u8]>>

Available on crate feature scale only.

Scale this image with a given scaling algorithm.

impl<T> DynImage<T>

pub const fn width(&self) -> u32

Get the width of this image.

pub const fn height(&self) -> u32

Get the height of this image.

pub const fn buffer(&self) -> &T

Get the image buffer.

pub fn take_buffer(self) -> T

Take the image buffer.

impl<T: AsRef<[u8]>> DynImage<T>

pub fn as_ref(&self) -> DynImage<&[u8]>

Reference this image.

pub unsafe fn pixel<const P: usize>(&self, x: u32, y: u32) -> [u8; P]

where [u8; P]: PFrom<1> + PFrom<2> + PFrom<3> + PFrom<4>,

Get a pixel, of a type.

let i = DynImage::Rgb(Image::alloc(50, 50));
assert_eq!(unsafe { i.pixel::<4>(25, 25) }, [0, 0, 0, 255]);

Safety

undefined behaviour if pixel is out of bounds.

pub fn bytes(&self) -> &[u8]

Bytes of this image.

impl DynImage<Box<[u8]>>

pub fn open(f: impl AsRef<Path>) -> Self

Available on crate feature save only.

Open a PNG image

pub fn save(&self, f: impl AsRef<Path>)

Available on crate feature save only.

Save this image to a PNG.

Trait Implementations

impl<T: Clone> Clone for DynImage<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DynImage<T>

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

Formats the value using the given formatter.

impl<T: AsRef<[u8]>> Display for DynImage<T>

Available on crate feature term only.

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

Formats the value using the given formatter.

impl From<DynImage<Box<[u8]>>> for Image<Box<[u8]>, 1>

fn from(value: DynImage<Box<[u8]>>) -> Self

Converts to this type from the input type.

impl From<DynImage<Box<[u8]>>> for Image<Box<[u8]>, 2>

fn from(value: DynImage<Box<[u8]>>) -> Self

Converts to this type from the input type.

impl From<DynImage<Box<[u8]>>> for Image<Box<[u8]>, 3>

fn from(value: DynImage<Box<[u8]>>) -> Self

Converts to this type from the input type.

impl From<DynImage<Box<[u8]>>> for Image<Box<[u8]>, 4>

fn from(value: DynImage<Box<[u8]>>) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for DynImage<T>

fn eq(&self, other: &DynImage<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DynImage<&[u8]>

impl<T> StructuralPartialEq for DynImage<T>