Struct exr::image::Layer

pub struct Layer<Channels> {
    pub channel_data: Channels,
    pub attributes: LayerAttributes,
    pub size: Vec2<usize>,
    pub encoding: Encoding,
}

A single Layer, including fancy attributes and compression settings. Channels can be either SpecificChannels or AnyChannels

Fields

channel_data: Channels

The actual pixel data. Either SpecificChannels or AnyChannels

attributes: LayerAttributes

Attributes that apply to this layer. May still contain attributes that should be considered global for an image file. Excludes technical meta data: Does not contain data window size, line order, tiling, or compression attributes. The image also has attributes, which do not differ per layer.

size: Vec2<usize>

The pixel resolution of this layer. See layer.attributes for more attributes, like for example layer position.

encoding: Encoding

How the pixels are split up and compressed.

Implementations

impl<Channels> Layer<Channels>

pub fn absolute_bounds(&self) -> IntegerBounds

Sometimes called “data window”

impl Layer<AnyChannels<FlatSamples>>

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

Use samples_at if you can borrow from this layer

pub fn samples_at(&self, position: Vec2<usize>) -> FlatSampleIterator<'_>

Lookup all channels of a single pixel in the image

impl<'s, ChannelData: 's> Layer<ChannelData>

pub fn new(
    dimensions: impl Into<Vec2<usize>>,
    attributes: LayerAttributes,
    encoding: Encoding,
    channels: ChannelData
) -> Self where
    ChannelData: WritableChannels<'s>, 

Create a layer with the specified size, attributes, encoding and channels. The channels can be either SpecificChannels or AnyChannels.

pub fn levels_with_resolution<'l, L>(
    &self,
    levels: &'l Levels<L>
) -> Box<dyn Iterator<Item = (&'l L, Vec2<usize>)> + 'l>

Panics for images with Scanline encoding.

Trait Implementations

impl ApplyCroppedView for Layer<CroppedChannels<AnyChannels<FlatSamples>>>

type Reallocated = Layer<AnyChannels<FlatSamples>>

The simpler type after cropping is realized

fn reallocate_cropped(self) -> Self::Reallocated

Make the cropping real by reallocating the underlying storage, with the goal of reducing total memory usage. Currently not supported for SpecificChannels.

impl<Channels: Clone> Clone for Layer<Channels>

fn clone(&self) -> Layer<Channels>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Channels> Crop for Layer<Channels>

type Cropped = Layer<CroppedChannels<Channels>>

The type of this image after cropping (probably the same as before)

fn crop(self, bounds: IntegerBounds) -> Self::Cropped

Crop the image to exclude unwanted pixels. Panics for invalid (larger than previously) bounds. The bounds are specified in absolute coordinates. Does not reduce allocation size of the current image, but instead only adjust a few boundary numbers. Use reallocate_cropped() on the return value to actually reduce the memory footprint.

fn try_crop(
    self,
    bounds: Option<IntegerBounds>
) -> CropResult<Self::Cropped, Self>

Reduce your image to a smaller part, usually to save memory. Crop if bounds are specified, return the original if no bounds are specified. Does not reduce allocation size of the current image, but instead only adjust a few boundary numbers. Use reallocate_cropped() on the return value to actually reduce the memory footprint.

impl<Channels: Debug> Debug for Layer<Channels>

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

Formats the value using the given formatter.

impl<S> GetBounds for Layer<S>

fn bounds(&self) -> IntegerBounds

The bounding rectangle of this pixel grid.

impl<Samples, Channels> InspectSample for Layer<SpecificChannels<Samples, Channels>> where
    Samples: GetPixel, 

type Sample = <Samples as GetPixel>::Pixel

The type of pixel in this pixel grid.

fn inspect_sample(&self, local_index: Vec2<usize>) -> Samples::Pixel

Index is not in world coordinates, but within the data window. Position (0,0) always represents the top left pixel.

impl InspectSample for Layer<AnyChannels<FlatSamples>>

type Sample = SmallVec<[Sample; 8]>

The type of pixel in this pixel grid.

fn inspect_sample(&self, local_index: Vec2<usize>) -> FlatSamplesPixel

Index is not in world coordinates, but within the data window. Position (0,0) always represents the top left pixel.

impl<Channels: PartialEq> PartialEq<Layer<Channels>> for Layer<Channels>

fn eq(&self, other: &Layer<Channels>) -> bool

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

fn ne(&self, other: &Layer<Channels>) -> bool

This method tests for !=.

impl<S> ValidateResult for Layer<AnyChannels<S>> where
    AnyChannel<S>: ValidateResult,
    S: for<'a> WritableSamples<'a>, 

fn validate_result(
    &self,
    other: &Self,
    _overridden: 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<Px, Desc> ValidateResult for Layer<SpecificChannels<Px, Desc>> where
    SpecificChannels<Px, Desc>: ValidateResult, 

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

This does an approximate comparison for all channels, even if some channels can be compressed without loss.

fn assert_equals_result(&self, result: &Self)

Compare self with the other. Panics if not equal.

impl<'slf, Channels: WritableChannels<'slf>> WritableLayers<'slf> for Layer<Channels>

fn infer_headers(&self, image_attributes: &ImageAttributes) -> Headers

Generate the file meta data for this list of layers

type Writer = LayerWriter<<Channels as WritableChannels<'slf>>::Writer>

The type of temporary writer

fn create_writer(&'slf self, headers: &[Header]) -> Self::Writer

Create a temporary writer for this list of layers

impl<Channels> StructuralPartialEq for Layer<Channels>