Struct openexr::deep::deep_scan_line_input_file::DeepScanLineInputFile

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

Implementations

impl DeepScanLineInputFile

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

Open the file at path filename and read the header.

Errors

• Error::Base - if the file cannot be opened

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

Access to the file Header

pub fn version(&self) -> i32

Access to the file format version

pub fn set_frame_buffer(
    &mut self,
    frame_buffer: &DeepFrameBuffer
) -> Result<(), Error>

Set the current frame buffer – copies the FrameBuffer object into the DeepScanLineInputFile object.

The current frame buffer is the destination for the pixel data read from the file. The current frame buffer must be set at least once before read_pixels() is called. The current frame buffer can be changed after each call to read_pixels().

Errors

• Error::InvalidArgument - if the sampling factors do not match or if the frame buffer does not have a sample count slice.

pub fn frame_buffer(&self) -> DeepFrameBufferRef<'_>

Access to the current frame buffer

pub fn is_complete(&self) -> bool

Check if all pixels in the data window are present in the input file

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

Read all scanlines in the range [s1, s2] and put them in the current frame buffer.

read_pixel_sample_counts() must be called before calling this method.

Errors

• Error::InvalidArgument - if no frame buffer has been set, if s1 or s2 are outside the data window, or if the sample counts have not been read yet
• Error::Base - if any other error occurs

pub fn read_pixel_sample_counts(
    &mut self,
    s1: i32,
    s2: i32
) -> Result<(), Error>

Read the sample counts for each pixel and place them in the sample count slice in the frame buffer.

Errors

• Error::InvalidArgument - if s1 or s2 are outside the data window.