DD::Image::GenericImagePlaneDescriptor Class Reference

Describes a generic image plane which extends DataInfo, a ColorCurve, an ImageDirection and ChannelSwizzling to an ImagePlaneDescriptor. More...

#include <GenericImagePlane.h>

Inheritance diagram for DD::Image::GenericImagePlaneDescriptor:

Public Member Functions
	GenericImagePlaneDescriptor (const ImagePlaneDescriptor &planeDesc, DataInfo dataInfo, ColorCurveEnum colorCurve, ImageDirection imageDirection=ImageDirection::eIncreasingY, std::vector< int > channelSwizzling=std::vector< int >())
const DataInfo &	dataInfo () const
ColorCurveEnum	colorCurve () const
ImageDirection	imageDirection () const
const std::vector< int > &	channelSwizzling () const
bool	operator== (const GenericImagePlaneDescriptor &rhs) const
Public Member Functions inherited from DD::Image::ImagePlaneDescriptor
	ImagePlaneDescriptor (const DD::Image::Box &bounds, bool packed, DD::Image::ChannelSet mask, int nComps)
DD::Image::Box	bounds () const
ChannelSet	channels () const
bool	packed () const
int	nComps () const
bool	intersects (const ImagePlaneDescriptor &other) const
bool	intersects (int y, int t) const
bool	satisfiedBy (const ImagePlaneDescriptor &candidate)

Protected Attributes
DataInfo	_dataInfo
	Info describing the data type, limits, etc, in each channel.
ColorCurveEnum	_colorCurve
	The type of color curve in which the image data is stored.
ImageDirection	_imageDirection
	Indicates the logical y-direction of image is stored in a GenericImagePlane's data buffer.
std::vector< int >	_channelSwizzling
Protected Attributes inherited from DD::Image::ImagePlaneDescriptor
DD::Image::Box	_bounds
bool	_packed
ChannelSet	_mask
int	_nComps

Detailed Description

Describes a generic image plane which extends DataInfo, a ColorCurve, an ImageDirection and ChannelSwizzling to an ImagePlaneDescriptor.

Member Data Documentation

_channelSwizzling

std::vector<int> DD::Image::GenericImagePlaneDescriptor::_channelSwizzling

protected

Optionally specifies how channels are swizzled in a GenericImagePlane's data buffer. For example, client code expects RGBA data in that order, so if the buffer contains BGRA then this should be set to 2, 1, 0, 3. If this is not empty then it should have the same number of entries as in our ChannelSet (in the ImagePlaneDescriptor base class).