HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OCIO_NAMESPACE::PlanarImageDesc Class Reference

#include <OpenColorIO.h>

+ Inheritance diagram for OCIO_NAMESPACE::PlanarImageDesc:

Public Member Functions

 PlanarImageDesc (void *rData, void *gData, void *bData, void *aData, long width, long height)
 
 PlanarImageDesc (void *rData, void *gData, void *bData, void *aData, long width, long height, BitDepth bitDepth, ptrdiff_t xStrideBytes, ptrdiff_t yStrideBytes)
 
virtual ~PlanarImageDesc ()
 
voidgetRData () const override
 Get a pointer to the red channel of the first pixel. More...
 
voidgetGData () const override
 Get a pointer to the green channel of the first pixel. More...
 
voidgetBData () const override
 Get a pointer to the blue channel of the first pixel. More...
 
voidgetAData () const override
 
BitDepth getBitDepth () const override
 Get the bit-depth. More...
 
long getWidth () const override
 Get the width to process (where x position starts at 0 and ends at width-1). More...
 
long getHeight () const override
 Get the height to process (where y position starts at 0 and ends at height-1). More...
 
ptrdiff_t getXStrideBytes () const override
 Get the step in bytes to find the same color channel of the next pixel. More...
 
ptrdiff_t getYStrideBytes () const override
 
bool isRGBAPacked () const override
 
bool isFloat () const override
 Is the image buffer 32-bit float? More...
 
- Public Member Functions inherited from OCIO_NAMESPACE::ImageDesc
 ImageDesc ()
 
virtual ~ImageDesc ()
 

Detailed Description

All the constructors expect pointers to the specified image planes (i.e. rrrr gggg bbbb) starting at the first color channel of the first pixel to process (which need not be the first pixel of the image). Pass NULL for aData if no alpha exists (r/g/bData must not be NULL).

Note
The methods assume the CPUProcessor bit-depth type for the R/G/B/A data pointers.

Definition at line 2647 of file OpenColorIO.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::PlanarImageDesc::PlanarImageDesc ( void rData,
void gData,
void bData,
void aData,
long  width,
long  height 
)
OCIO_NAMESPACE::PlanarImageDesc::PlanarImageDesc ( void rData,
void gData,
void bData,
void aData,
long  width,
long  height,
BitDepth  bitDepth,
ptrdiff_t  xStrideBytes,
ptrdiff_t  yStrideBytes 
)

Note that although PlanarImageDesc is powerful enough to also describe all PackedImageDesc scenarios, it is recommended to use a PackedImageDesc where possible since that allows for additional optimizations.

virtual OCIO_NAMESPACE::PlanarImageDesc::~PlanarImageDesc ( )
virtual

Member Function Documentation

void* OCIO_NAMESPACE::PlanarImageDesc::getAData ( ) const
overridevirtual

Get a pointer to the alpha channel of the first pixel or null as alpha channel is optional.

Implements OCIO_NAMESPACE::ImageDesc.

void* OCIO_NAMESPACE::PlanarImageDesc::getBData ( ) const
overridevirtual

Get a pointer to the blue channel of the first pixel.

Implements OCIO_NAMESPACE::ImageDesc.

BitDepth OCIO_NAMESPACE::PlanarImageDesc::getBitDepth ( ) const
overridevirtual

Get the bit-depth.

Implements OCIO_NAMESPACE::ImageDesc.

void* OCIO_NAMESPACE::PlanarImageDesc::getGData ( ) const
overridevirtual

Get a pointer to the green channel of the first pixel.

Implements OCIO_NAMESPACE::ImageDesc.

long OCIO_NAMESPACE::PlanarImageDesc::getHeight ( ) const
overridevirtual

Get the height to process (where y position starts at 0 and ends at height-1).

Implements OCIO_NAMESPACE::ImageDesc.

void* OCIO_NAMESPACE::PlanarImageDesc::getRData ( ) const
overridevirtual

Get a pointer to the red channel of the first pixel.

Implements OCIO_NAMESPACE::ImageDesc.

long OCIO_NAMESPACE::PlanarImageDesc::getWidth ( ) const
overridevirtual

Get the width to process (where x position starts at 0 and ends at width-1).

Implements OCIO_NAMESPACE::ImageDesc.

ptrdiff_t OCIO_NAMESPACE::PlanarImageDesc::getXStrideBytes ( ) const
overridevirtual

Get the step in bytes to find the same color channel of the next pixel.

Implements OCIO_NAMESPACE::ImageDesc.

ptrdiff_t OCIO_NAMESPACE::PlanarImageDesc::getYStrideBytes ( ) const
overridevirtual

Get the step in bytes to find the same color channel of the pixel at the same position in the next line.

Implements OCIO_NAMESPACE::ImageDesc.

bool OCIO_NAMESPACE::PlanarImageDesc::isFloat ( ) const
overridevirtual

Is the image buffer 32-bit float?

Implements OCIO_NAMESPACE::ImageDesc.

bool OCIO_NAMESPACE::PlanarImageDesc::isRGBAPacked ( ) const
overridevirtual

Is the image buffer in packed mode with the 4 color channels? ("Packed" here means that XStrideBytes is 4x the bytes per channel, so it is more specific than simply any PackedImageDesc.)

Implements OCIO_NAMESPACE::ImageDesc.


The documentation for this class was generated from the following file: