Type Alias ImgRef

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

Reference to pixels inside another image. Pass this structure by value (i.e. ImgRef, not &ImgRef).

Only width of pixels of every stride can be modified. The buf may be longer than height*stride, but the extra space should be ignored.

Aliased Type

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

Fields

buf: &'slice [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> ImgRef<'slice, T>

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

Make a reference for a part of the image, without copying any pixels.

Panics

It will panic if sub_image is outside of the image area (left + width must be <= container width, etc.)

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

Iterate over whole rows of pixels as slices

Panics

If stride is 0

See also pixels()

impl<'a, T: Clone> ImgRef<'a, T>

pub fn to_contiguous_buf(&self) -> (Cow<'a, [T]>, usize, usize)

Returns a reference to the buffer, width, height. Guarantees that the buffer is contiguous, i.e. it’s width*height elements long, and [x + y*width] addresses each pixel.

It will create a copy if the buffer isn’t contiguous (width != stride). For a more efficient version, see into_contiguous_buf()

impl<'slice, T: Copy> ImgRef<'slice, T>

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

Iterate width*height pixels in the Img, ignoring padding area

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

Panics

if width is 0

impl<'slice, T> ImgRef<'slice, T>

pub fn pixels_ref(&self) -> PixelsRefIter<'slice, T>

Iterate width*height pixels in the Img, by reference, ignoring padding area

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

Panics

if width is 0

Trait Implementations

impl<T: Hash> Hash for ImgRef<'_, 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 ImgRef<'_, 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 ImgRef<'_, 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, U> PartialEq<Img<Vec<U>>> for ImgRef<'_, T>

where T: PartialEq<U>,

fn eq(&self, other: &ImgVec<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 ImgRef<'_, T>