Struct ImageStore

pub struct ImageStore<'a, T, const N: usize>
where
    T: Clone + Copy + Debug,
{
    pub buffer: Cow<'a, [T]>,
    pub channels: usize,
    pub width: usize,
    pub height: usize,
    pub stride: usize,
    pub bit_depth: usize,
}

Holds an image

Arguments

N - count of channels

Examples

ImageStore<u8, 4> - represents RGBA ImageStore<u8, 3> - represents RGB ImageStore<f32, 3> - represents RGB in f32 and etc

Fields

buffer: Cow<'a, [T]>

channels: usize

Channels in the image

width: usize

Image width

height: usize

Image height

stride: usize

Image stride, if stride is zero then it considered to be width * N

bit_depth: usize

This is private field, currently used only for u16, will be automatically passed from upper func

Implementations

impl<'a, T, const N: usize> ImageStore<'a, T, N>

where T: Clone + Copy + Debug + Default,

pub fn new( slice_ref: Vec<T>, width: usize, height: usize, ) -> Result<ImageStore<'a, T, N>, PicScaleError>

Creates new store

pub fn borrow( slice_ref: &'a [T], width: usize, height: usize, ) -> Result<ImageStore<'a, T, N>, PicScaleError>

Borrows immutable slice as new image store

pub fn alloc(width: usize, height: usize) -> ImageStore<'a, T, N>

Allocates new owned image store

impl<T, const N: usize> ImageStore<'_, T, N>

where T: Clone + Copy + Debug,

pub fn stride(&self) -> usize

Returns safe stride

If stride set to 0 then returns width * N

impl<'a, T, const N: usize> ImageStore<'a, T, N>

where T: Clone + Copy + Debug,

pub fn get_size(&self) -> ImageSize

Returns bounded image size

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

Returns current image store as immutable slice

pub fn from_slice( slice_ref: &'a [T], width: usize, height: usize, ) -> Result<ImageStore<'a, T, N>, PicScaleError>

Borrows immutable slice int oa new image store

pub fn copied<'b>(&self) -> ImageStore<'b, T, N>

Deep copy immutable image store into a new immutable store

pub fn copied_to_mut(&self, into: &mut ImageStoreMut<'_, T, N>)

Deep copy immutable image into mutable

Trait Implementations

impl<'a, T, const N: usize> Clone for ImageStore<'a, T, N>

where T: Clone + Copy + Debug + Clone,

fn clone(&self) -> ImageStore<'a, T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T, const N: usize> Debug for ImageStore<'a, T, N>

where T: Clone + Copy + Debug + Debug,

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

Formats the value using the given formatter.