DD::Image::PlanarReadInfo Class Reference

Information about a generic image plane, as opposed to a scan line, and how it can be read and decoded. More...

#include <PlanarReadInfo.h>

Public Member Functions
	PlanarReadInfo (GenericImagePlaneDescriptor &desc, size_t readPassBufferSize, bool isDecodeThreadable, bool isValid)
	PlanarReadInfo ()
const GenericImagePlaneDescriptor &	genericImagePlaneDescriptor () const
size_t	readPassBufferSize () const
bool	isDecodeThreadable () const
bool	isValid () const
bool	operator== (const PlanarReadInfo &rhs) const
bool	operator!= (const PlanarReadInfo &rhs) const

Protected Attributes
GenericImagePlaneDescriptor	_genericImagePlaneDescriptor
	Describes the image data format, size, etc.
size_t	_readPassBufferSize
	If decoupling read from decode, what is the size of the buffer to read into.
bool	_isDecodeThreadable
	Can we run the decode in multiple threads?
bool	_isValid

Detailed Description

Information about a generic image plane, as opposed to a scan line, and how it can be read and decoded.

Constructor & Destructor Documentation

PlanarReadInfo()

DD::Image::PlanarReadInfo::PlanarReadInfo ( )

inline

The default constructor creates an invalid PlanarReadInfo object. Since the interface is read-only the created object cannot be subsequently modified to become valid. This should be used in appropriate situations to indicate that no valid image plane is possible (e.g., if the user has, via planarReadInfo(), requested channels that are not present in the source data).