RenderManAPI  24.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RixColorManager Class Referenceabstract

The color manager wraps the active OpenColorIO configuration (if any) to provide color management functions exclusively to shading plugins. More...

#include <RixInterfaces.h>

Inherits RixInterface.

Public Types

enum  Type {
  k_Float, k_Integer, k_StringV, k_Color,
  k_Normal, k_Vector, k_Point, k_HPoint,
  k_MPoint, k_Matrix
}
 

Public Member Functions

virtual bool ColorManagementEnabled ()=0
 Return true if color management is enabled. More...
 
virtual int BaseColorSpace ()=0
 
virtual RtColorRGB BlackbodyToColorSpace (RtColorRGB &in)=0
 
virtual void NormalizeColor (RtColorRGB &inout)=0
 
virtual RtColorRGB LumaCoefs ()=0
 Return the current color space's luminance coefficients. More...
 
virtual int GetProcessor (std::string inputRole)=0
 
virtual void ProcessColor (int processorId, RtColorRGB &inout)=0
 
virtual int GetVersion () const
 Get the version number of this interface. More...
 

Protected Member Functions

 RixColorManager ()
 constructor for internal use only More...
 

Protected Attributes

int m_version
 Version number of this interface. More...
 

Detailed Description

The color manager wraps the active OpenColorIO configuration (if any) to provide color management functions exclusively to shading plugins.

Member Enumeration Documentation

◆ Type

enum RixInterface::Type
inherited
Enumerator
k_Float 
k_Integer 
k_StringV 
k_Color 
k_Normal 
k_Vector 
k_Point 
k_HPoint 
k_MPoint 
k_Matrix 

Constructor & Destructor Documentation

◆ RixColorManager()

RixColorManager::RixColorManager ( )
inlineprotected

constructor for internal use only

Member Function Documentation

◆ BaseColorSpace()

virtual int RixColorManager::BaseColorSpace ( )
pure virtual

◆ BlackbodyToColorSpace()

virtual RtColorRGB RixColorManager::BlackbodyToColorSpace ( RtColorRGB &  in)
pure virtual

◆ ColorManagementEnabled()

virtual bool RixColorManager::ColorManagementEnabled ( )
pure virtual

Return true if color management is enabled.

◆ GetProcessor()

virtual int RixColorManager::GetProcessor ( std::string  inputRole)
pure virtual

◆ GetVersion()

virtual int RixInterface::GetVersion ( ) const
inlinevirtualinherited

Get the version number of this interface.

Different interfaces might have different version numbers in a given release.

References RixInterface::m_version.

◆ LumaCoefs()

virtual RtColorRGB RixColorManager::LumaCoefs ( )
pure virtual

Return the current color space's luminance coefficients.

◆ NormalizeColor()

virtual void RixColorManager::NormalizeColor ( RtColorRGB &  inout)
pure virtual

◆ ProcessColor()

virtual void RixColorManager::ProcessColor ( int  processorId,
RtColorRGB &  inout 
)
pure virtual

Member Data Documentation

◆ m_version

int RixInterface::m_version
protectedinherited

Version number of this interface.

Referenced by RixInterface::GetVersion().

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