Struct ImageBuf 

pub struct ImageBuf<P: Pixel> { /* private fields */ }

An owned, length-validated interleaved image of pixel type P.

The owning counterpart of ImageRef; the natural return of a decoder, carrying its dimensions, samples, and layout brand as one unit so a caller can never misinterpret the result.

Implementations

impl<P: Pixel> ImageBuf<P>

pub fn new(data: Vec<P::Sample>, dims: Dimensions) -> Result<Self>

Takes ownership of data as an image of dims, validating its length the same way as ImageRef::new.

Errors

Returns Error::InvalidInput if dims is zero-sized, if the sample count overflows usize, or if data.len() does not equal width * height * P::CHANNELS.

pub fn zeroed(dims: Dimensions) -> Result<Self>

An all-zero image of dims (every sample P::Sample::default()).

Errors

Returns Error::InvalidInput if dims is zero-sized or the sample count overflows usize.

pub fn as_ref(&self) -> ImageRef<'_, P>

Borrows this image as an ImageRef. Infallible — the invariant already holds.

pub fn dimensions(&self) -> Dimensions

The image dimensions.

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

The raw interleaved samples, row-major.

pub fn into_samples(self) -> Vec<P::Sample>

Consumes the image, returning its backing sample vector.

Trait Implementations

impl<P: Clone + Pixel> Clone for ImageBuf<P>

where P::Sample: Clone,

fn clone(&self) -> ImageBuf<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + Pixel> Debug for ImageBuf<P>

where P::Sample: Debug,

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

Formats the value using the given formatter.