Struct openexr::rgba::rgba_file::RgbaInputFile

#[repr(transparent)]
pub struct RgbaInputFile(_);

Simplified interface for reading RGBA files.

Implementations

impl RgbaInputFile

pub fn new<P: AsRef<Path>>(
    filename: P,
    num_threads: i32
) -> Result<RgbaInputFile, Error>

Open the file at path filename, using num_threads threads to do the reading.

Errors

• Error::Base - If an error occurs

pub fn set_frame_buffer(
    &mut self,
    pixels: &mut [Rgba],
    x_stride: usize,
    y_stride: usize
) -> Result<(), Error>

Set a frame buffer as the destination for the decoded pixels

Pixel (x, y) is at offset x * x_stride + y * y_stride

Errors

• Error::InvalidArgument - If the frame buffer’s data type can not be determined

pub fn set_layer_name(&mut self, name: &str)

Sets the layer that subsequent RgbaInputFile::read_pixels calls will read from.

e.g. calling this with "layername" will read channels "layername.R", "layername.G" etc.

Each call to RgbaInputFile::set_layer_name must be followed by a call to RgbaInputFile::set_frame_buffer before reading.

pub fn read_pixels(
    &mut self,
    scanline1: i32,
    scanline2: i32
) -> Result<(), Error>

Read pixel data.

read_pixels(s1,s2) reads all scan lines with y coordinates in the interval [min(s1, s2), max(s1, s2)] from the file, and stores them in the current frame buffer.

Both s1 and s2 must be within the interval [header().data_window().min.y, header().data_window().max.y]

The scan lines can be read from the file in random order, and individual scan lines may be skipped or read multiple times. For maximum efficiency, the scan lines should be read in the order in which they were written to the file.

Errors

• Error::Base - If an error occurs

pub fn header(&self) -> HeaderRef<'_>

Access to the file Header

pub fn is_complete(&self) -> bool

Check if the file is complete.

Returns true if all pixels in the data window are present in the input file, or false if any pixels are missing. (Another program may still be busy writing the file, or file writing may have been aborted prematurely.)

Trait Implementations

impl Drop for RgbaInputFile

fn drop(&mut self)

Executes the destructor for this type.