Struct exr::image::pixel_vec::PixelVec

pub struct PixelVec<T> {
    pub resolution: Vec2<usize>,
    pub pixels: Vec<T>,
}

Store all samples in a single array. All samples will be converted to the type T. This supports all the sample types, f16, f32, and u32.

The flattened vector contains all rows one after another. In each row, for each pixel, its red, green, blue, and then alpha samples are stored one after another.

Use PixelVec.compute_pixel_index(position) to compute the flat index of a specific pixel.

Fields

resolution: Vec2<usize>

The resolution of this layer.

pixels: Vec<T>

The flattened vector contains all rows one after another. In each row, for each pixel, its red, green, blue, and then alpha samples are stored one after another.

Use Flattened::compute_pixel_index(image, position) to compute the flat index of a specific pixel.

Implementations

impl<Pixel> PixelVec<Pixel>

pub fn constructor<Channels>(resolution: Vec2<usize>, _: &Channels) -> Self where
    Pixel: Default + Clone, 

Create a new flattened pixel storage, filled with default pixels. Accepts a Channels parameter, which is not used, so that it can be passed as a function pointer instead of calling it.

pub fn get_pixel(&self, position: Vec2<usize>) -> &Pixel where
    Pixel: Sync, 

Examine a pixel of a PixelVec<T> image. Can usually be used as a function reference instead of calling it directly.

pub fn set_pixel(&mut self, position: Vec2<usize>, pixel: Pixel)

Update a pixel of a PixelVec<T> image. Can usually be used as a function reference instead of calling it directly.

pub fn new(resolution: impl Into<Vec2<usize>>, pixels: Vec<Pixel>) -> Self

Create a new flattened pixel storage, checking the length of the provided pixels vector.

pub fn compute_pixel_index(&self, position: Vec2<usize>) -> usize

Compute the flat index of a specific pixel. Returns a range of either 3 or 4 samples. The computed index can be used with PixelVec.samples[index]. Panics for invalid sample coordinates.

Trait Implementations

impl<T: Clone> Clone for PixelVec<T>

fn clone(&self) -> PixelVec<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PixelVec<T>

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

Formats the value using the given formatter.

impl<Px> GetPixel for PixelVec<Px> where
    Px: Clone + Sync, 

type Pixel = Px

The pixel tuple containing f32, f16, u32 and Sample values. The length of the tuple must match the number of channels in the image.

fn get_pixel(&self, position: Vec2<usize>) -> Self::Pixel

Inspect a single pixel at the requested position. Will be called exactly once for each pixel in the image. The position will not exceed the image dimensions. Might be called from multiple threads at the same time.

impl<T: PartialEq> PartialEq<PixelVec<T>> for PixelVec<T>

fn eq(&self, other: &PixelVec<T>) -> bool

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

fn ne(&self, other: &PixelVec<T>) -> bool

This method tests for !=.

impl<Px> ValidateResult for PixelVec<Px> where
    Px: ValidateResult, 

fn validate_result(
    &self,
    other: &Self,
    options: ValidationOptions,
    location: String
) -> ValidationResult

Compare self with the other. Exceptional behaviour:

fn assert_equals_result(&self, result: &Self)

Compare self with the other. Panics if not equal.

impl<T: Eq> Eq for PixelVec<T>

impl<T> StructuralEq for PixelVec<T>

impl<T> StructuralPartialEq for PixelVec<T>