Struct Image 

pub struct Image<T, const CHANNELS: usize> { /* private fields */ }

An owning, densely packed, interleaved image.

Implementations

impl<T, const CHANNELS: usize> Image<T, CHANNELS>

pub fn try_new( width: usize, height: usize, data: Vec<T>, ) -> Result<Self, ImageError>

Creates an image from densely packed, interleaved scalar elements.

pub fn try_new_with_metadata( width: usize, height: usize, data: Vec<T>, metadata: ImageMetadata, ) -> Result<Self, ImageError>

Creates a packed image and validates its semantic metadata.

pub const fn width(&self) -> usize

Returns image width in pixels.

pub const fn height(&self) -> usize

Returns image height in pixels.

pub const fn row_stride(&self) -> usize

Returns the packed row stride in scalar elements.

pub const fn layout(&self) -> ImageLayout

Returns physical channel layout.

pub const fn metadata(&self) -> ImageMetadata

Returns semantic image metadata.

pub fn set_metadata( &mut self, metadata: ImageMetadata, ) -> Result<(), ImageError>

Replaces semantic metadata after validating the channel count.

pub fn as_slice(&self) -> &[T]

Returns the packed scalar storage.

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns mutable packed scalar storage.

pub fn view(&self) -> ImageView<'_, T, CHANNELS>

Borrows this image as a zero-copy view.

pub fn view_mut(&mut self) -> ImageViewMut<'_, T, CHANNELS>

Borrows this image as a mutable zero-copy view.

pub fn get(&self, x: usize, y: usize) -> Option<&[T; CHANNELS]>

Returns one pixel, or None outside image bounds.

pub fn get_mut(&mut self, x: usize, y: usize) -> Option<&mut [T; CHANNELS]>

Returns one mutable pixel, or None outside image bounds.

pub fn into_vec(self) -> Vec<T>

Consumes the image and returns its packed scalar storage.

impl<T: Clone, const CHANNELS: usize> Image<T, CHANNELS>

pub fn from_pixel( width: usize, height: usize, pixel: [T; CHANNELS], ) -> Result<Self, ImageError>

Creates a densely packed image filled with one pixel value.

Trait Implementations

impl<T: Clone, const CHANNELS: usize> Clone for Image<T, CHANNELS>

fn clone(&self) -> Image<T, CHANNELS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const CHANNELS: usize> Debug for Image<T, CHANNELS>

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

Formats the value using the given formatter.

impl<T, const CHANNELS: usize> Index<(usize, usize)> for Image<T, CHANNELS>

type Output = [T; CHANNELS]

The returned type after indexing.

fn index(&self, (x, y): (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, const CHANNELS: usize> IndexMut<(usize, usize)> for Image<T, CHANNELS>

fn index_mut(&mut self, (x, y): (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: PartialEq, const CHANNELS: usize> PartialEq for Image<T, CHANNELS>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Eq, const CHANNELS: usize> Eq for Image<T, CHANNELS>

impl<T, const CHANNELS: usize> StructuralPartialEq for Image<T, CHANNELS>