Type Alias ImgRefMut

pub type ImgRefMut<'slice, Pixel> = Img<&'slice mut [Pixel]>;

Same as ImgRef, but mutable Pass this structure by value (i.e. ImgRef, not &ImgRef).

Aliased Type

pub struct ImgRefMut<'slice, Pixel> {
    pub buf: &'slice mut [Pixel],
    pub stride: usize,
    pub width: u32,
    pub height: u32,
}

Fields

buf: &'slice mut [Pixel]

👎Deprecated: Don’t access struct fields directly. Use buf(), buf_mut() or into_buf()

Storage for the pixels. Usually Vec<Pixel> or &[Pixel]. See ImgVec and ImgRef.

Note that future version will make this field private. Use .rows() and .pixels() iterators where possible, or buf()/buf_mut()/into_buf().

stride: usize

👎Deprecated: Don’t access struct fields directly. Use stride()

Number of pixels to skip in the container to advance to the next row.

Note: pixels between width and stride may not be usable, and may not even exist in the last row.

width: u32

👎Deprecated: Don’t access struct fields directly. Use width()

Width of the image in pixels.

Note that this isn’t same as the width of the row in the buf, see stride

height: u32

👎Deprecated: Don’t access struct fields directly. Use height()

Height of the image in pixels.

Implementations

impl<'slice, T> ImgRefMut<'slice, T>

pub fn sub_image( &'slice self, left: usize, top: usize, width: usize, height: usize, ) -> ImgRef<'slice, T>

Turn this into immutable reference, and slice a subregion of it

pub fn sub_image_mut( &mut self, left: usize, top: usize, width: usize, height: usize, ) -> ImgRefMut<'_, T>

Slices this image reference to produce another reference to a subregion of it.

Note that mutable borrows are exclusive, so it’s not possible to have more than one mutable subimage at a time.

Panics

If the coordinates are out of bounds

pub fn into_sub_image_mut( self, left: usize, top: usize, width: usize, height: usize, ) -> Self

Transforms this image reference to refer to a subregion.

This is identical in behavior to ImgRefMut::sub_image_mut(), except that it returns an ImgRefMut with the same lifetime, rather than a reborrow with a shorter lifetime.

Panics

If the coordinates are out of bounds

pub fn as_ref(&self) -> ImgRef<'_, T>

Make mutable reference immutable

impl<T: Copy> ImgRefMut<'_, T>

pub fn pixels(&self) -> PixelsIter<'_, T>

Panics

If you want to iterate in parallel, parallelize rows() instead.

if width is 0

impl<T> ImgRefMut<'_, T>

pub fn pixels_mut(&mut self) -> PixelsIterMut<'_, T>

If you want to iterate in parallel, parallelize rows() instead.

Panics

if width is 0

impl<T> ImgRefMut<'_, T>

pub fn rows(&self) -> RowsIter<'_, T>

Iterate over whole rows as slices

Panics

if stride is 0

pub fn rows_mut(&mut self) -> RowsIterMut<'_, T>

Iterate over whole rows as slices

Panics

if stride is 0

Trait Implementations

impl<T: Hash> Hash for ImgRefMut<'_, T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'b, T, U> PartialEq<Img<&'b [U]>> for ImgRefMut<'_, T>

where T: PartialEq<U>,

fn eq(&self, other: &ImgRef<'b, U>) -> 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<'b, T, U> PartialEq<Img<&'b mut [U]>> for ImgRefMut<'_, T>

where T: PartialEq<U>,

fn eq(&self, other: &ImgRefMut<'b, U>) -> 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> Eq for ImgRefMut<'_, T>