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

Namespaces

 ColorSpaceHelpers
 
 DisplayViewHelpers
 
 DynamicPropertyValue
 

Classes

class  ColorSpaceMenuParameters
 
class  ColorSpaceMenuHelper
 
class  LegacyViewingPipeline
 
class  MixingSlider
 
class  MixingColorSpaceManager
 
class  Exception
 An exception class to throw for errors detected at runtime. More...
 
class  ExceptionMissingFile
 An exception class for errors detected at runtime. More...
 
class  Config
 
class  FileRules
 
class  ViewingRules
 
class  ColorSpace
 
class  ColorSpaceSet
 
class  Look
 
class  NamedTransform
 NamedTransform. More...
 
class  ViewTransform
 
class  Processor
 
class  CPUProcessor
 
class  GPUProcessor
 
class  ProcessorMetadata
 This class contains meta information about the process that generated this processor. The results of these functions do not impact the pixel processing. More...
 
class  Baker
 
class  ImageDesc
 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...
 
class  PackedImageDesc
 
class  PlanarImageDesc
 
class  GpuShaderCreator
 
class  GpuShaderDesc
 
class  Context
 
class  BuiltinTransformRegistry
 
class  SystemMonitors
 
class  FormatMetadata
 
class  Transform
 Base class for all the transform classes. More...
 
class  AllocationTransform
 
class  BuiltinTransform
 
class  CDLTransform
 
class  ColorSpaceTransform
 
class  DisplayViewTransform
 
struct  GradingRGBM
 
struct  GradingPrimary
 Grading primary values. More...
 
struct  GradingControlPoint
 2D control point used by GradingBSplineCurve. More...
 
class  GradingBSplineCurve
 A BSpline curve defined with GradingControlPoint. More...
 
class  GradingRGBCurve
 
struct  GradingRGBMSW
 
struct  GradingTone
 Grading tone values. More...
 
class  DynamicProperty
 
class  DynamicPropertyDouble
 Interface used to access dynamic property double value. More...
 
class  DynamicPropertyGradingPrimary
 Interface used to access dynamic property GradingPrimary value. More...
 
class  DynamicPropertyGradingRGBCurve
 Interface used to access dynamic property ConstGradingRGBCurveRcPtr value. More...
 
class  DynamicPropertyGradingTone
 Interface used to access dynamic property GradingTone value. More...
 
class  ExponentTransform
 Represents exponent transform: pow( clamp(color), value ). More...
 
class  ExponentWithLinearTransform
 
class  ExposureContrastTransform
 
class  FileTransform
 
class  FixedFunctionTransform
 
class  GradingPrimaryTransform
 
class  GradingRGBCurveTransform
 
class  GradingToneTransform
 
class  GroupTransform
 
class  LogAffineTransform
 
class  LogCameraTransform
 
class  LogTransform
 
class  LookTransform
 
class  Lut1DTransform
 Represents a 1D-LUT transform. More...
 
class  Lut3DTransform
 Represents a 3D-LUT transform. More...
 
class  MatrixTransform
 
class  RangeTransform
 

Typedefs

typedef OCIO_SHARED_PTR< const
Config
ConstConfigRcPtr
 
typedef OCIO_SHARED_PTR< ConfigConfigRcPtr
 
typedef OCIO_SHARED_PTR< const
FileRules
ConstFileRulesRcPtr
 
typedef OCIO_SHARED_PTR
< FileRules
FileRulesRcPtr
 
typedef OCIO_SHARED_PTR< const
ViewingRules
ConstViewingRulesRcPtr
 
typedef OCIO_SHARED_PTR
< ViewingRules
ViewingRulesRcPtr
 
typedef OCIO_SHARED_PTR< const
ColorSpace
ConstColorSpaceRcPtr
 
typedef OCIO_SHARED_PTR
< ColorSpace
ColorSpaceRcPtr
 
typedef OCIO_SHARED_PTR< const
ColorSpaceSet
ConstColorSpaceSetRcPtr
 
typedef OCIO_SHARED_PTR
< ColorSpaceSet
ColorSpaceSetRcPtr
 
typedef OCIO_SHARED_PTR< const
Look
ConstLookRcPtr
 
typedef OCIO_SHARED_PTR< LookLookRcPtr
 
typedef OCIO_SHARED_PTR< const
NamedTransform
ConstNamedTransformRcPtr
 
typedef OCIO_SHARED_PTR
< NamedTransform
NamedTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
ViewTransform
ConstViewTransformRcPtr
 
typedef OCIO_SHARED_PTR
< ViewTransform
ViewTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
Context
ConstContextRcPtr
 
typedef OCIO_SHARED_PTR< ContextContextRcPtr
 
typedef OCIO_SHARED_PTR< const
Processor
ConstProcessorRcPtr
 
typedef OCIO_SHARED_PTR
< Processor
ProcessorRcPtr
 
typedef OCIO_SHARED_PTR< const
CPUProcessor
ConstCPUProcessorRcPtr
 
typedef OCIO_SHARED_PTR
< CPUProcessor
CPUProcessorRcPtr
 
typedef OCIO_SHARED_PTR< const
GPUProcessor
ConstGPUProcessorRcPtr
 
typedef OCIO_SHARED_PTR
< GPUProcessor
GPUProcessorRcPtr
 
typedef OCIO_SHARED_PTR< const
ProcessorMetadata
ConstProcessorMetadataRcPtr
 
typedef OCIO_SHARED_PTR
< ProcessorMetadata
ProcessorMetadataRcPtr
 
typedef OCIO_SHARED_PTR< const
Baker
ConstBakerRcPtr
 
typedef OCIO_SHARED_PTR< BakerBakerRcPtr
 
typedef OCIO_SHARED_PTR
< ImageDesc
ImageDescRcPtr
 
typedef OCIO_SHARED_PTR< const
ImageDesc
ConstImageDescRcPtr
 
typedef OCIO_SHARED_PTR
< GpuShaderCreator
GpuShaderCreatorRcPtr
 
typedef OCIO_SHARED_PTR< const
GpuShaderCreator
ConstGpuShaderCreatorRcPtr
 
typedef OCIO_SHARED_PTR
< GpuShaderDesc
GpuShaderDescRcPtr
 
typedef OCIO_SHARED_PTR< const
GpuShaderDesc
ConstGpuShaderDescRcPtr
 
typedef OCIO_SHARED_PTR
< BuiltinTransformRegistry
BuiltinTransformRegistryRcPtr
 
typedef OCIO_SHARED_PTR< const
BuiltinTransformRegistry
ConstBuiltinTransformRegistryRcPtr
 
typedef OCIO_SHARED_PTR
< SystemMonitors
SystemMonitorsRcPtr
 
typedef OCIO_SHARED_PTR< const
SystemMonitors
ConstSystemMonitorsRcPtr
 
typedef OCIO_SHARED_PTR< const
GradingBSplineCurve
ConstGradingBSplineCurveRcPtr
 
typedef OCIO_SHARED_PTR
< GradingBSplineCurve
GradingBSplineCurveRcPtr
 
typedef OCIO_SHARED_PTR< const
GradingRGBCurve
ConstGradingRGBCurveRcPtr
 
typedef OCIO_SHARED_PTR
< GradingRGBCurve
GradingRGBCurveRcPtr
 
typedef std::array< float, 3 > Float3
 
typedef OCIO_SHARED_PTR< const
Transform
ConstTransformRcPtr
 
typedef OCIO_SHARED_PTR
< Transform
TransformRcPtr
 
typedef OCIO_SHARED_PTR< const
AllocationTransform
ConstAllocationTransformRcPtr
 
typedef OCIO_SHARED_PTR
< AllocationTransform
AllocationTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
BuiltinTransform
ConstBuiltinTransformRcPtr
 
typedef OCIO_SHARED_PTR
< BuiltinTransform
BuiltinTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
CDLTransform
ConstCDLTransformRcPtr
 
typedef OCIO_SHARED_PTR
< CDLTransform
CDLTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
ColorSpaceTransform
ConstColorSpaceTransformRcPtr
 
typedef OCIO_SHARED_PTR
< ColorSpaceTransform
ColorSpaceTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
DisplayViewTransform
ConstDisplayViewTransformRcPtr
 
typedef OCIO_SHARED_PTR
< DisplayViewTransform
DisplayViewTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
DynamicProperty
ConstDynamicPropertyRcPtr
 
typedef OCIO_SHARED_PTR
< DynamicProperty
DynamicPropertyRcPtr
 
typedef OCIO_SHARED_PTR< const
DynamicPropertyDouble
ConstDynamicPropertyDoubleRcPtr
 
typedef OCIO_SHARED_PTR
< DynamicPropertyDouble
DynamicPropertyDoubleRcPtr
 
typedef OCIO_SHARED_PTR< const
DynamicPropertyGradingPrimary
ConstDynamicPropertyGradingPrimaryRcPtr
 
typedef OCIO_SHARED_PTR
< DynamicPropertyGradingPrimary
DynamicPropertyGradingPrimaryRcPtr
 
typedef OCIO_SHARED_PTR< const
DynamicPropertyGradingRGBCurve
ConstDynamicPropertyGradingRGBCurveRcPtr
 
typedef OCIO_SHARED_PTR
< DynamicPropertyGradingRGBCurve
DynamicPropertyGradingRGBCurveRcPtr
 
typedef OCIO_SHARED_PTR< const
DynamicPropertyGradingTone
ConstDynamicPropertyGradingToneRcPtr
 
typedef OCIO_SHARED_PTR
< DynamicPropertyGradingTone
DynamicPropertyGradingToneRcPtr
 
typedef OCIO_SHARED_PTR< const
ExponentTransform
ConstExponentTransformRcPtr
 
typedef OCIO_SHARED_PTR
< ExponentTransform
ExponentTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
ExponentWithLinearTransform
ConstExponentWithLinearTransformRcPtr
 
typedef OCIO_SHARED_PTR
< ExponentWithLinearTransform
ExponentWithLinearTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
ExposureContrastTransform
ConstExposureContrastTransformRcPtr
 
typedef OCIO_SHARED_PTR
< ExposureContrastTransform
ExposureContrastTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
FileTransform
ConstFileTransformRcPtr
 
typedef OCIO_SHARED_PTR
< FileTransform
FileTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
FixedFunctionTransform
ConstFixedFunctionTransformRcPtr
 
typedef OCIO_SHARED_PTR
< FixedFunctionTransform
FixedFunctionTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
GradingPrimaryTransform
ConstGradingPrimaryTransformRcPtr
 
typedef OCIO_SHARED_PTR
< GradingPrimaryTransform
GradingPrimaryTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
GradingRGBCurveTransform
ConstGradingRGBCurveTransformRcPtr
 
typedef OCIO_SHARED_PTR
< GradingRGBCurveTransform
GradingRGBCurveTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
GradingToneTransform
ConstGradingToneTransformRcPtr
 
typedef OCIO_SHARED_PTR
< GradingToneTransform
GradingToneTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
GroupTransform
ConstGroupTransformRcPtr
 
typedef OCIO_SHARED_PTR
< GroupTransform
GroupTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
LogAffineTransform
ConstLogAffineTransformRcPtr
 
typedef OCIO_SHARED_PTR
< LogAffineTransform
LogAffineTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
LogCameraTransform
ConstLogCameraTransformRcPtr
 
typedef OCIO_SHARED_PTR
< LogCameraTransform
LogCameraTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
LookTransform
ConstLookTransformRcPtr
 
typedef OCIO_SHARED_PTR
< LookTransform
LookTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
LogTransform
ConstLogTransformRcPtr
 
typedef OCIO_SHARED_PTR
< LogTransform
LogTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
Lut1DTransform
ConstLut1DTransformRcPtr
 
typedef OCIO_SHARED_PTR
< Lut1DTransform
Lut1DTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
Lut3DTransform
ConstLut3DTransformRcPtr
 
typedef OCIO_SHARED_PTR
< Lut3DTransform
Lut3DTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
MatrixTransform
ConstMatrixTransformRcPtr
 
typedef OCIO_SHARED_PTR
< MatrixTransform
MatrixTransformRcPtr
 
typedef OCIO_SHARED_PTR< const
RangeTransform
ConstRangeTransformRcPtr
 
typedef OCIO_SHARED_PTR
< RangeTransform
RangeTransformRcPtr
 
typedef OCIO_SHARED_PTR
< ColorSpaceMenuHelper
ColorSpaceMenuHelperRcPtr
 
typedef OCIO_SHARED_PTR< const
ColorSpaceMenuHelper
ConstColorSpaceMenuHelperRcPtr
 
typedef OCIO_SHARED_PTR
< ColorSpaceMenuParameters
ColorSpaceMenuParametersRcPtr
 
typedef OCIO_SHARED_PTR< const
ColorSpaceMenuParameters
ConstColorSpaceMenuParametersRcPtr
 
typedef OCIO_SHARED_PTR
< MixingColorSpaceManager
MixingColorSpaceManagerRcPtr
 
typedef OCIO_SHARED_PTR< const
MixingColorSpaceManager
ConstMixingColorSpaceManagerRcPtr
 
typedef OCIO_SHARED_PTR
< LegacyViewingPipeline
LegacyViewingPipelineRcPtr
 
typedef OCIO_SHARED_PTR< const
LegacyViewingPipeline
ConstLegacyViewingPipelineRcPtr
 
using LoggingFunction = std::function< void(const char *)>
 Define the logging function signature. More...
 
using ComputeHashFunction = std::function< std::string(const std::string &)>
 Define Compute Hash function signature. More...
 

Enumerations

enum  LoggingLevel {
  LOGGING_LEVEL_NONE = 0, LOGGING_LEVEL_WARNING = 1, LOGGING_LEVEL_INFO = 2, LOGGING_LEVEL_DEBUG = 3,
  LOGGING_LEVEL_UNKNOWN = 255, LOGGING_LEVEL_DEFAULT = LOGGING_LEVEL_INFO
}
 
enum  ReferenceSpaceType { REFERENCE_SPACE_SCENE = 0, REFERENCE_SPACE_DISPLAY }
 
enum  SearchReferenceSpaceType { SEARCH_REFERENCE_SPACE_SCENE = 0, SEARCH_REFERENCE_SPACE_DISPLAY, SEARCH_REFERENCE_SPACE_ALL }
 
enum  ColorSpaceVisibility { COLORSPACE_ACTIVE = 0, COLORSPACE_INACTIVE, COLORSPACE_ALL }
 
enum  NamedTransformVisibility { NAMEDTRANSFORM_ACTIVE = 0, NAMEDTRANSFORM_INACTIVE, NAMEDTRANSFORM_ALL }
 
enum  ViewType { VIEW_SHARED = 0, VIEW_DISPLAY_DEFINED }
 
enum  ColorSpaceDirection { COLORSPACE_DIR_TO_REFERENCE = 0, COLORSPACE_DIR_FROM_REFERENCE }
 
enum  ViewTransformDirection { VIEWTRANSFORM_DIR_TO_REFERENCE = 0, VIEWTRANSFORM_DIR_FROM_REFERENCE }
 
enum  TransformDirection { TRANSFORM_DIR_FORWARD = 0, TRANSFORM_DIR_INVERSE }
 
enum  TransformType {
  TRANSFORM_TYPE_ALLOCATION = 0, TRANSFORM_TYPE_BUILTIN, TRANSFORM_TYPE_CDL, TRANSFORM_TYPE_COLORSPACE,
  TRANSFORM_TYPE_DISPLAY_VIEW, TRANSFORM_TYPE_EXPONENT, TRANSFORM_TYPE_EXPONENT_WITH_LINEAR, TRANSFORM_TYPE_EXPOSURE_CONTRAST,
  TRANSFORM_TYPE_FILE, TRANSFORM_TYPE_FIXED_FUNCTION, TRANSFORM_TYPE_GRADING_PRIMARY, TRANSFORM_TYPE_GRADING_RGB_CURVE,
  TRANSFORM_TYPE_GRADING_TONE, TRANSFORM_TYPE_GROUP, TRANSFORM_TYPE_LOG_AFFINE, TRANSFORM_TYPE_LOG_CAMERA,
  TRANSFORM_TYPE_LOG, TRANSFORM_TYPE_LOOK, TRANSFORM_TYPE_LUT1D, TRANSFORM_TYPE_LUT3D,
  TRANSFORM_TYPE_MATRIX, TRANSFORM_TYPE_RANGE
}
 
enum  Interpolation {
  INTERP_UNKNOWN = 0, INTERP_NEAREST = 1, INTERP_LINEAR = 2, INTERP_TETRAHEDRAL = 3,
  INTERP_CUBIC = 4, INTERP_DEFAULT = 254, INTERP_BEST = 255
}
 
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
}
 
enum  Lut1DHueAdjust { HUE_NONE = 0, HUE_DW3, HUE_WYPN }
 Used by :cpp:classLut1DTransform to control optional hue restoration algorithm. More...
 
enum  ChannelOrdering {
  CHANNEL_ORDERING_RGBA = 0, CHANNEL_ORDERING_BGRA, CHANNEL_ORDERING_ABGR, CHANNEL_ORDERING_RGB,
  CHANNEL_ORDERING_BGR
}
 Used by PackedImageDesc to indicate the channel ordering of the image to process. More...
 
enum  Allocation { ALLOCATION_UNKNOWN = 0, ALLOCATION_UNIFORM, ALLOCATION_LG2 }
 
enum  GpuLanguage {
  GPU_LANGUAGE_CG = 0, GPU_LANGUAGE_GLSL_1_2, GPU_LANGUAGE_GLSL_1_3, GPU_LANGUAGE_GLSL_4_0,
  GPU_LANGUAGE_HLSL_DX11
}
 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 }
 
enum  RangeStyle { RANGE_NO_CLAMP = 0, RANGE_CLAMP }
 A RangeTransform may be set to clamp the values, or not. More...
 
enum  FixedFunctionStyle {
  FIXED_FUNCTION_ACES_RED_MOD_03 = 0, FIXED_FUNCTION_ACES_RED_MOD_10, FIXED_FUNCTION_ACES_GLOW_03, FIXED_FUNCTION_ACES_GLOW_10,
  FIXED_FUNCTION_ACES_DARK_TO_DIM_10, FIXED_FUNCTION_REC2100_SURROUND, FIXED_FUNCTION_RGB_TO_HSV, FIXED_FUNCTION_XYZ_TO_xyY,
  FIXED_FUNCTION_XYZ_TO_uvY, FIXED_FUNCTION_XYZ_TO_LUV, FIXED_FUNCTION_ACES_GAMUTMAP_02, FIXED_FUNCTION_ACES_GAMUTMAP_07,
  FIXED_FUNCTION_ACES_GAMUTMAP_13
}
 Enumeration of the :cpp:class:FixedFunctionTransform transform algorithms. More...
 
enum  ExposureContrastStyle { EXPOSURE_CONTRAST_LINEAR = 0, EXPOSURE_CONTRAST_VIDEO, EXPOSURE_CONTRAST_LOGARITHMIC }
 Enumeration of the :cpp:class:ExposureContrastTransform transform algorithms. More...
 
enum  CDLStyle { CDL_ASC = 0, CDL_NO_CLAMP, CDL_TRANSFORM_DEFAULT = CDL_NO_CLAMP }
 
enum  NegativeStyle { NEGATIVE_CLAMP = 0, NEGATIVE_MIRROR, NEGATIVE_PASS_THRU, NEGATIVE_LINEAR }
 
enum  GradingStyle { GRADING_LOG = 0, GRADING_LIN, GRADING_VIDEO }
 Styles for grading transforms. More...
 
enum  DynamicPropertyType {
  DYNAMIC_PROPERTY_EXPOSURE = 0, DYNAMIC_PROPERTY_CONTRAST, DYNAMIC_PROPERTY_GAMMA, DYNAMIC_PROPERTY_GRADING_PRIMARY,
  DYNAMIC_PROPERTY_GRADING_RGBCURVE, DYNAMIC_PROPERTY_GRADING_TONE
}
 Types for dynamic properties. More...
 
enum  RGBCurveType {
  RGB_RED = 0, RGB_GREEN, RGB_BLUE, RGB_MASTER,
  RGB_NUM_CURVES
}
 Types for GradingRGBCurve. More...
 
enum  UniformDataType {
  UNIFORM_DOUBLE = 0, UNIFORM_BOOL, UNIFORM_FLOAT3, UNIFORM_VECTOR_FLOAT,
  UNIFORM_VECTOR_INT, UNIFORM_UNKNOWN
}
 Types for uniform data. More...
 
enum  OptimizationFlags : unsigned long {
  OPTIMIZATION_NONE = 0x00000000, OPTIMIZATION_IDENTITY = 0x00000001, OPTIMIZATION_IDENTITY_GAMMA = 0x00000002, OPTIMIZATION_PAIR_IDENTITY_CDL = 0x00000040,
  OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST = 0x00000080, OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION = 0x00000100, OPTIMIZATION_PAIR_IDENTITY_GAMMA = 0x00000200, OPTIMIZATION_PAIR_IDENTITY_LUT1D = 0x00000400,
  OPTIMIZATION_PAIR_IDENTITY_LUT3D = 0x00000800, OPTIMIZATION_PAIR_IDENTITY_LOG = 0x00001000, OPTIMIZATION_PAIR_IDENTITY_GRADING = 0x00002000, OPTIMIZATION_COMP_EXPONENT = 0x00040000,
  OPTIMIZATION_COMP_GAMMA = 0x00080000, OPTIMIZATION_COMP_MATRIX = 0x00100000, OPTIMIZATION_COMP_LUT1D = 0x00200000, OPTIMIZATION_COMP_LUT3D = 0x00400000,
  OPTIMIZATION_COMP_RANGE = 0x00800000, OPTIMIZATION_COMP_SEPARABLE_PREFIX = 0x01000000, OPTIMIZATION_LUT_INV_FAST = 0x02000000, OPTIMIZATION_FAST_LOG_EXP_POW = 0x04000000,
  OPTIMIZATION_SIMPLIFY_OPS = 0x08000000, OPTIMIZATION_NO_DYNAMIC_PROPERTIES = 0x10000000, OPTIMIZATION_ALL = 0xFFFFFFFF, OPTIMIZATION_LOSSLESS,
  OPTIMIZATION_VERY_GOOD, OPTIMIZATION_GOOD = OPTIMIZATION_VERY_GOOD | OPTIMIZATION_COMP_LUT3D, OPTIMIZATION_DRAFT = OPTIMIZATION_ALL, OPTIMIZATION_DEFAULT = OPTIMIZATION_VERY_GOOD
}
 Provides control over how the ops in a Processor are combined in order to improve performance. More...
 
enum  ProcessorCacheFlags : unsigned int { PROCESSOR_CACHE_OFF = 0x00, PROCESSOR_CACHE_ENABLED = 0x01, PROCESSOR_CACHE_SHARE_DYN_PROPERTIES = 0x02, PROCESSOR_CACHE_DEFAULT = (PROCESSOR_CACHE_ENABLED | PROCESSOR_CACHE_SHARE_DYN_PROPERTIES) }
 cpp:type:: Enum to control the behavior of the internal caches e.g. the processor cache in More...
 

Functions

OCIOEXPORT std::ostream & operator<< (std::ostream &, const ColorSpaceMenuParameters &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const ColorSpaceMenuHelper &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const LegacyViewingPipeline &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const MixingSlider &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const MixingColorSpaceManager &)
 
OCIOEXPORT void ClearAllCaches ()
 
OCIOEXPORT const char * GetVersion ()
 Get the version number for the library, as a dot-delimited string (e.g., "1.0.0"). More...
 
OCIOEXPORT int GetVersionHex ()
 Get the version number for the library, as a single 4-byte hex number (e.g., 0x01050200 for "1.5.2"), to be used for numeric comparisons. More...
 
OCIOEXPORT LoggingLevel GetLoggingLevel ()
 Get the global logging level. More...
 
OCIOEXPORT void SetLoggingLevel (LoggingLevel level)
 Set the global logging level. More...
 
OCIOEXPORT void SetLoggingFunction (LoggingFunction logFunction)
 Set the logging function to use; otherwise, use the default (i.e. std::cerr). More...
 
OCIOEXPORT void ResetToDefaultLoggingFunction ()
 
OCIOEXPORT void LogMessage (LoggingLevel level, const char *message)
 Log a message using the library logging function. More...
 
OCIOEXPORT void SetComputeHashFunction (ComputeHashFunction hashFunction)
 Set the Compute Hash Function to use; otherwise, use the default. More...
 
OCIOEXPORT void ResetComputeHashFunction ()
 
OCIOEXPORT const char * GetEnvVariable (const char *name)
 
OCIOEXPORT void SetEnvVariable (const char *name, const char *value)
 
OCIOEXPORT void UnsetEnvVariable (const char *name)
 
OCIOEXPORT bool IsEnvVariablePresent (const char *name)
 cpp:function:: More...
 
OCIOEXPORT ConstConfigRcPtr GetCurrentConfig ()
 Get the current configuration. More...
 
OCIOEXPORT void SetCurrentConfig (const ConstConfigRcPtr &config)
 Set the current configuration. This will then store a copy of the specified config. More...
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const Config &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const FileRules &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const ViewingRules &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const ColorSpace &)
 
OCIOEXPORT ConstColorSpaceSetRcPtr operator|| (const ConstColorSpaceSetRcPtr &lcss, const ConstColorSpaceSetRcPtr &rcss)
 Perform the union of two sets. More...
 
OCIOEXPORT ConstColorSpaceSetRcPtr operator&& (const ConstColorSpaceSetRcPtr &lcss, const ConstColorSpaceSetRcPtr &rcss)
 Perform the intersection of two sets. More...
 
OCIOEXPORT ConstColorSpaceSetRcPtr operator- (const ConstColorSpaceSetRcPtr &lcss, const ConstColorSpaceSetRcPtr &rcss)
 Perform the difference of two sets. More...
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const Look &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const NamedTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const ViewTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const ImageDesc &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const Context &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const FormatMetadata &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const Transform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const AllocationTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const BuiltinTransform &) noexcept
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const CDLTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const ColorSpaceTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const DisplayViewTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingRGBM &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingPrimary &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingControlPoint &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingBSplineCurve &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingRGBCurve &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingRGBMSW &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingTone &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const ExponentTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const ExponentWithLinearTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const ExposureContrastTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const FileTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const FixedFunctionTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingPrimaryTransform &) noexcept
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingRGBCurveTransform &) noexcept
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GradingToneTransform &) noexcept
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const GroupTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const LogAffineTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const LogCameraTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const LogTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const LookTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const Lut1DTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const Lut3DTransform &)
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const MatrixTransform &) noexcept
 
OCIOEXPORT std::ostream & operator<< (std::ostream &, const RangeTransform &) noexcept
 
template<class T , class U >
OCIO_SHARED_PTR< T > DynamicPtrCast (OCIO_SHARED_PTR< U > const &ptr)
 
OCIOEXPORT const char * BoolToString (bool val)
 
OCIOEXPORT bool BoolFromString (const char *s)
 
OCIOEXPORT const char * LoggingLevelToString (LoggingLevel level)
 
OCIOEXPORT LoggingLevel LoggingLevelFromString (const char *s)
 
OCIOEXPORT const char * TransformDirectionToString (TransformDirection dir)
 
OCIOEXPORT TransformDirection TransformDirectionFromString (const char *s)
 Will throw if string is not recognized. More...
 
OCIOEXPORT TransformDirection GetInverseTransformDirection (TransformDirection dir)
 
OCIOEXPORT TransformDirection CombineTransformDirections (TransformDirection d1, TransformDirection d2)
 
OCIOEXPORT const char * BitDepthToString (BitDepth bitDepth)
 
OCIOEXPORT BitDepth BitDepthFromString (const char *s)
 
OCIOEXPORT bool BitDepthIsFloat (BitDepth bitDepth)
 
OCIOEXPORT int BitDepthToInt (BitDepth bitDepth)
 
OCIOEXPORT const char * AllocationToString (Allocation allocation)
 
OCIOEXPORT Allocation AllocationFromString (const char *s)
 
OCIOEXPORT const char * InterpolationToString (Interpolation interp)
 
OCIOEXPORT Interpolation InterpolationFromString (const char *s)
 
OCIOEXPORT const char * GpuLanguageToString (GpuLanguage language)
 
OCIOEXPORT GpuLanguage GpuLanguageFromString (const char *s)
 
OCIOEXPORT const char * EnvironmentModeToString (EnvironmentMode mode)
 
OCIOEXPORT EnvironmentMode EnvironmentModeFromString (const char *s)
 
OCIOEXPORT const char * CDLStyleToString (CDLStyle style)
 
OCIOEXPORT CDLStyle CDLStyleFromString (const char *style)
 
OCIOEXPORT const char * RangeStyleToString (RangeStyle style)
 
OCIOEXPORT RangeStyle RangeStyleFromString (const char *style)
 
OCIOEXPORT const char * FixedFunctionStyleToString (FixedFunctionStyle style)
 
OCIOEXPORT FixedFunctionStyle FixedFunctionStyleFromString (const char *style)
 
OCIOEXPORT const char * GradingStyleToString (GradingStyle style)
 
OCIOEXPORT GradingStyle GradingStyleFromString (const char *s)
 
OCIOEXPORT const char * ExposureContrastStyleToString (ExposureContrastStyle style)
 
OCIOEXPORT ExposureContrastStyle ExposureContrastStyleFromString (const char *style)
 
OCIOEXPORT const char * NegativeStyleToString (NegativeStyle style)
 
OCIOEXPORT NegativeStyle NegativeStyleFromString (const char *style)
 

Variables

const ptrdiff_t AutoStride = std::numeric_limits<ptrdiff_t>::min()
 
class OCIOEXPORT Config
 
class OCIOEXPORT FileRules
 
class OCIOEXPORT ViewingRules
 
class OCIOEXPORT ColorSpace
 
class OCIOEXPORT ColorSpaceSet
 
class OCIOEXPORT Look
 
class OCIOEXPORT NamedTransform
 
class OCIOEXPORT ViewTransform
 
class OCIOEXPORT Context
 
class OCIOEXPORT Processor
 
class OCIOEXPORT CPUProcessor
 
class OCIOEXPORT GPUProcessor
 
class OCIOEXPORT ProcessorMetadata
 
class OCIOEXPORT Baker
 
class OCIOEXPORT ImageDesc
 
class OCIOEXPORT Exception
 
class OCIOEXPORT GpuShaderCreator
 
class OCIOEXPORT GpuShaderDesc
 
class OCIOEXPORT BuiltinTransformRegistry
 
class OCIOEXPORT SystemMonitors
 
class OCIOEXPORT GradingBSplineCurve
 
class OCIOEXPORT GradingRGBCurve
 
class OCIOEXPORT Transform
 
class OCIOEXPORT AllocationTransform
 
class OCIOEXPORT BuiltinTransform
 
class OCIOEXPORT CDLTransform
 
class OCIOEXPORT ColorSpaceTransform
 
class OCIOEXPORT DisplayViewTransform
 
class OCIOEXPORT DynamicProperty
 
class OCIOEXPORT DynamicPropertyDouble
 
class OCIOEXPORT DynamicPropertyGradingPrimary
 
class OCIOEXPORT DynamicPropertyGradingRGBCurve
 
class OCIOEXPORT DynamicPropertyGradingTone
 
class OCIOEXPORT ExponentTransform
 
class OCIOEXPORT ExponentWithLinearTransform
 
class OCIOEXPORT ExposureContrastTransform
 
class OCIOEXPORT FileTransform
 
class OCIOEXPORT FixedFunctionTransform
 
class OCIOEXPORT GradingPrimaryTransform
 
class OCIOEXPORT GradingRGBCurveTransform
 
class OCIOEXPORT GradingToneTransform
 
class OCIOEXPORT GroupTransform
 
class OCIOEXPORT LogAffineTransform
 
class OCIOEXPORT LogCameraTransform
 
class OCIOEXPORT LookTransform
 
class OCIOEXPORT LogTransform
 
class OCIOEXPORT Lut1DTransform
 
class OCIOEXPORT Lut3DTransform
 
class OCIOEXPORT MatrixTransform
 
class OCIOEXPORT RangeTransform
 
OCIOEXPORT const char * OCIO_CONFIG_ENVVAR
 The envvar 'OCIO' provides a path to the config file used by Config::CreateFromEnv. More...
 
OCIOEXPORT const char * OCIO_ACTIVE_DISPLAYS_ENVVAR
 
OCIOEXPORT const char * OCIO_ACTIVE_VIEWS_ENVVAR
 
OCIOEXPORT const char * OCIO_INACTIVE_COLORSPACES_ENVVAR
 
OCIOEXPORT const char * OCIO_OPTIMIZATION_FLAGS_ENVVAR
 
OCIOEXPORT const char * OCIO_USER_CATEGORIES_ENVVAR
 
OCIOEXPORT const char * ROLE_DEFAULT
 "default" More...
 
OCIOEXPORT const char * ROLE_REFERENCE
 "reference" More...
 
OCIOEXPORT const char * ROLE_DATA
 "data" More...
 
OCIOEXPORT const char * ROLE_COLOR_PICKING
 "color_picking" More...
 
OCIOEXPORT const char * ROLE_SCENE_LINEAR
 "scene_linear" More...
 
OCIOEXPORT const char * ROLE_COMPOSITING_LOG
 "compositing_log" More...
 
OCIOEXPORT const char * ROLE_COLOR_TIMING
 "color_timing" More...
 
OCIOEXPORT const char * ROLE_TEXTURE_PAINT
 
OCIOEXPORT const char * ROLE_MATTE_PAINT
 
OCIOEXPORT const char * ROLE_RENDERING
 
OCIOEXPORT const char * ROLE_INTERCHANGE_SCENE
 
OCIOEXPORT const char * ROLE_INTERCHANGE_DISPLAY
 
OCIOEXPORT const char * OCIO_VIEW_USE_DISPLAY_NAME
 
OCIOEXPORT const char * METADATA_DESCRIPTION
 
OCIOEXPORT const char * METADATA_INFO
 
OCIOEXPORT const char * METADATA_INPUT_DESCRIPTOR
 
OCIOEXPORT const char * METADATA_OUTPUT_DESCRIPTOR
 
OCIOEXPORT const char * METADATA_NAME
 
OCIOEXPORT const char * METADATA_ID
 
OCIOEXPORT const char * OCIO_DISABLE_ALL_CACHES
 rst:: More...
 
OCIOEXPORT const char * OCIO_DISABLE_PROCESSOR_CACHES
 rst:: More...
 
OCIOEXPORT const char * OCIO_DISABLE_CACHE_FALLBACK
 rst:: More...
 

Detailed Description

rst::

C++ Transforms

Typically only needed when creating and/or manipulating configurations

rst::

C++ Types

Typedef Documentation

Definition at line 85 of file OpenColorTypes.h.

Define Compute Hash function signature.

Definition at line 277 of file OpenColorTypes.h.

Definition at line 117 of file OpenColorTypes.h.

using OCIO_NAMESPACE::LoggingFunction = typedef std::function<void(const char*)>

Define the logging function signature.

Definition at line 261 of file OpenColorTypes.h.

Definition at line 53 of file OpenColorTypes.h.

Enumeration Type Documentation

Enumerator
ALLOCATION_UNKNOWN 
ALLOCATION_UNIFORM 
ALLOCATION_LG2 

Definition at line 435 of file OpenColorTypes.h.

Used in a configuration file to indicate the bit-depth of a color space, and by the Processor to specify the input and output bit-depths of images to process. Note that Processor only supports: UINT8, UINT10, UINT12, UINT16, F16 and F32.

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 404 of file OpenColorTypes.h.

Enumeration of the :cpp:class:CDLTransform transform algorithms.

Note
The default for reading .cc/.ccc/.cdl files, config file YAML, and CDLTransform is no-clamp, since that is what is primarily desired in VFX. However, the CLF format default is ASC.
Enumerator
CDL_ASC 

ASC CDL specification v1.2.

CDL_NO_CLAMP 

CDL that does not clamp.

CDL_TRANSFORM_DEFAULT 

Definition at line 498 of file OpenColorTypes.h.

Used by PackedImageDesc to indicate the channel ordering of the image to process.

Enumerator
CHANNEL_ORDERING_RGBA 
CHANNEL_ORDERING_BGRA 
CHANNEL_ORDERING_ABGR 
CHANNEL_ORDERING_RGB 
CHANNEL_ORDERING_BGR 

Definition at line 426 of file OpenColorTypes.h.

Enumerator
COLORSPACE_DIR_TO_REFERENCE 
COLORSPACE_DIR_FROM_REFERENCE 

Definition at line 320 of file OpenColorTypes.h.

Enumerator
COLORSPACE_ACTIVE 
COLORSPACE_INACTIVE 
COLORSPACE_ALL 

Definition at line 300 of file OpenColorTypes.h.

Types for dynamic properties.

Enumerator
DYNAMIC_PROPERTY_EXPOSURE 

Image exposure value (double floating point value)

DYNAMIC_PROPERTY_CONTRAST 

Image contrast value (double floating point value)

DYNAMIC_PROPERTY_GAMMA 

Image gamma value (double floating point value)

DYNAMIC_PROPERTY_GRADING_PRIMARY 

Used by GradingPrimaryTransform.

DYNAMIC_PROPERTY_GRADING_RGBCURVE 

Used by GradingRGBCurveTransform.

DYNAMIC_PROPERTY_GRADING_TONE 

Used by GradingToneTransform.

Definition at line 526 of file OpenColorTypes.h.

Enumerator
ENV_ENVIRONMENT_UNKNOWN 
ENV_ENVIRONMENT_LOAD_PREDEFINED 
ENV_ENVIRONMENT_LOAD_ALL 

Definition at line 451 of file OpenColorTypes.h.

Enumeration of the :cpp:class:ExposureContrastTransform transform algorithms.

Enumerator
EXPOSURE_CONTRAST_LINEAR 

E/C to be applied to a linear space image.

EXPOSURE_CONTRAST_VIDEO 

E/C to be applied to a video space image.

EXPOSURE_CONTRAST_LOGARITHMIC 

E/C to be applied to a log space image.

Definition at line 484 of file OpenColorTypes.h.

Enumeration of the :cpp:class:FixedFunctionTransform transform algorithms.

Enumerator
FIXED_FUNCTION_ACES_RED_MOD_03 

Red modifier (ACES 0.3/0.7)

FIXED_FUNCTION_ACES_RED_MOD_10 

Red modifier (ACES 1.0)

FIXED_FUNCTION_ACES_GLOW_03 

Glow function (ACES 0.3/0.7)

FIXED_FUNCTION_ACES_GLOW_10 

Glow function (ACES 1.0)

FIXED_FUNCTION_ACES_DARK_TO_DIM_10 

Dark to dim surround correction (ACES 1.0)

FIXED_FUNCTION_REC2100_SURROUND 

Rec.2100 surround correction (takes one double for the gamma param)

FIXED_FUNCTION_RGB_TO_HSV 

Classic RGB to HSV function.

FIXED_FUNCTION_XYZ_TO_xyY 

CIE XYZ to 1931 xy chromaticity coordinates.

FIXED_FUNCTION_XYZ_TO_uvY 

CIE XYZ to 1976 u'v' chromaticity coordinates.

FIXED_FUNCTION_XYZ_TO_LUV 

CIE XYZ to 1976 CIELUV colour space (D65 white)

FIXED_FUNCTION_ACES_GAMUTMAP_02 

ACES 0.2 Gamut clamping algorithm – NOT IMPLEMENTED YET.

FIXED_FUNCTION_ACES_GAMUTMAP_07 

ACES 0.7 Gamut clamping algorithm – NOT IMPLEMENTED YET.

FIXED_FUNCTION_ACES_GAMUTMAP_13 

ACES 1.3 Gamut mapping algorithm – NOT IMPLEMENTED YET.

Definition at line 466 of file OpenColorTypes.h.

Used when there is a choice of hardware shader language.

Enumerator
GPU_LANGUAGE_CG 

Nvidia Cg shader.

GPU_LANGUAGE_GLSL_1_2 

OpenGL Shading Language.

GPU_LANGUAGE_GLSL_1_3 

OpenGL Shading Language.

GPU_LANGUAGE_GLSL_4_0 

OpenGL Shading Language.

GPU_LANGUAGE_HLSL_DX11 

DirectX Shading Language.

Definition at line 442 of file OpenColorTypes.h.

Styles for grading transforms.

Enumerator
GRADING_LOG 

Algorithms for Logarithmic color spaces.

GRADING_LIN 

Algorithms for Scene Linear color spaces.

GRADING_VIDEO 

Algorithms for Video color spaces.

Definition at line 518 of file OpenColorTypes.h.

Specify the interpolation type to use If the specified interpolation type is not supported in the requested context (for example, using tetrahedral interpolationon 1D LUTs) an exception will be thrown.

INTERP_DEFAULT will choose the default interpolation type for the requested context:

1D LUT INTERP_DEFAULT: LINEAR 3D LUT INTERP_DEFAULT: LINEAR

INTERP_BEST will choose the best interpolation type for the requested context:

1D LUT INTERP_BEST: LINEAR 3D LUT INTERP_BEST: TETRAHEDRAL

Note: INTERP_BEST and INTERP_DEFAULT are subject to change in minor releases, so if you care about locking off on a specific interpolation type, we'd recommend directly specifying it.

Enumerator
INTERP_UNKNOWN 
INTERP_NEAREST 

nearest neighbor

INTERP_LINEAR 

linear interpolation (trilinear for Lut3D)

INTERP_TETRAHEDRAL 

tetrahedral interpolation (Lut3D only)

INTERP_CUBIC 

cubic interpolation (not supported)

INTERP_DEFAULT 

the default interpolation type

INTERP_BEST 

the 'best' suitable interpolation type

Definition at line 386 of file OpenColorTypes.h.

Enumerator
LOGGING_LEVEL_NONE 
LOGGING_LEVEL_WARNING 
LOGGING_LEVEL_INFO 
LOGGING_LEVEL_DEBUG 
LOGGING_LEVEL_UNKNOWN 
LOGGING_LEVEL_DEFAULT 

Definition at line 265 of file OpenColorTypes.h.

Used by :cpp:classLut1DTransform to control optional hue restoration algorithm.

Enumerator
HUE_NONE 

No adjustment.

HUE_DW3 

Algorithm used in ACES Output Transforms through v0.7.

HUE_WYPN 

Weighted Yellow Power Norm – NOT IMPLEMENTED YET.

Definition at line 418 of file OpenColorTypes.h.

Enumerator
NAMEDTRANSFORM_ACTIVE 
NAMEDTRANSFORM_INACTIVE 
NAMEDTRANSFORM_ALL 

Definition at line 307 of file OpenColorTypes.h.

Negative values handling style for ExponentTransform and ExponentWithLinearTransform transform algorithms.

Enumerator
NEGATIVE_CLAMP 

Clamp negative values.

NEGATIVE_MIRROR 

Positive curve is rotated 180 degrees around the origin to handle negatives.

NEGATIVE_PASS_THRU 

Negative values are passed through unchanged.

NEGATIVE_LINEAR 

Linearly extrapolate the curve for negative values.

Definition at line 509 of file OpenColorTypes.h.

enum OCIO_NAMESPACE::OptimizationFlags : unsigned long

Provides control over how the ops in a Processor are combined in order to improve performance.

Enumerator
OPTIMIZATION_NONE 

Do not optimize.

OPTIMIZATION_IDENTITY 

Replace identity ops (other than gamma).

OPTIMIZATION_IDENTITY_GAMMA 

Replace identity gamma ops.

OPTIMIZATION_PAIR_IDENTITY_CDL 

Replace a pair of ops where one is the inverse of the other.

OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST 
OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION 
OPTIMIZATION_PAIR_IDENTITY_GAMMA 
OPTIMIZATION_PAIR_IDENTITY_LUT1D 
OPTIMIZATION_PAIR_IDENTITY_LUT3D 
OPTIMIZATION_PAIR_IDENTITY_LOG 
OPTIMIZATION_PAIR_IDENTITY_GRADING 
OPTIMIZATION_COMP_EXPONENT 

Compose a pair of ops into a single op.

OPTIMIZATION_COMP_GAMMA 
OPTIMIZATION_COMP_MATRIX 
OPTIMIZATION_COMP_LUT1D 
OPTIMIZATION_COMP_LUT3D 
OPTIMIZATION_COMP_RANGE 
OPTIMIZATION_COMP_SEPARABLE_PREFIX 

For integer and half bit-depths only, replace separable ops (i.e. no channel crosstalk ops) by a single 1D LUT of input bit-depth domain.

OPTIMIZATION_LUT_INV_FAST 

Implement inverse Lut1D and Lut3D evaluations using a a forward LUT (faster but less accurate). Note that GPU evals always do FAST.

OPTIMIZATION_FAST_LOG_EXP_POW 
OPTIMIZATION_SIMPLIFY_OPS 
OPTIMIZATION_NO_DYNAMIC_PROPERTIES 

Turn off dynamic control of any ops that offer adjustment of parameter values after finalization (e.g. ExposureContrast).

OPTIMIZATION_ALL 

Apply all possible optimizations.

OPTIMIZATION_LOSSLESS 
OPTIMIZATION_VERY_GOOD 
OPTIMIZATION_GOOD 
OPTIMIZATION_DRAFT 

For quite lossy optimizations.

OPTIMIZATION_DEFAULT 

Definition at line 558 of file OpenColorTypes.h.

cpp:type:: Enum to control the behavior of the internal caches e.g. the processor cache in

Enumerator
PROCESSOR_CACHE_OFF 
PROCESSOR_CACHE_ENABLED 
PROCESSOR_CACHE_SHARE_DYN_PROPERTIES 
PROCESSOR_CACHE_DEFAULT 

Definition at line 658 of file OpenColorTypes.h.

A RangeTransform may be set to clamp the values, or not.

Enumerator
RANGE_NO_CLAMP 
RANGE_CLAMP 

Definition at line 459 of file OpenColorTypes.h.

OCIO does not mandate the image state of the main reference space and it is not required to be scene-referred. This enum is used in connection with the display color space and view transform features which do assume that the main reference space is scene-referred and the display reference space is display-referred. If a config used a non-scene-referred reference space, presumably it would not use either display color spaces or view transforms, so this enum becomes irrelevant.

Enumerator
REFERENCE_SPACE_SCENE 

the main scene reference space

REFERENCE_SPACE_DISPLAY 

the reference space for display color spaces

Definition at line 287 of file OpenColorTypes.h.

Types for GradingRGBCurve.

Enumerator
RGB_RED 
RGB_GREEN 
RGB_BLUE 
RGB_MASTER 
RGB_NUM_CURVES 

Definition at line 537 of file OpenColorTypes.h.

Enumerator
SEARCH_REFERENCE_SPACE_SCENE 
SEARCH_REFERENCE_SPACE_DISPLAY 
SEARCH_REFERENCE_SPACE_ALL 

Definition at line 293 of file OpenColorTypes.h.

Enumerator
TRANSFORM_DIR_FORWARD 
TRANSFORM_DIR_INVERSE 

Definition at line 332 of file OpenColorTypes.h.

Enumerator
TRANSFORM_TYPE_ALLOCATION 
TRANSFORM_TYPE_BUILTIN 
TRANSFORM_TYPE_CDL 
TRANSFORM_TYPE_COLORSPACE 
TRANSFORM_TYPE_DISPLAY_VIEW 
TRANSFORM_TYPE_EXPONENT 
TRANSFORM_TYPE_EXPONENT_WITH_LINEAR 
TRANSFORM_TYPE_EXPOSURE_CONTRAST 
TRANSFORM_TYPE_FILE 
TRANSFORM_TYPE_FIXED_FUNCTION 
TRANSFORM_TYPE_GRADING_PRIMARY 
TRANSFORM_TYPE_GRADING_RGB_CURVE 
TRANSFORM_TYPE_GRADING_TONE 
TRANSFORM_TYPE_GROUP 
TRANSFORM_TYPE_LOG_AFFINE 
TRANSFORM_TYPE_LOG_CAMERA 
TRANSFORM_TYPE_LOG 
TRANSFORM_TYPE_LOOK 
TRANSFORM_TYPE_LUT1D 
TRANSFORM_TYPE_LUT3D 
TRANSFORM_TYPE_MATRIX 
TRANSFORM_TYPE_RANGE 

Definition at line 338 of file OpenColorTypes.h.

Types for uniform data.

Enumerator
UNIFORM_DOUBLE 
UNIFORM_BOOL 
UNIFORM_FLOAT3 

Array of 3 floats.

UNIFORM_VECTOR_FLOAT 

Vector of floats (size is set by uniform).

UNIFORM_VECTOR_INT 

Vector of int pairs (size is set by uniform).

UNIFORM_UNKNOWN 

Definition at line 547 of file OpenColorTypes.h.

Enumerator
VIEWTRANSFORM_DIR_TO_REFERENCE 
VIEWTRANSFORM_DIR_FROM_REFERENCE 

Definition at line 326 of file OpenColorTypes.h.

Enumerator
VIEW_SHARED 
VIEW_DISPLAY_DEFINED 

Definition at line 314 of file OpenColorTypes.h.

Function Documentation

OCIOEXPORT Allocation OCIO_NAMESPACE::AllocationFromString ( const char *  s)
OCIOEXPORT const char* OCIO_NAMESPACE::AllocationToString ( Allocation  allocation)
OCIOEXPORT BitDepth OCIO_NAMESPACE::BitDepthFromString ( const char *  s)
OCIOEXPORT bool OCIO_NAMESPACE::BitDepthIsFloat ( BitDepth  bitDepth)
OCIOEXPORT int OCIO_NAMESPACE::BitDepthToInt ( BitDepth  bitDepth)
OCIOEXPORT const char* OCIO_NAMESPACE::BitDepthToString ( BitDepth  bitDepth)
OCIOEXPORT bool OCIO_NAMESPACE::BoolFromString ( const char *  s)
OCIOEXPORT const char* OCIO_NAMESPACE::BoolToString ( bool  val)
OCIOEXPORT CDLStyle OCIO_NAMESPACE::CDLStyleFromString ( const char *  style)
OCIOEXPORT const char* OCIO_NAMESPACE::CDLStyleToString ( CDLStyle  style)
OCIOEXPORT void OCIO_NAMESPACE::ClearAllCaches ( )

During normal usage, OpenColorIO tends to cache certain global information (such as the contents of LUTs on disk, intermediate results, etc.). Calling this function will flush all such information. The global information are related to LUT file identifications, loaded LUT file content and CDL transforms from loaded CDL files.

Under normal usage, this is not necessary, but it can be helpful in particular instances, such as designing OCIO profiles, and wanting to re-read luts without restarting.

Note
The method does not apply to instance specific caches such as the processor cache in a config instance or the GPU and CPU processor caches in a processor instance. Here deleting the instance flushes the cache.
OCIOEXPORT TransformDirection OCIO_NAMESPACE::CombineTransformDirections ( TransformDirection  d1,
TransformDirection  d2 
)
template<class T , class U >
OCIO_SHARED_PTR<T> OCIO_NAMESPACE::DynamicPtrCast ( OCIO_SHARED_PTR< U > const ptr)
inline

Definition at line 255 of file OpenColorTypes.h.

OCIOEXPORT EnvironmentMode OCIO_NAMESPACE::EnvironmentModeFromString ( const char *  s)
OCIOEXPORT const char* OCIO_NAMESPACE::EnvironmentModeToString ( EnvironmentMode  mode)
OCIOEXPORT ExposureContrastStyle OCIO_NAMESPACE::ExposureContrastStyleFromString ( const char *  style)
OCIOEXPORT const char* OCIO_NAMESPACE::ExposureContrastStyleToString ( ExposureContrastStyle  style)
OCIOEXPORT FixedFunctionStyle OCIO_NAMESPACE::FixedFunctionStyleFromString ( const char *  style)
OCIOEXPORT const char* OCIO_NAMESPACE::FixedFunctionStyleToString ( FixedFunctionStyle  style)
OCIOEXPORT ConstConfigRcPtr OCIO_NAMESPACE::GetCurrentConfig ( )

Get the current configuration.

OCIOEXPORT const char* OCIO_NAMESPACE::GetEnvVariable ( const char *  name)

Another call modifies the string obtained from a previous call as the method always uses the same memory buffer.

OCIOEXPORT TransformDirection OCIO_NAMESPACE::GetInverseTransformDirection ( TransformDirection  dir)
OCIOEXPORT LoggingLevel OCIO_NAMESPACE::GetLoggingLevel ( )

Get the global logging level.

You can override this at runtime using the OCIO_LOGGING_LEVEL environment variable. The client application that sets this should use SetLoggingLevel, and not the environment variable. The default value is INFO.

OCIOEXPORT const char* OCIO_NAMESPACE::GetVersion ( )

Get the version number for the library, as a dot-delimited string (e.g., "1.0.0").

This is also available at compile time as OCIO_VERSION_FULL_STR.

OCIOEXPORT int OCIO_NAMESPACE::GetVersionHex ( )

Get the version number for the library, as a single 4-byte hex number (e.g., 0x01050200 for "1.5.2"), to be used for numeric comparisons.

This is also at compile time as OCIO_VERSION_HEX.

OCIOEXPORT GpuLanguage OCIO_NAMESPACE::GpuLanguageFromString ( const char *  s)
OCIOEXPORT const char* OCIO_NAMESPACE::GpuLanguageToString ( GpuLanguage  language)
OCIOEXPORT GradingStyle OCIO_NAMESPACE::GradingStyleFromString ( const char *  s)
OCIOEXPORT const char* OCIO_NAMESPACE::GradingStyleToString ( GradingStyle  style)
OCIOEXPORT Interpolation OCIO_NAMESPACE::InterpolationFromString ( const char *  s)
OCIOEXPORT const char* OCIO_NAMESPACE::InterpolationToString ( Interpolation  interp)
OCIOEXPORT bool OCIO_NAMESPACE::IsEnvVariablePresent ( const char *  name)

cpp:function::

OCIOEXPORT LoggingLevel OCIO_NAMESPACE::LoggingLevelFromString ( const char *  s)
OCIOEXPORT const char* OCIO_NAMESPACE::LoggingLevelToString ( LoggingLevel  level)
OCIOEXPORT void OCIO_NAMESPACE::LogMessage ( LoggingLevel  level,
const char *  message 
)

Log a message using the library logging function.

OCIOEXPORT NegativeStyle OCIO_NAMESPACE::NegativeStyleFromString ( const char *  style)
OCIOEXPORT const char* OCIO_NAMESPACE::NegativeStyleToString ( NegativeStyle  style)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const FormatMetadata &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const Transform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ColorSpaceMenuParameters &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const AllocationTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const BuiltinTransform &   
)
noexcept
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ColorSpaceMenuHelper &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const CDLTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ColorSpaceTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const LegacyViewingPipeline &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const DisplayViewTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingRGBM &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const MixingSlider &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingPrimary &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingControlPoint &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const MixingColorSpaceManager &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingBSplineCurve &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingRGBCurve &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingRGBMSW &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingTone &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ExponentTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ExponentWithLinearTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ExposureContrastTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const FileTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const FixedFunctionTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const Config &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingPrimaryTransform &   
)
noexcept
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingRGBCurveTransform &   
)
noexcept
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GradingToneTransform &   
)
noexcept
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const FileRules &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const GroupTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const LogAffineTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ViewingRules &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const LogCameraTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const LogTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const LookTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ColorSpace &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const Lut1DTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const Lut3DTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const MatrixTransform &   
)
noexcept
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const Look &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const NamedTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const RangeTransform &   
)
noexcept
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ViewTransform &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const ImageDesc &   
)
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< ( std::ostream &  ,
const Context &   
)
OCIOEXPORT RangeStyle OCIO_NAMESPACE::RangeStyleFromString ( const char *  style)
OCIOEXPORT const char* OCIO_NAMESPACE::RangeStyleToString ( RangeStyle  style)
OCIOEXPORT void OCIO_NAMESPACE::ResetComputeHashFunction ( )
OCIOEXPORT void OCIO_NAMESPACE::ResetToDefaultLoggingFunction ( )
OCIOEXPORT void OCIO_NAMESPACE::SetComputeHashFunction ( ComputeHashFunction  hashFunction)

Set the Compute Hash Function to use; otherwise, use the default.

Parameters
ComputeHashFunction
OCIOEXPORT void OCIO_NAMESPACE::SetCurrentConfig ( const ConstConfigRcPtr &  config)

Set the current configuration. This will then store a copy of the specified config.

OCIOEXPORT void OCIO_NAMESPACE::SetEnvVariable ( const char *  name,
const char *  value 
)
Warning
This method is not thread safe.
OCIOEXPORT void OCIO_NAMESPACE::SetLoggingFunction ( LoggingFunction  logFunction)

Set the logging function to use; otherwise, use the default (i.e. std::cerr).

Note
The logging mechanism is thread-safe.
OCIOEXPORT void OCIO_NAMESPACE::SetLoggingLevel ( LoggingLevel  level)

Set the global logging level.

OCIOEXPORT TransformDirection OCIO_NAMESPACE::TransformDirectionFromString ( const char *  s)

Will throw if string is not recognized.

OCIOEXPORT const char* OCIO_NAMESPACE::TransformDirectionToString ( TransformDirection  dir)
OCIOEXPORT void OCIO_NAMESPACE::UnsetEnvVariable ( const char *  name)
Warning
This method is not thread safe.

Variable Documentation

const ptrdiff_t OCIO_NAMESPACE::AutoStride = std::numeric_limits<ptrdiff_t>::min()

Definition at line 2500 of file OpenColorIO.h.