Struct ImageStoreMut

pub struct ImageStoreMut<'a, T, const N: usize>
where
    T: Clone + Copy + Debug,
{
    pub buffer: BufferStore<'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: BufferStore<'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

Required for u16 images

Implementations

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

where T: Clone + Copy + Debug + Default,

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

Creates new mutable storage from vector

Always sets bit-depth to 0

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

Creates new mutable storage from slice

Always sets bit-depth to 0

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

Allocates new mutable image storage

Always sets bit depth to 0

pub fn alloc_with_depth( width: usize, height: usize, bit_depth: usize, ) -> ImageStoreMut<'a, T, N>

Allocates new mutable image storage with required bit-depth

impl<T, const N: usize> ImageStoreMut<'_, 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> ImageStoreMut<'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 as immutable slice

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

Borrows mutable slice as new image store

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

Performs deep copy into a new mutable image

pub fn to_immutable(&self) -> ImageStore<'_, T, N>

Performs deep copy into a new immutable image

Trait Implementations

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

where T: Clone + Copy + Debug + Debug,

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

Formats the value using the given formatter.