OCIO_NAMESPACE::ImageDesc Class Reference

This is a light-weight wrapper around an image, that provides a context for pixel access. This does NOT claim ownership of the pixels or copy image data. More...

#include <OpenColorIO.h>

Inheritance diagram for OCIO_NAMESPACE::ImageDesc:

Public Member Functions
	ImageDesc ()
virtual	~ImageDesc ()
virtual void *	getRData () const =0
	Get a pointer to the red channel of the first pixel. More...
virtual void *	getGData () const =0
	Get a pointer to the green channel of the first pixel. More...
virtual void *	getBData () const =0
	Get a pointer to the blue channel of the first pixel. More...
virtual void *	getAData () const =0
virtual BitDepth	getBitDepth () const =0
	Get the bit-depth. More...
virtual long	getWidth () const =0
	Get the width to process (where x position starts at 0 and ends at width-1). More...
virtual long	getHeight () const =0
	Get the height to process (where y position starts at 0 and ends at height-1). More...
virtual ptrdiff_t	getXStrideBytes () const =0
	Get the step in bytes to find the same color channel of the next pixel. More...
virtual ptrdiff_t	getYStrideBytes () const =0
virtual bool	isRGBAPacked () const =0
virtual bool	isFloat () const =0
	Is the image buffer 32-bit float? More...

Detailed Description

This is a light-weight wrapper around an image, that provides a context for pixel access. This does NOT claim ownership of the pixels or copy image data.

Definition at line 2753 of file OpenColorIO.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::ImageDesc::ImageDesc

(

)

virtual OCIO_NAMESPACE::ImageDesc::~ImageDesc ( )

virtual

Member Function Documentation

virtual void* OCIO_NAMESPACE::ImageDesc::getAData ( ) const

pure virtual

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

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual void* OCIO_NAMESPACE::ImageDesc::getBData ( ) const

pure virtual

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

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual BitDepth OCIO_NAMESPACE::ImageDesc::getBitDepth ( ) const

pure virtual

Get the bit-depth.

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual void* OCIO_NAMESPACE::ImageDesc::getGData ( ) const

pure virtual

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

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual long OCIO_NAMESPACE::ImageDesc::getHeight ( ) const

pure virtual

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

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual void* OCIO_NAMESPACE::ImageDesc::getRData ( ) const

pure virtual

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

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual long OCIO_NAMESPACE::ImageDesc::getWidth ( ) const

pure virtual

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

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual ptrdiff_t OCIO_NAMESPACE::ImageDesc::getXStrideBytes ( ) const

pure virtual

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

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual ptrdiff_t OCIO_NAMESPACE::ImageDesc::getYStrideBytes ( ) const

pure virtual

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

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual bool OCIO_NAMESPACE::ImageDesc::isFloat ( ) const

pure virtual

Is the image buffer 32-bit float?

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

virtual bool OCIO_NAMESPACE::ImageDesc::isRGBAPacked ( ) const

pure virtual

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.)

Implemented in OCIO_NAMESPACE::PlanarImageDesc, and OCIO_NAMESPACE::PackedImageDesc.

---

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

• OpenColorIO/OpenColorIO.h