HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OpenColorTypes.h File Reference
#include "OpenColorABI.h"
#include <limits>
#include <string>
+ Include dependency graph for OpenColorTypes.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef OCIO_SHARED_PTR< const
Config
ConstConfigRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< ConfigConfigRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
ColorSpace
ConstColorSpaceRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< ColorSpace
ColorSpaceRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
Look
ConstLookRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< LookLookRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
Context
ConstContextRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< ContextContextRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
Processor
ConstProcessorRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< Processor
ProcessorRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
ProcessorMetadata
ConstProcessorMetadataRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< ProcessorMetadata
ProcessorMetadataRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
Baker
ConstBakerRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< BakerBakerRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
Transform > 
ConstTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< Transform > 
TransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
AllocationTransform
ConstAllocationTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< AllocationTransform
AllocationTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
CDLTransform
ConstCDLTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< CDLTransform
CDLTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
ColorSpaceTransform
ConstColorSpaceTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< ColorSpaceTransform
ColorSpaceTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
DisplayTransform
ConstDisplayTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< DisplayTransform
DisplayTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
ExponentTransform
ConstExponentTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< ExponentTransform
ExponentTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
FileTransform
ConstFileTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< FileTransform
FileTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
GroupTransform
ConstGroupTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< GroupTransform
GroupTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
LogTransform
ConstLogTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< LogTransform
LogTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
LookTransform
ConstLookTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< LookTransform
LookTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
MatrixTransform
ConstMatrixTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< MatrixTransform
MatrixTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR< const
TruelightTransform
ConstTruelightTransformRcPtr
 cpp:type:: More...
 
typedef OCIO_SHARED_PTR
< TruelightTransform
TruelightTransformRcPtr
 cpp:type:: More...
 

Enumerations

enum  LoggingLevel {
  LOGGING_LEVEL_NONE = 0, LOGGING_LEVEL_WARNING = 1, LOGGING_LEVEL_INFO = 2, LOGGING_LEVEL_DEBUG = 3,
  LOGGING_LEVEL_UNKNOWN = 255
}
 rst:: More...
 
enum  ColorSpaceDirection { COLORSPACE_DIR_UNKNOWN = 0, COLORSPACE_DIR_TO_REFERENCE, COLORSPACE_DIR_FROM_REFERENCE }
 cpp:type:: More...
 
enum  TransformDirection { TRANSFORM_DIR_UNKNOWN = 0, TRANSFORM_DIR_FORWARD, TRANSFORM_DIR_INVERSE }
 cpp:type:: More...
 
enum  Interpolation {
  INTERP_UNKNOWN = 0, INTERP_NEAREST = 1, INTERP_LINEAR = 2, INTERP_TETRAHEDRAL = 3,
  INTERP_BEST = 255
}
 cpp:type:: More...
 
enum  BitDepth {
  BIT_DEPTH_UNKNOWN = 0, BIT_DEPTH_UINT8, BIT_DEPTH_UINT10, BIT_DEPTH_UINT12,
  BIT_DEPTH_UINT14, BIT_DEPTH_UINT16, BIT_DEPTH_UINT32, BIT_DEPTH_F16,
  BIT_DEPTH_F32
}
 cpp:type:: More...
 
enum  Allocation { ALLOCATION_UNKNOWN = 0, ALLOCATION_UNIFORM, ALLOCATION_LG2 }
 cpp:type:: More...
 
enum  GpuLanguage { GPU_LANGUAGE_UNKNOWN = 0, GPU_LANGUAGE_CG, GPU_LANGUAGE_GLSL_1_0, GPU_LANGUAGE_GLSL_1_3 }
 cpp:type:: Used when there is a choice of hardware shader language. More...
 
enum  EnvironmentMode { ENV_ENVIRONMENT_UNKNOWN = 0, ENV_ENVIRONMENT_LOAD_PREDEFINED, ENV_ENVIRONMENT_LOAD_ALL }
 cpp:type:: More...
 

Functions

template<class T , class U >
OCIO_SHARED_PTR< T > DynamicPtrCast (OCIO_SHARED_PTR< U > const &ptr)
 
OCIOEXPORT const char * BoolToString (bool val)
 rst:: More...
 
OCIOEXPORT bool BoolFromString (const char *s)
 cpp:function:: More...
 
OCIOEXPORT const char * LoggingLevelToString (LoggingLevel level)
 cpp:function:: More...
 
OCIOEXPORT LoggingLevel LoggingLevelFromString (const char *s)
 cpp:function:: More...
 
OCIOEXPORT const char * TransformDirectionToString (TransformDirection dir)
 cpp:function:: More...
 
OCIOEXPORT TransformDirection TransformDirectionFromString (const char *s)
 cpp:function:: More...
 
OCIOEXPORT TransformDirection GetInverseTransformDirection (TransformDirection dir)
 cpp:function:: More...
 
OCIOEXPORT TransformDirection CombineTransformDirections (TransformDirection d1, TransformDirection d2)
 cpp:function:: More...
 
OCIOEXPORT const char * ColorSpaceDirectionToString (ColorSpaceDirection dir)
 cpp:function:: More...
 
OCIOEXPORT ColorSpaceDirection ColorSpaceDirectionFromString (const char *s)
 cpp:function:: More...
 
OCIOEXPORT const char * BitDepthToString (BitDepth bitDepth)
 cpp:function:: More...
 
OCIOEXPORT BitDepth BitDepthFromString (const char *s)
 cpp:function:: More...
 
OCIOEXPORT bool BitDepthIsFloat (BitDepth bitDepth)
 cpp:function:: More...
 
OCIOEXPORT int BitDepthToInt (BitDepth bitDepth)
 cpp:function:: More...
 
OCIOEXPORT const char * AllocationToString (Allocation allocation)
 cpp:function:: More...
 
OCIOEXPORT Allocation AllocationFromString (const char *s)
 cpp:function:: More...
 
OCIOEXPORT const char * InterpolationToString (Interpolation interp)
 cpp:function:: More...
 
OCIOEXPORT Interpolation InterpolationFromString (const char *s)
 cpp:function:: More...
 
OCIOEXPORT const char * GpuLanguageToString (GpuLanguage language)
 cpp:function:: More...
 
OCIOEXPORT GpuLanguage GpuLanguageFromString (const char *s)
 cpp:function:: More...
 
OCIOEXPORT const char * EnvironmentModeToString (EnvironmentMode mode)
 cpp:function:: More...
 
OCIOEXPORT EnvironmentMode EnvironmentModeFromString (const char *s)
 cpp:function:: More...
 

Variables

 OCIO_NAMESPACE_ENTER
 
class OCIOEXPORT ColorSpace
 
class OCIOEXPORT Look
 
class OCIOEXPORT Context
 
class OCIOEXPORT Processor
 
class OCIOEXPORT ProcessorMetadata
 
class OCIOEXPORT Baker
 
class OCIOEXPORT ImageDesc
 
class OCIOEXPORT GpuShaderDesc
 
class OCIOEXPORT Exception
 
class OCIOEXPORT Transform
 rst:: More...
 
class OCIOEXPORT AllocationTransform
 
class OCIOEXPORT CDLTransform
 
class OCIOEXPORT ColorSpaceTransform
 
class OCIOEXPORT DisplayTransform
 
class OCIOEXPORT ExponentTransform
 
class OCIOEXPORT FileTransform
 
class OCIOEXPORT GroupTransform
 
class OCIOEXPORT LogTransform
 
class OCIOEXPORT LookTransform
 
class OCIOEXPORT MatrixTransform
 
class OCIOEXPORT TruelightTransform
 
OCIOEXPORT const char * ROLE_DEFAULT
 rst:: More...
 
OCIOEXPORT const char * ROLE_REFERENCE
 rst:: More...
 
OCIOEXPORT const char * ROLE_DATA
 rst:: More...
 
OCIOEXPORT const char * ROLE_COLOR_PICKING
 rst:: More...
 
OCIOEXPORT const char * ROLE_SCENE_LINEAR
 rst:: More...
 
OCIOEXPORT const char * ROLE_COMPOSITING_LOG
 rst:: More...
 
OCIOEXPORT const char * ROLE_COLOR_TIMING
 rst:: More...
 
OCIOEXPORT const char * ROLE_TEXTURE_PAINT
 rst:: More...
 
OCIOEXPORT const char * ROLE_MATTE_PAINT
 rst:: More...
 

Typedef Documentation

cpp:type::

Definition at line 116 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<Baker> BakerRcPtr

cpp:type::

Definition at line 95 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<CDLTransform> CDLTransformRcPtr

cpp:type::

Definition at line 122 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<ColorSpace> ColorSpaceRcPtr

cpp:type::

Definition at line 65 of file OpenColorTypes.h.

cpp:type::

Definition at line 128 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<Config> ConfigRcPtr

cpp:type::

Definition at line 59 of file OpenColorTypes.h.

cpp:type::

Definition at line 114 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const Baker> ConstBakerRcPtr

cpp:type::

Definition at line 93 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const CDLTransform> ConstCDLTransformRcPtr

cpp:type::

Definition at line 120 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const ColorSpace> ConstColorSpaceRcPtr

cpp:type::

Definition at line 63 of file OpenColorTypes.h.

cpp:type::

Definition at line 126 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const Config> ConstConfigRcPtr

cpp:type::

Definition at line 57 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const Context> ConstContextRcPtr

cpp:type::

Definition at line 75 of file OpenColorTypes.h.

cpp:type::

Definition at line 132 of file OpenColorTypes.h.

cpp:type::

Definition at line 138 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const FileTransform> ConstFileTransformRcPtr

cpp:type::

Definition at line 144 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const GroupTransform> ConstGroupTransformRcPtr

cpp:type::

Definition at line 150 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const LogTransform> ConstLogTransformRcPtr

cpp:type::

Definition at line 156 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const Look> ConstLookRcPtr

cpp:type::

Definition at line 69 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const LookTransform> ConstLookTransformRcPtr

cpp:type::

Definition at line 162 of file OpenColorTypes.h.

cpp:type::

Definition at line 168 of file OpenColorTypes.h.

cpp:type::

Definition at line 87 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const Processor> ConstProcessorRcPtr

cpp:type::

Definition at line 81 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<const Transform> ConstTransformRcPtr

cpp:type::

Definition at line 108 of file OpenColorTypes.h.

cpp:type::

Definition at line 174 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<Context> ContextRcPtr

cpp:type::

Definition at line 77 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<DisplayTransform> DisplayTransformRcPtr

cpp:type::

Definition at line 134 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<ExponentTransform> ExponentTransformRcPtr

cpp:type::

Definition at line 140 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<FileTransform> FileTransformRcPtr

cpp:type::

Definition at line 146 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<GroupTransform> GroupTransformRcPtr

cpp:type::

Definition at line 152 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<LogTransform> LogTransformRcPtr

cpp:type::

Definition at line 158 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<Look> LookRcPtr

cpp:type::

Definition at line 71 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<LookTransform> LookTransformRcPtr

cpp:type::

Definition at line 164 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<MatrixTransform> MatrixTransformRcPtr

cpp:type::

Definition at line 170 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<ProcessorMetadata> ProcessorMetadataRcPtr

cpp:type::

Definition at line 89 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<Processor> ProcessorRcPtr

cpp:type::

Definition at line 83 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<Transform> TransformRcPtr

cpp:type::

Definition at line 110 of file OpenColorTypes.h.

typedef OCIO_SHARED_PTR<TruelightTransform> TruelightTransformRcPtr

cpp:type::

Definition at line 176 of file OpenColorTypes.h.

Enumeration Type Documentation

enum Allocation

cpp:type::

Enumerator
ALLOCATION_UNKNOWN 
ALLOCATION_UNIFORM 
ALLOCATION_LG2 

Definition at line 254 of file OpenColorTypes.h.

enum BitDepth

cpp:type::

Enumerator
BIT_DEPTH_UNKNOWN 
BIT_DEPTH_UINT8 
BIT_DEPTH_UINT10 
BIT_DEPTH_UINT12 
BIT_DEPTH_UINT14 
BIT_DEPTH_UINT16 
BIT_DEPTH_UINT32 
BIT_DEPTH_F16 
BIT_DEPTH_F32 

Definition at line 241 of file OpenColorTypes.h.

cpp:type::

Enumerator
COLORSPACE_DIR_UNKNOWN 
COLORSPACE_DIR_TO_REFERENCE 
COLORSPACE_DIR_FROM_REFERENCE 

Definition at line 199 of file OpenColorTypes.h.

cpp:type::

Enumerator
ENV_ENVIRONMENT_UNKNOWN 
ENV_ENVIRONMENT_LOAD_PREDEFINED 
ENV_ENVIRONMENT_LOAD_ALL 

Definition at line 270 of file OpenColorTypes.h.

cpp:type:: Used when there is a choice of hardware shader language.

Enumerator
GPU_LANGUAGE_UNKNOWN 
GPU_LANGUAGE_CG 

Nvidia Cg shader.

GPU_LANGUAGE_GLSL_1_0 

OpenGL Shading Language.

GPU_LANGUAGE_GLSL_1_3 

OpenGL Shading Language.

Definition at line 261 of file OpenColorTypes.h.

cpp:type::

Enumerator
INTERP_UNKNOWN 
INTERP_NEAREST 
INTERP_LINEAR 

nearest neighbor in all dimensions

INTERP_TETRAHEDRAL 

linear interpolation in all dimensions

INTERP_BEST 

tetrahedral interpolation in all directions

Definition at line 231 of file OpenColorTypes.h.

rst::

Enumerator
LOGGING_LEVEL_NONE 
LOGGING_LEVEL_WARNING 
LOGGING_LEVEL_INFO 
LOGGING_LEVEL_DEBUG 
LOGGING_LEVEL_UNKNOWN 

Definition at line 189 of file OpenColorTypes.h.

cpp:type::

Enumerator
TRANSFORM_DIR_UNKNOWN 
TRANSFORM_DIR_FORWARD 
TRANSFORM_DIR_INVERSE 

Definition at line 207 of file OpenColorTypes.h.

Function Documentation

OCIOEXPORT Allocation AllocationFromString ( const char *  s)

cpp:function::

OCIOEXPORT const char* AllocationToString ( Allocation  allocation)

cpp:function::

OCIOEXPORT BitDepth BitDepthFromString ( const char *  s)

cpp:function::

OCIOEXPORT bool BitDepthIsFloat ( BitDepth  bitDepth)

cpp:function::

OCIOEXPORT int BitDepthToInt ( BitDepth  bitDepth)

cpp:function::

OCIOEXPORT const char* BitDepthToString ( BitDepth  bitDepth)

cpp:function::

OCIOEXPORT bool BoolFromString ( const char *  s)

cpp:function::

OCIOEXPORT const char* BoolToString ( bool  val)

rst::

cpp:function::

OCIOEXPORT ColorSpaceDirection ColorSpaceDirectionFromString ( const char *  s)

cpp:function::

OCIOEXPORT const char* ColorSpaceDirectionToString ( ColorSpaceDirection  dir)

cpp:function::

OCIOEXPORT TransformDirection CombineTransformDirections ( TransformDirection  d1,
TransformDirection  d2 
)

cpp:function::

template<class T , class U >
OCIO_SHARED_PTR<T> DynamicPtrCast ( OCIO_SHARED_PTR< U > const ptr)
inline

Definition at line 179 of file OpenColorTypes.h.

OCIOEXPORT EnvironmentMode EnvironmentModeFromString ( const char *  s)

cpp:function::

OCIOEXPORT const char* EnvironmentModeToString ( EnvironmentMode  mode)

cpp:function::

OCIOEXPORT TransformDirection GetInverseTransformDirection ( TransformDirection  dir)

cpp:function::

OCIOEXPORT GpuLanguage GpuLanguageFromString ( const char *  s)

cpp:function::

OCIOEXPORT const char* GpuLanguageToString ( GpuLanguage  language)

cpp:function::

OCIOEXPORT Interpolation InterpolationFromString ( const char *  s)

cpp:function::

OCIOEXPORT const char* InterpolationToString ( Interpolation  interp)

cpp:function::

OCIOEXPORT LoggingLevel LoggingLevelFromString ( const char *  s)

cpp:function::

OCIOEXPORT const char* LoggingLevelToString ( LoggingLevel  level)

cpp:function::

OCIOEXPORT TransformDirection TransformDirectionFromString ( const char *  s)

cpp:function::

OCIOEXPORT const char* TransformDirectionToString ( TransformDirection  dir)

cpp:function::

Variable Documentation

Definition at line 91 of file OpenColorTypes.h.

Definition at line 118 of file OpenColorTypes.h.

Definition at line 61 of file OpenColorTypes.h.

Definition at line 73 of file OpenColorTypes.h.

Definition at line 130 of file OpenColorTypes.h.

Definition at line 99 of file OpenColorTypes.h.

Definition at line 136 of file OpenColorTypes.h.

Definition at line 142 of file OpenColorTypes.h.

Definition at line 98 of file OpenColorTypes.h.

Definition at line 148 of file OpenColorTypes.h.

Definition at line 97 of file OpenColorTypes.h.

Definition at line 154 of file OpenColorTypes.h.

Definition at line 67 of file OpenColorTypes.h.

Definition at line 160 of file OpenColorTypes.h.

Definition at line 166 of file OpenColorTypes.h.

OCIO_NAMESPACE_ENTER
Initial value:
{
cpp:class::
Definition: OpenColorIO.h:220
#define OCIOEXPORT
Definition: OpenColorABI.h:97

rst::

C++ Types

Definition at line 48 of file OpenColorTypes.h.

Definition at line 79 of file OpenColorTypes.h.

Definition at line 85 of file OpenColorTypes.h.

OCIOEXPORT const char* ROLE_COLOR_PICKING

rst::

OCIOEXPORT const char* ROLE_COLOR_TIMING

rst::

OCIOEXPORT const char* ROLE_COMPOSITING_LOG

rst::

OCIOEXPORT const char* ROLE_DATA

rst::

OCIOEXPORT const char* ROLE_DEFAULT

rst::

rst:: Roles

ColorSpace Roles are used so that plugins, in addition to this API can have abstract ways of asking for common colorspaces, without referring to them by hardcoded names.

Internal::

GetGPUDisplayTransform - (ROLE_SCENE_LINEAR (fstop exposure)) (ROLE_COLOR_TIMING (ASCColorCorrection))

External Plugins (currently known)::

Colorpicker UIs - (ROLE_COLOR_PICKING) Compositor LogConvert - (ROLE_SCENE_LINEAR, ROLE_COMPOSITING_LOG)

OCIOEXPORT const char* ROLE_MATTE_PAINT

rst::

OCIOEXPORT const char* ROLE_REFERENCE

rst::

OCIOEXPORT const char* ROLE_SCENE_LINEAR

rst::

OCIOEXPORT const char* ROLE_TEXTURE_PAINT

rst::

class OCIOEXPORT Transform

rst::

Definition at line 106 of file OpenColorTypes.h.