Struct openexr::header::Header

pub struct Header { /* fields omitted */ }

Represents an OpenEXR file header.

The file header describes the properties of the image, such as image resolution, the channels it contains, custom attributes, etc. It is used both for fetching information about a loaded EXR file and for defining the properties of a file to be written.

Examples

Creating a header for a file that will be written:

use openexr::{Header, PixelType};

Header::new()
    .set_resolution(1920, 1080)
    .add_channel("R", PixelType::FLOAT)
    .add_channel("G", PixelType::FLOAT)
    .add_channel("B", PixelType::FLOAT);

Methods

impl Header

pub fn new() -> Self

Creates a new header.

pub fn set_resolution(&mut self, width: u32, height: u32) -> &mut Self

Sets the resolution.

This is really just a shortcut for setting both the display window and data window to (0, 0), (width-1, height-1).

pub fn set_display_window(&mut self, window: Box2i) -> &mut Self

Sets the display window.

For simple use-cases, it's better to use set_resolution() instead.

pub fn set_data_window(&mut self, window: Box2i) -> &mut Self

Sets the data window.

For simple use-cases, it's better to use set_resolution() instead.

pub fn set_pixel_aspect_ratio(&mut self, aspect_ratio: f32) -> &mut Self

Sets the pixel aspect ratio.

pub fn set_screen_window_center(&mut self, center: (f32, f32)) -> &mut Self

Sets the screen window center.

pub fn set_screen_window_width(&mut self, width: f32) -> &mut Self

Sets the screen window width.

pub fn set_line_order(&mut self, line_order: LineOrder) -> &mut Self

Sets the line order.

pub fn set_compression(&mut self, compression: Compression) -> &mut Self

Sets the compression mode.

pub fn add_channel(&mut self, name: &str, pixel_type: PixelType) -> &mut Self

Adds a channel.

This is a simplified version of add_channel_detailed(), using some reasonable defaults for the details. Specifically: sampling is set to (1, 1) and p_linear is set to true.

pub fn add_channel_detailed(
    &mut self,
    name: &str,
    channel: Channel
) -> &mut Self

Adds a channel, specifying full details.

pub fn data_origin(&self) -> (i32, i32)

Convenience method for the origin (min coordinate) of the data window.

pub fn data_dimensions(&self) -> (u32, u32)

Convenience method for the dimensions of the data window.

pub fn data_window(&self) -> &Box2i

Access to the data window.

pub fn display_window(&self) -> &Box2i

Access to the display window.

Important traits for ChannelIter<'a>

impl<'a> Iterator for ChannelIter<'a> type Item = Result<(&'a str, Channel)>;

pub fn channels(&self) -> ChannelIter

Returns an iterator over the channels in the header.

pub fn get_channel<'a>(&'a self, name: &str) -> Option<&'a Channel>

Access channels by name.

pub fn envmap(&self) -> Option<Envmap>

Determine whether this header describes an environment map, and if so, what type

pub fn set_envmap(&mut self, envmap: Option<Envmap>) -> &mut Self

Declare whether this header represents an environment map

pub fn multiview(&self) -> Option<impl Iterator<Item = &str>>

Access the list of view names, if any

pub fn set_multiview(&mut self, views: Option<&[&str]>) -> &mut Self

Set the list of view names

pub fn box2i(x: i32, y: i32, width: u32, height: u32) -> Box2i

Utility function to create a Box2i specifying its origin (bottom left) and size

Trait Implementations

impl Default for Header

fn default() -> Header

Returns the "default value" for a type.

impl Drop for Header

fn drop(&mut self)

Executes the destructor for this type.