Enums¶
LoggingLevel¶
Conversions: LoggingLevel
ReferenceSpaceType¶
-
enum OpenColorIO_v2_1::ReferenceSpaceType¶
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.
Values:
-
enumerator REFERENCE_SPACE_SCENE¶
the main scene reference space
-
enumerator REFERENCE_SPACE_DISPLAY¶
the reference space for display color spaces
-
enumerator REFERENCE_SPACE_SCENE¶
SearchReferenceSpaceType¶
NamedTransformVisibility¶
ColorSpaceVisibility¶
ViewType¶
ColorSpaceDirection¶
Conversions: conversion_color_space_direction
ViewTransformDirection¶
TransformDirection¶
Conversions: TransformDirection
TransformType¶
-
enum OpenColorIO_v2_1::TransformType¶
Values:
-
enumerator TRANSFORM_TYPE_ALLOCATION¶
-
enumerator TRANSFORM_TYPE_BUILTIN¶
-
enumerator TRANSFORM_TYPE_CDL¶
-
enumerator TRANSFORM_TYPE_COLORSPACE¶
-
enumerator TRANSFORM_TYPE_DISPLAY_VIEW¶
-
enumerator TRANSFORM_TYPE_EXPONENT¶
-
enumerator TRANSFORM_TYPE_EXPONENT_WITH_LINEAR¶
-
enumerator TRANSFORM_TYPE_EXPOSURE_CONTRAST¶
-
enumerator TRANSFORM_TYPE_FILE¶
-
enumerator TRANSFORM_TYPE_FIXED_FUNCTION¶
-
enumerator TRANSFORM_TYPE_GRADING_PRIMARY¶
-
enumerator TRANSFORM_TYPE_GRADING_RGB_CURVE¶
-
enumerator TRANSFORM_TYPE_GRADING_TONE¶
-
enumerator TRANSFORM_TYPE_GROUP¶
-
enumerator TRANSFORM_TYPE_LOG_AFFINE¶
-
enumerator TRANSFORM_TYPE_LOG_CAMERA¶
-
enumerator TRANSFORM_TYPE_LOG¶
-
enumerator TRANSFORM_TYPE_LOOK¶
-
enumerator TRANSFORM_TYPE_LUT1D¶
-
enumerator TRANSFORM_TYPE_LUT3D¶
-
enumerator TRANSFORM_TYPE_MATRIX¶
-
enumerator TRANSFORM_TYPE_RANGE¶
-
enumerator TRANSFORM_TYPE_ALLOCATION¶
Interpolation¶
-
enum OpenColorIO_v2_1::Interpolation¶
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.
Values:
-
enumerator INTERP_UNKNOWN¶
-
enumerator INTERP_NEAREST¶
nearest neighbor
-
enumerator INTERP_LINEAR¶
linear interpolation (trilinear for Lut3D)
-
enumerator INTERP_TETRAHEDRAL¶
tetrahedral interpolation (Lut3D only)
-
enumerator INTERP_CUBIC¶
cubic interpolation (not supported)
-
enumerator INTERP_DEFAULT¶
the default interpolation type
-
enumerator INTERP_BEST¶
the ‘best’ suitable interpolation type
-
enumerator INTERP_UNKNOWN¶
Conversions: Interpolation
BitDepth¶
-
enum OpenColorIO_v2_1::BitDepth¶
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.
Values:
-
enumerator BIT_DEPTH_UNKNOWN¶
-
enumerator BIT_DEPTH_UINT8¶
-
enumerator BIT_DEPTH_UINT10¶
-
enumerator BIT_DEPTH_UINT12¶
-
enumerator BIT_DEPTH_UINT14¶
-
enumerator BIT_DEPTH_UINT16¶
-
enumerator BIT_DEPTH_UINT32¶
Here for historical reason but that’s not supported.
-
enumerator BIT_DEPTH_F16¶
-
enumerator BIT_DEPTH_F32¶
-
enumerator BIT_DEPTH_UNKNOWN¶
Conversions: BitDepth
Lut1DHueAdjust¶
-
enum OpenColorIO_v2_1::Lut1DHueAdjust¶
Used by :cpp:class
Lut1DTransform
to control optional hue restoration algorithm.Values:
-
enumerator HUE_NONE¶
No adjustment.
-
enumerator HUE_DW3¶
Algorithm used in ACES Output Transforms through v0.7.
-
enumerator HUE_WYPN¶
Weighted Yellow Power Norm — NOT IMPLEMENTED YET.
-
enumerator HUE_NONE¶
ChannelOrdering¶
Allocation¶
Conversions: Allocation
GpuLanguage¶
-
enum OpenColorIO_v2_1::GpuLanguage¶
Used when there is a choice of hardware shader language.
Values:
-
enumerator GPU_LANGUAGE_CG¶
Nvidia Cg shader.
-
enumerator GPU_LANGUAGE_GLSL_1_2¶
OpenGL Shading Language.
-
enumerator GPU_LANGUAGE_GLSL_1_3¶
OpenGL Shading Language.
-
enumerator GPU_LANGUAGE_GLSL_4_0¶
OpenGL Shading Language.
-
enumerator GPU_LANGUAGE_HLSL_DX11¶
DirectX Shading Language.
-
enumerator LANGUAGE_OSL_1¶
Open Shading Language.
-
enumerator GPU_LANGUAGE_GLSL_ES_1_0¶
OpenGL ES Shading Language.
-
enumerator GPU_LANGUAGE_GLSL_ES_3_0¶
OpenGL ES Shading Language.
-
enumerator GPU_LANGUAGE_MSL_2_0¶
Metal Shading Language.
-
enumerator GPU_LANGUAGE_CG¶
Conversions: GpuLanguage
EnvironmentMode¶
Conversions: EnvironmentMode
RangeStyle¶
-
enum OpenColorIO_v2_1::RangeStyle¶
A RangeTransform may be set to clamp the values, or not.
Values:
-
enumerator RANGE_NO_CLAMP¶
-
enumerator RANGE_CLAMP¶
-
enumerator RANGE_NO_CLAMP¶
Conversions: RangeStyle
FixedFunctionStyle¶
-
enum OpenColorIO_v2_1::FixedFunctionStyle¶
Enumeration of the :cpp:class:
FixedFunctionTransform
transform algorithms.Values:
-
enumerator FIXED_FUNCTION_ACES_RED_MOD_03¶
Red modifier (ACES 0.3/0.7)
-
enumerator FIXED_FUNCTION_ACES_RED_MOD_10¶
Red modifier (ACES 1.0)
-
enumerator FIXED_FUNCTION_ACES_GLOW_03¶
Glow function (ACES 0.3/0.7)
-
enumerator FIXED_FUNCTION_ACES_GLOW_10¶
Glow function (ACES 1.0)
-
enumerator FIXED_FUNCTION_ACES_DARK_TO_DIM_10¶
Dark to dim surround correction (ACES 1.0)
-
enumerator FIXED_FUNCTION_REC2100_SURROUND¶
Rec.2100 surround correction (takes one double for the gamma param)
-
enumerator FIXED_FUNCTION_RGB_TO_HSV¶
Classic RGB to HSV function.
-
enumerator FIXED_FUNCTION_XYZ_TO_xyY¶
CIE XYZ to 1931 xy chromaticity coordinates.
-
enumerator FIXED_FUNCTION_XYZ_TO_uvY¶
CIE XYZ to 1976 u’v’ chromaticity coordinates.
-
enumerator FIXED_FUNCTION_XYZ_TO_LUV¶
CIE XYZ to 1976 CIELUV colour space (D65 white)
-
enumerator FIXED_FUNCTION_ACES_GAMUTMAP_02¶
ACES 0.2 Gamut clamping algorithm — NOT IMPLEMENTED YET.
-
enumerator FIXED_FUNCTION_ACES_GAMUTMAP_07¶
ACES 0.7 Gamut clamping algorithm — NOT IMPLEMENTED YET.
-
enumerator FIXED_FUNCTION_ACES_GAMUT_COMP_13¶
ACES 1.3 Parametric Gamut Compression (expects ACEScg values)
-
enumerator FIXED_FUNCTION_ACES_RED_MOD_03¶
Conversions: FixedFunctionStyle
ExposureContrastStyle¶
-
enum OpenColorIO_v2_1::ExposureContrastStyle¶
Enumeration of the :cpp:class:
ExposureContrastTransform
transform algorithms.Values:
-
enumerator EXPOSURE_CONTRAST_LINEAR¶
E/C to be applied to a linear space image.
-
enumerator EXPOSURE_CONTRAST_VIDEO¶
E/C to be applied to a video space image.
-
enumerator EXPOSURE_CONTRAST_LOGARITHMIC¶
E/C to be applied to a log space image.
-
enumerator EXPOSURE_CONTRAST_LINEAR¶
Conversions: ExposureContrastStyle
CDLStyle¶
-
enum OpenColorIO_v2_1::CDLStyle¶
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.
Values:
-
enumerator CDL_ASC¶
ASC CDL specification v1.2.
-
enumerator CDL_NO_CLAMP¶
CDL that does not clamp.
-
enumerator CDL_TRANSFORM_DEFAULT¶
-
enumerator CDL_ASC¶
Conversions: CDLStyle
NegativeStyle¶
-
enum OpenColorIO_v2_1::NegativeStyle¶
Negative values handling style for ExponentTransform and ExponentWithLinearTransform transform algorithms.
Values:
-
enumerator NEGATIVE_CLAMP¶
Clamp negative values.
-
enumerator NEGATIVE_MIRROR¶
Positive curve is rotated 180 degrees around the origin to handle negatives.
-
enumerator NEGATIVE_PASS_THRU¶
Negative values are passed through unchanged.
-
enumerator NEGATIVE_LINEAR¶
Linearly extrapolate the curve for negative values.
-
enumerator NEGATIVE_CLAMP¶
Conversions: NegativeStyle
GradingStyle¶
Conversions: GradingStyle
DynamicPropertyType¶
-
enum OpenColorIO_v2_1::DynamicPropertyType¶
Types for dynamic properties.
Values:
-
enumerator DYNAMIC_PROPERTY_EXPOSURE¶
Image exposure value (double floating point value)
-
enumerator DYNAMIC_PROPERTY_CONTRAST¶
Image contrast value (double floating point value)
-
enumerator DYNAMIC_PROPERTY_GAMMA¶
Image gamma value (double floating point value)
-
enumerator DYNAMIC_PROPERTY_GRADING_PRIMARY¶
Used by GradingPrimaryTransform.
-
enumerator DYNAMIC_PROPERTY_GRADING_RGBCURVE¶
Used by GradingRGBCurveTransform.
-
enumerator DYNAMIC_PROPERTY_GRADING_TONE¶
Used by GradingToneTransform.
-
enumerator DYNAMIC_PROPERTY_EXPOSURE¶
RGBCurveType¶
UniformDataType¶
-
enum OpenColorIO_v2_1::UniformDataType¶
Types for uniform data.
Values:
-
enumerator UNIFORM_DOUBLE¶
-
enumerator UNIFORM_BOOL¶
-
enumerator UNIFORM_FLOAT3¶
Array of 3 floats.
-
enumerator UNIFORM_VECTOR_FLOAT¶
Vector of floats (size is set by uniform).
-
enumerator UNIFORM_VECTOR_INT¶
Vector of int pairs (size is set by uniform).
-
enumerator UNIFORM_UNKNOWN¶
-
enumerator UNIFORM_DOUBLE¶
OptimizationFlags¶
-
enum OpenColorIO_v2_1::OptimizationFlags¶
Provides control over how the ops in a Processor are combined in order to improve performance.
Values:
-
enumerator OPTIMIZATION_NONE¶
Do not optimize.
-
enumerator OPTIMIZATION_IDENTITY¶
Replace identity ops (other than gamma).
-
enumerator OPTIMIZATION_IDENTITY_GAMMA¶
Replace identity gamma ops.
-
enumerator OPTIMIZATION_PAIR_IDENTITY_CDL¶
Replace a pair of ops where one is the inverse of the other.
-
enumerator OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST¶
-
enumerator OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION¶
-
enumerator OPTIMIZATION_PAIR_IDENTITY_GAMMA¶
-
enumerator OPTIMIZATION_PAIR_IDENTITY_LUT1D¶
-
enumerator OPTIMIZATION_PAIR_IDENTITY_LUT3D¶
-
enumerator OPTIMIZATION_PAIR_IDENTITY_LOG¶
-
enumerator OPTIMIZATION_PAIR_IDENTITY_GRADING¶
-
enumerator OPTIMIZATION_COMP_EXPONENT¶
Compose a pair of ops into a single op.
-
enumerator OPTIMIZATION_COMP_GAMMA¶
-
enumerator OPTIMIZATION_COMP_MATRIX¶
-
enumerator OPTIMIZATION_COMP_LUT1D¶
-
enumerator OPTIMIZATION_COMP_LUT3D¶
-
enumerator OPTIMIZATION_COMP_RANGE¶
-
enumerator 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.
-
enumerator 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.
-
enumerator OPTIMIZATION_FAST_LOG_EXP_POW¶
-
enumerator OPTIMIZATION_SIMPLIFY_OPS¶
-
enumerator OPTIMIZATION_NO_DYNAMIC_PROPERTIES¶
Turn off dynamic control of any ops that offer adjustment of parameter values after finalization (e.g. ExposureContrast).
-
enumerator OPTIMIZATION_ALL¶
Apply all possible optimizations.
-
enumerator OPTIMIZATION_LOSSLESS¶
-
enumerator OPTIMIZATION_VERY_GOOD¶
-
enumerator OPTIMIZATION_GOOD¶
-
enumerator OPTIMIZATION_DRAFT¶
For quite lossy optimizations.
-
enumerator OPTIMIZATION_DEFAULT¶
-
enumerator OPTIMIZATION_NONE¶