Struct exr::image::Image

pub struct Image<Layers> {
    pub attributes: ImageAttributes,
    pub layer_data: Layers,
}

The complete exr image. Layers can be either a single Layer or Layers.

Fields

attributes: ImageAttributes

Attributes that apply to the whole image file. These attributes appear in each layer of the file. Excludes technical meta data. Each layer in this image also has its own attributes.

layer_data: Layers

The layers contained in the image file. Can be either a single Layer or a list of layers.

Implementations

impl<'s, LayerData: 's> Image<LayerData> where
    LayerData: WritableLayers<'s>, 

pub fn new(image_attributes: ImageAttributes, layer_data: LayerData) -> Self

Create an image with one or multiple layers. The layer can be a Layer, or Layers small vector, or Vec<Layer> or &[Layer].

impl<'s, Channels: 's> Image<Layers<Channels>> where
    Channels: WritableChannels<'s>, 

pub fn from_layers(
    image_attributes: ImageAttributes,
    layer_data: impl Into<Layers<Channels>>
) -> Self

Create an image with multiple layers. The layer can be a Vec<Layer> or Layers (a small vector).

impl<'s, ChannelData: 's> Image<Layer<ChannelData>> where
    ChannelData: WritableChannels<'s>, 

pub fn from_layer(layer: Layer<ChannelData>) -> Self

Uses the display position and size to the channel position and size of the layer.

pub fn from_encoded_channels(
    size: impl Into<Vec2<usize>>,
    encoding: Encoding,
    channels: ChannelData
) -> Self

Uses empty attributes.

pub fn from_channels(
    size: impl Into<Vec2<usize>>,
    channels: ChannelData
) -> Self

Uses empty attributes and fast compression.

impl Image<NoneMore>

pub fn empty(attributes: ImageAttributes) -> Self

Create an empty image, to be filled with layers later on. Add at least one layer to obtain a valid image. Call with_layer(another_layer) for each layer you want to add to this image.

impl<'s, InnerLayers: 's> Image<InnerLayers> where
    InnerLayers: WritableLayers<'s>, 

pub fn with_layer<NewChannels>(
    self,
    layer: Layer<NewChannels>
) -> Image<Recursive<InnerLayers, Layer<NewChannels>>> where
    NewChannels: 's + WritableChannels<'s>, 

Add another layer to this image. The layer type does not have to equal the existing layers in this image.

Trait Implementations

impl<Layers: Clone> Clone for Image<Layers>

fn clone(&self) -> Image<Layers>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Layers: Debug> Debug for Image<Layers>

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

Formats the value using the given formatter.

impl<Layers: PartialEq> PartialEq<Image<Layers>> for Image<Layers>

fn eq(&self, other: &Image<Layers>) -> bool

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

fn ne(&self, other: &Image<Layers>) -> bool

This method tests for !=.

impl<C> ValidateResult for Image<C> where
    C: 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<'img, WritableLayers> WritableImage<'img, WritableLayers> for &'img Image<WritableLayers>

fn write(self) -> WriteImageWithOptions<'img, WritableLayers, fn(_: f64)>

Create a temporary writer which can be configured and used to write the image to a file.

impl<Layers> StructuralPartialEq for Image<Layers>