Skip to main content

DecodedImage

Struct DecodedImage 

Source
pub struct DecodedImage { /* private fields */ }
Expand description

A decoded PNG image.

data holds the pixels in PNG’s own layout, de-interlaced: rows top to bottom, each row_bytes long; samples of fewer than 8 bits packed most significant bits first; 16-bit samples as big-endian byte pairs; indexed images as palette indices. Use to_rgba8 or to_rgba16 for uniform RGBA pixels with palette and transparency applied.

Implementations§

Source§

impl DecodedImage

Source

pub const fn width(&self) -> u32

Width in pixels.

Source

pub const fn height(&self) -> u32

Height in pixels.

Source

pub const fn color_type(&self) -> ColorType

Colour type as stored in the file.

Source

pub const fn bit_depth(&self) -> BitDepth

Bit depth as stored in the file.

Source

pub const fn is_interlaced(&self) -> bool

Whether the file was Adam7-interlaced.

Source

pub fn row_bytes(&self) -> usize

Bytes per row of data.

Source

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

The pixel data in PNG layout (see the type documentation).

Source

pub fn into_data(self) -> Vec<u8> ⓘ

Takes ownership of the pixel data.

Source

pub fn palette(&self) -> Option<&[[u8; 4]]>

The palette of an indexed image as RGBA entries, with alpha from tRNS (255 where it gives none).

Source

pub const fn color_key(&self) -> Option<ColorKey>

The transparent colour of a greyscale or RGB image, if any.

Source

pub const fn metadata(&self) -> &Metadata

Resolution and text metadata.

Source

pub fn to_rgba8(&self) -> Vec<u8> ⓘ

The pixels as 8-bit RGBA, 4 bytes per pixel.

Grey is replicated into R, G and B; samples below 8 bits are scaled up exactly (e.g. 4-bit 15 becomes 255); 16-bit samples are rounded to the nearest 8-bit value. Alpha comes from the alpha channel, from the colour key (0 for matching pixels) or from the palette, and is 255 otherwise. Palette indices beyond the palette yield opaque black.

Source

pub fn to_rgba16(&self) -> Vec<u16>

The pixels as 16-bit RGBA, 4 values per pixel; lossless for every PNG format. Lower depths are scaled up exactly (8-bit 255 becomes 65535), alpha is derived as for to_rgba8.

Trait Implementations§

Source§

impl Clone for DecodedImage

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DecodedImage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DecodedImage

Source§

impl PartialEq for DecodedImage

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DecodedImage

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.