Struct image::codecs::openexr::OpenExrDecoder

pub struct OpenExrDecoder<R> { /* private fields */ }

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

Implementations

impl<R: Read + 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.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'a, R: 'a + Read + Seek> ImageDecoder<'a> for OpenExrDecoder<R>

fn into_reader(self) -> ImageResult<Self::Reader>

Use read_image instead if possible, as this method creates a whole new buffer just to contain the entire image.

type Reader = Cursor<Vec<u8, Global>>

The type of reader produced by into_reader.

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

Retuns the color type of the image file before decoding

fn scanline_bytes(&self) -> u64

Returns the minimum number of bytes that can be efficiently read from this decoder. This may be as few as 1 or as many as total_bytes().

fn read_image_with_progress<F: Fn(Progress)>(
    self,
    unaligned_bytes: &mut [u8],
    progress_callback: F
) -> ImageResult<()>

Same as read_image but periodically calls the provided callback to give updates on loading progress.

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

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

Returns all the bytes in the image.

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

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