Struct ImageRef 

pub struct ImageRef<'a, P: Pixel> { /* private fields */ }

A borrowed, length-validated view of an interleaved image of pixel type P.

Cheap to copy (a slice + Dimensions + a zero-sized marker). Construct one at an API boundary with ImageRef::new; pass it to an crate::EncodeImage implementation.

Implementations

impl<'a, P: Pixel> ImageRef<'a, P>

pub fn new(data: &'a [P::Sample], dims: Dimensions) -> Result<Self>

Brands data as an image of dims, validating that its length is exactly width * height * P::CHANNELS.

Errors

Returns Error::InvalidInput if dims is zero-sized, if width * height * channels overflows usize, or if data.len() does not equal that product.

pub fn dimensions(self) -> Dimensions

The image dimensions.

pub fn width(self) -> u32

Image width in pixels.

pub fn height(self) -> u32

Image height in pixels.

pub fn as_samples(self) -> &'a [P::Sample]

The raw interleaved samples (width * height * P::CHANNELS of them, row-major). The zero-cost escape hatch a codec uses to feed its existing slice-based hot path.

pub fn row(self, y: u32) -> &'a [P::Sample]

Row y as a width * P::CHANNELS-sample slice.

Panics

Panics if y >= height.

pub fn rows(self) -> impl ExactSizeIterator<Item = &'a [P::Sample]>

Iterates the rows top to bottom, each a width * P::CHANNELS-sample slice.

pub fn pixel(self, x: u32, y: u32) -> &'a [P::Sample]

The P::CHANNELS samples of the pixel at (x, y).

Panics

Panics if x >= width or y >= height.

Trait Implementations

impl<'a, P: Clone + Pixel> Clone for ImageRef<'a, P>

where P::Sample: Clone,

fn clone(&self) -> ImageRef<'a, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, P: Copy + Pixel> Copy for ImageRef<'a, P>

where P::Sample: Copy,

impl<'a, P: Debug + Pixel> Debug for ImageRef<'a, P>

where P::Sample: Debug,

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

Formats the value using the given formatter.