Struct OpenExrDecoder

pub struct OpenExrDecoder<R> {
    exr_reader: Reader<R>,
    header_index: usize,
    alpha_preference: Option<bool>,
    alpha_present_in_file: bool,
}

An OpenEXR decoder. Immediately reads the meta data from the file.

Fields

exr_reader: Reader<R>

header_index: usize

alpha_preference: Option<bool>

alpha_present_in_file: bool

Implementations

impl<R: BufRead + Seek> OpenExrDecoder<R>

pub fn new(source: R) -> ImageResult<Self>

Create a decoder. Consumes the first few bytes of the source to extract image dimensions. Assumes the reader is buffered. In most cases, you should wrap your reader in a BufReader for best performance. Loads an alpha channel if the file has alpha samples. Use with_alpha_preference if you want to load or not load alpha unconditionally.

pub fn with_alpha_preference( source: R, alpha_preference: Option<bool>, ) -> ImageResult<Self>

Create a decoder. Consumes the first few bytes of the source to extract image dimensions. Assumes the reader is buffered. In most cases, you should wrap your reader in a BufReader for best performance. If alpha preference is specified, an alpha channel will always be present or always be not present in the returned image. If alpha preference is none, the alpha channel will only be returned if it is found in the file.

fn selected_exr_header(&self) -> &Header

Trait Implementations

impl<R: Debug> Debug for OpenExrDecoder<R>

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

Formats the value using the given formatter.

impl<R: BufRead + Seek> ImageDecoder for OpenExrDecoder<R>

fn dimensions(&self) -> (u32, u32)

Returns a tuple containing the width and height of the image

fn color_type(&self) -> ColorType

Returns the color type of the image data produced by this decoder

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding

fn read_image(self, unaligned_bytes: &mut [u8]) -> ImageResult<()>

Returns all the bytes in the image.

fn read_image_boxed(self: Box<Self>, buf: &mut [u8]) -> ImageResult<()>

Use read_image instead; this method is an implementation detail needed so the trait can be object safe.

fn icc_profile(&mut self) -> ImageResult<Option<Vec<u8>>>

Returns the ICC color profile embedded in the image, or Ok(None) if the image does not have one.

fn exif_metadata(&mut self) -> ImageResult<Option<Vec<u8>>>

Returns the raw Exif chunk, if it is present. A third-party crate such as kamadak-exif is required to actually parse it.

fn orientation(&mut self) -> ImageResult<Orientation>

Returns the orientation of the image.

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

fn set_limits(&mut self, limits: Limits) -> ImageResult<()>

Set the decoder to have the specified limits. See Limits for the different kinds of limits that is possible to set.