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

#include <OpenColorIO.h>

Public Member Functions

bool isNoOp () const
 The in and out bit-depths must be equal for isNoOp to be true. More...
 
bool isIdentity () const
 
bool hasChannelCrosstalk () const
 
const char * getCacheID () const
 
BitDepth getInputBitDepth () const
 Bit-depth of the input pixel buffer. More...
 
BitDepth getOutputBitDepth () const
 Bit-depth of the output pixel buffer. More...
 
DynamicPropertyRcPtr getDynamicProperty (DynamicPropertyType type) const
 
void apply (ImageDesc &imgDesc) const
 Apply to an image with any kind of channel ordering while respecting the input and output bit-depths. More...
 
void apply (const ImageDesc &srcImgDesc, ImageDesc &dstImgDesc) const
 
void applyRGB (float *pixel) const
 
void applyRGBA (float *pixel) const
 
 CPUProcessor (const CPUProcessor &)=delete
 
CPUProcessoroperator= (const CPUProcessor &)=delete
 
 ~CPUProcessor ()
 Do not use (needed only for pybind11). More...
 

Friends

class Processor
 

Detailed Description

Definition at line 2210 of file OpenColorIO.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::CPUProcessor::CPUProcessor ( const CPUProcessor )
delete
OCIO_NAMESPACE::CPUProcessor::~CPUProcessor ( )

Do not use (needed only for pybind11).

Member Function Documentation

void OCIO_NAMESPACE::CPUProcessor::apply ( ImageDesc imgDesc) const

Apply to an image with any kind of channel ordering while respecting the input and output bit-depths.

void OCIO_NAMESPACE::CPUProcessor::apply ( const ImageDesc srcImgDesc,
ImageDesc dstImgDesc 
) const
void OCIO_NAMESPACE::CPUProcessor::applyRGB ( float pixel) const

Apply to a single pixel respecting that the input and output bit-depths be 32-bit float and the image buffer be packed RGB/RGBA.

Note
This is not as efficient as applying to an entire image at once. If you are processing multiple pixels, and have the flexibility, use the above function instead.
void OCIO_NAMESPACE::CPUProcessor::applyRGBA ( float pixel) const
const char* OCIO_NAMESPACE::CPUProcessor::getCacheID ( ) const
DynamicPropertyRcPtr OCIO_NAMESPACE::CPUProcessor::getDynamicProperty ( DynamicPropertyType  type) const

The returned pointer may be used to set the value of any dynamic properties of the requested type. Throws if the requested property is not found. Note that if the processor contains several ops that support the requested property, only one can be dynamic.

Note
The dynamic properties in this object are decoupled from the ones in the Processor it was generated from. For each dynamic property in the Processor, there is one in the CPU processor.
BitDepth OCIO_NAMESPACE::CPUProcessor::getInputBitDepth ( ) const

Bit-depth of the input pixel buffer.

BitDepth OCIO_NAMESPACE::CPUProcessor::getOutputBitDepth ( ) const

Bit-depth of the output pixel buffer.

bool OCIO_NAMESPACE::CPUProcessor::hasChannelCrosstalk ( ) const
bool OCIO_NAMESPACE::CPUProcessor::isIdentity ( ) const

Equivalent to isNoOp from the underlying Processor, i.e., it ignores in/out bit-depth differences.

bool OCIO_NAMESPACE::CPUProcessor::isNoOp ( ) const

The in and out bit-depths must be equal for isNoOp to be true.

CPUProcessor& OCIO_NAMESPACE::CPUProcessor::operator= ( const CPUProcessor )
delete

Friends And Related Function Documentation

friend class Processor
friend

Definition at line 2271 of file OpenColorIO.h.


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