Struct image2::ImageRef

pub struct ImageRef<'a, T: 'a + Type, C: Color> { /* private fields */ }

Image implementation backed by a mutable array reference

Implementations

impl<'a, T: 'a + Type, C: Color> ImageRef<'a, T, C>

pub fn new(width: usize, height: usize, data: &'a mut [T]) -> Self

Create a new ImageRef with the given dimensions and data

Note: this functions does not do any bounds checking regarding the specified size and length of the data

pub fn inner(self) -> &'a mut [T]

Trait Implementations

impl<'a, T: Debug + 'a + Type, C: Debug + Color> Debug for ImageRef<'a, T, C>

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

Formats the value using the given formatter.

impl<'a, T: Type, C: Color> Image<T, C> for ImageRef<'a, T, C>

fn shape(&self) -> (usize, usize, usize)

Returns the width, height and channels of an image

fn data(&self) -> &[T]

An immutable reference to the underlying image data

fn data_mut(&mut self) -> &mut [T]

A mutable reference to the underlying image data

fn width(&self) -> usize

fn height(&self) -> usize

fn channels(&self) -> usize

fn len(&self) -> usize

Get the number of total elements in an image

fn total_bytes(&self) -> usize

Get the total number of bytes needed to store the image data

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

Get the offset of the component at (x, y, c)

fn empty_pixel(&self) -> Vec<T>

Create a new, empty pixel with each component set to 0

fn at_mut(&mut self, x: usize, y: usize) -> &mut [T]

Get a vector of mutable references to each component at (x, y)

fn at(&self, x: usize, y: usize) -> &[T]

Get a vector of immutable references to each component at (x, y)

fn get_pixel<'a, P: PixelMut<'a, T, C>>(&self, x: usize, y: usize, px: &mut P)

Load data from the pixel at (x, y) into px

fn get_pixel_f<'a, P: PixelMut<'a, f64, C>>(&self, x: usize, y: usize, px: &mut P)

Load data from the pixel at (x, y) into px and convert to normalized f64

fn set_pixel<'a, P: Pixel<'a, T, C>>(&mut self, x: usize, y: usize, px: &P)

Set data at (x, y) to px

fn set_pixel_f<'a, P: Pixel<'a, f64, C>>(&mut self, x: usize, y: usize, px: &P)

Set data at (x, y) to px after denormalizing

fn get_f(&self, x: usize, y: usize, c: usize) -> f64

Get a single component at (x, y, c) as a noramlized f64 value

fn set_f(&mut self, x: usize, y: usize, c: usize, f: f64)

Set the component at (x, y, c) using a normalized f64 value

fn get(&self, x: usize, y: usize, c: usize) -> T

Get a single component at (x, y, c)

fn set(&mut self, x: usize, y: usize, c: usize, t: T)

Set a single component at (x, y, c)

fn convert_type<U: Type, I: Image<U, C>>(&self, dest: &mut I)

Convert from type T to type U

fn as_image_ref(&mut self) -> ImageRef<'_, T, C>

Convert Image to ImageRef

fn to_image_ptr<'a>(self) -> ImagePtr<'a, T, C>

Consume and convert Image to ImagePtr

fn for_each<F: Sync + Send + Fn((usize, usize), &mut [T])>(&mut self, f: F)

Iterate over each pixel

fn for_each2<F: Sync + Send + Fn((usize, usize), &mut [T], &[T]), I: Image<T, C>>(
    &mut self,
    other: &I,
    f: F
)

Iterate over each pixel

fn crop(&self, x: usize, y: usize, width: usize, height: usize) -> ImageBuf<T, C>

Create a new image from the region specified by (x, y, width, height)

fn clone(&self) -> ImageBuf<T, C>

fn hash(&self) -> Hash

fn diff<I: Image<T, C>>(&self, other: &I) -> Diff

impl<'a, T: PartialEq + 'a + Type, C: PartialEq + Color> PartialEq<ImageRef<'a, T, C>> for ImageRef<'a, T, C>

fn eq(&self, other: &ImageRef<'a, T, C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, T: 'a + Type, C: Color> StructuralPartialEq for ImageRef<'a, T, C>