Struct ImageData

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

The image data representing the pixel data of an image.

Each pixel is represented by 4 bytes in RGBA (Red, Green, Blue, Alpha) format. The pixel data is stored in a linear array of bytes, where each pixel is represented by 4 bytes.

Example

#[cfg(feature = "image")]
{
    use auto_palette::ImageData;

    let pixels = [
        255, 0, 0, 255, // Red
        0, 255, 0, 255, // Green
        0, 0, 255, 255, // Blue
        0, 0, 0, 255, // Black
    ];
    let image_data = ImageData::new(2, 2, &pixels).unwrap();
    assert_eq!(image_data.width(), 2);
    assert_eq!(image_data.height(), 2);
    assert_eq!(image_data.data(), &pixels);
}

Implementations

impl<'a> ImageData<'a>

pub fn new(width: u32, height: u32, data: &'a [u8]) -> ImageResult<Self>

Creates a new ImageData with the given width, height, and pixel data.

Arguments

• width - The width of the image data.
• height - The height of the image data.
• data - The pixel data of the image data.

Returns

The ImageData with the given width, height, and pixel data.

Errors

Returns an error if the length of the pixel data is not equal to width * height * 4.

pub fn load<P>(path: P) -> ImageResult<Self>

where P: AsRef<Path>,

Loads the image data from the given path. The image data is loaded using the image crate.

Arguments

• path - The path to the image file.

Returns

The image data loaded from the given path.

Errors

Returns an error if the image loading process fails. Returns an error if the color type of the image is not supported.

pub fn is_empty(&self) -> bool

Checks whether the image data is empty.

Returns

true if the image data is empty, false otherwise.

pub fn width(&self) -> u32

Returns the width of the image data.

Returns

The width of the image data.

pub fn height(&self) -> u32

Returns the height of the image data.

Returns

The height of the image data.

pub fn area(&self) -> usize

Returns the area of the image data.

Returns

The area of the image data.

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

Returns the pixel data of the image data.

Each pixel is represented by 4 bytes in RGBA (Red, Green, Blue, Alpha) format.

Returns

The pixel data of the image data.

Trait Implementations

impl<'a> Debug for ImageData<'a>

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

Formats the value using the given formatter.

impl From<&ImageBuffer<Rgb<u8>, Vec<u8>>> for ImageData<'_>

fn from(image: &RgbImage) -> Self

Converts to this type from the input type.

impl From<&ImageBuffer<Rgba<u8>, Vec<u8>>> for ImageData<'_>

fn from(image: &RgbaImage) -> Self

Converts to this type from the input type.

impl TryFrom<&DynamicImage> for ImageData<'_>

type Error = ImageError

The type returned in the event of a conversion error.

fn try_from(image: &DynamicImage) -> Result<Self, Self::Error>

Performs the conversion.