HDK
|
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 |
A config defines all the color spaces to be available at runtime. More... | |
class | FileRules |
The File Rules are a set of filepath to color space mappings that are evaluated from first to last. The first rule to match is what determines which color space is returned. There are four types of rules available. Each rule type has a name key that may be used by applications to refer to that rule. Name values must be unique i.e. using a case insensitive comparison. The other keys depend on the rule type: More... | |
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 |
This class holds the GPU-related information needed to build a shader program from a specific processor. More... | |
class | Context |
class | BuiltinTransformRegistry |
class | BuiltinConfigRegistry |
class | SystemMonitors |
class | ConfigIOProxy |
class | FormatMetadata |
class | Transform |
Base class for all the transform classes. More... | |
class | AllocationTransform |
class | BuiltinTransform |
class | CDLTransform |
An implementation of the ASC Color Decision List (CDL), based on the ASC v1.2 specification. More... | |
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 |
Typically only needed when creating and/or manipulating configurations
rst::
Definition at line 132 of file OpenColorTypes.h.
Definition at line 85 of file OpenColorTypes.h.
Definition at line 136 of file OpenColorTypes.h.
Definition at line 102 of file OpenColorTypes.h.
Definition at line 140 of file OpenColorTypes.h.
Definition at line 241 of file OpenColorTypes.h.
Definition at line 245 of file OpenColorTypes.h.
Definition at line 45 of file OpenColorTypes.h.
Definition at line 49 of file OpenColorTypes.h.
Definition at line 144 of file OpenColorTypes.h.
using OCIO_NAMESPACE::ComputeHashFunction = typedef std::function<std::string(const std::string &)> |
Define Compute Hash function signature.
Definition at line 281 of file OpenColorTypes.h.
Definition at line 119 of file OpenColorTypes.h.
Definition at line 33 of file OpenColorTypes.h.
Definition at line 131 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const Baker> OCIO_NAMESPACE::ConstBakerRcPtr |
Definition at line 84 of file OpenColorTypes.h.
Definition at line 135 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const BuiltinTransformRegistry> OCIO_NAMESPACE::ConstBuiltinTransformRegistryRcPtr |
Definition at line 103 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const CDLTransform> OCIO_NAMESPACE::ConstCDLTransformRcPtr |
Definition at line 139 of file OpenColorTypes.h.
Definition at line 243 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const ColorSpaceMenuParameters> OCIO_NAMESPACE::ConstColorSpaceMenuParametersRcPtr |
Definition at line 247 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const ColorSpace> OCIO_NAMESPACE::ConstColorSpaceRcPtr |
Definition at line 44 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const ColorSpaceSet> OCIO_NAMESPACE::ConstColorSpaceSetRcPtr |
Definition at line 48 of file OpenColorTypes.h.
Definition at line 143 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const ConfigIOProxy> OCIO_NAMESPACE::ConstConfigIOProxyRcPtr |
Definition at line 118 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const Config> OCIO_NAMESPACE::ConstConfigRcPtr |
Definition at line 32 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const Context> OCIO_NAMESPACE::ConstContextRcPtr |
Definition at line 64 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const CPUProcessor> OCIO_NAMESPACE::ConstCPUProcessorRcPtr |
Definition at line 72 of file OpenColorTypes.h.
Definition at line 147 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const DynamicPropertyDouble> OCIO_NAMESPACE::ConstDynamicPropertyDoubleRcPtr |
Definition at line 155 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const DynamicPropertyGradingPrimary> OCIO_NAMESPACE::ConstDynamicPropertyGradingPrimaryRcPtr |
Definition at line 159 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const DynamicPropertyGradingRGBCurve> OCIO_NAMESPACE::ConstDynamicPropertyGradingRGBCurveRcPtr |
Definition at line 163 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const DynamicPropertyGradingTone> OCIO_NAMESPACE::ConstDynamicPropertyGradingToneRcPtr |
Definition at line 167 of file OpenColorTypes.h.
Definition at line 151 of file OpenColorTypes.h.
Definition at line 171 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const ExponentWithLinearTransform> OCIO_NAMESPACE::ConstExponentWithLinearTransformRcPtr |
Definition at line 175 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const ExposureContrastTransform> OCIO_NAMESPACE::ConstExposureContrastTransformRcPtr |
Definition at line 179 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const FileRules> OCIO_NAMESPACE::ConstFileRulesRcPtr |
Definition at line 36 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const FileTransform> OCIO_NAMESPACE::ConstFileTransformRcPtr |
Definition at line 183 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const FixedFunctionTransform> OCIO_NAMESPACE::ConstFixedFunctionTransformRcPtr |
Definition at line 187 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const GPUProcessor> OCIO_NAMESPACE::ConstGPUProcessorRcPtr |
Definition at line 76 of file OpenColorTypes.h.
Definition at line 95 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const GpuShaderDesc> OCIO_NAMESPACE::ConstGpuShaderDescRcPtr |
Definition at line 99 of file OpenColorTypes.h.
Definition at line 110 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const GradingPrimaryTransform> OCIO_NAMESPACE::ConstGradingPrimaryTransformRcPtr |
Definition at line 191 of file OpenColorTypes.h.
Definition at line 114 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const GradingRGBCurveTransform> OCIO_NAMESPACE::ConstGradingRGBCurveTransformRcPtr |
Definition at line 195 of file OpenColorTypes.h.
Definition at line 199 of file OpenColorTypes.h.
Definition at line 203 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const ImageDesc> OCIO_NAMESPACE::ConstImageDescRcPtr |
Definition at line 89 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const LegacyViewingPipeline> OCIO_NAMESPACE::ConstLegacyViewingPipelineRcPtr |
Definition at line 255 of file OpenColorTypes.h.
Definition at line 207 of file OpenColorTypes.h.
Definition at line 211 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const LogTransform> OCIO_NAMESPACE::ConstLogTransformRcPtr |
Definition at line 219 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const Look> OCIO_NAMESPACE::ConstLookRcPtr |
Definition at line 52 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const LookTransform> OCIO_NAMESPACE::ConstLookTransformRcPtr |
Definition at line 215 of file OpenColorTypes.h.
Definition at line 223 of file OpenColorTypes.h.
Definition at line 227 of file OpenColorTypes.h.
Definition at line 231 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const MixingColorSpaceManager> OCIO_NAMESPACE::ConstMixingColorSpaceManagerRcPtr |
Definition at line 251 of file OpenColorTypes.h.
Definition at line 56 of file OpenColorTypes.h.
Definition at line 80 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const Processor> OCIO_NAMESPACE::ConstProcessorRcPtr |
Definition at line 68 of file OpenColorTypes.h.
Definition at line 235 of file OpenColorTypes.h.
Definition at line 107 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const Transform> OCIO_NAMESPACE::ConstTransformRcPtr |
Definition at line 127 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const ViewingRules> OCIO_NAMESPACE::ConstViewingRulesRcPtr |
Definition at line 40 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<const ViewTransform> OCIO_NAMESPACE::ConstViewTransformRcPtr |
Definition at line 60 of file OpenColorTypes.h.
Definition at line 65 of file OpenColorTypes.h.
Definition at line 73 of file OpenColorTypes.h.
Definition at line 148 of file OpenColorTypes.h.
Definition at line 156 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<DynamicPropertyGradingPrimary> OCIO_NAMESPACE::DynamicPropertyGradingPrimaryRcPtr |
Definition at line 160 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<DynamicPropertyGradingRGBCurve> OCIO_NAMESPACE::DynamicPropertyGradingRGBCurveRcPtr |
Definition at line 164 of file OpenColorTypes.h.
Definition at line 168 of file OpenColorTypes.h.
Definition at line 152 of file OpenColorTypes.h.
Definition at line 172 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<ExponentWithLinearTransform> OCIO_NAMESPACE::ExponentWithLinearTransformRcPtr |
Definition at line 176 of file OpenColorTypes.h.
Definition at line 180 of file OpenColorTypes.h.
Definition at line 37 of file OpenColorTypes.h.
Definition at line 184 of file OpenColorTypes.h.
Definition at line 188 of file OpenColorTypes.h.
typedef std::array<float, 3> OCIO_NAMESPACE::Float3 |
Definition at line 121 of file OpenColorTypes.h.
Definition at line 77 of file OpenColorTypes.h.
Definition at line 94 of file OpenColorTypes.h.
Definition at line 98 of file OpenColorTypes.h.
Definition at line 111 of file OpenColorTypes.h.
Definition at line 192 of file OpenColorTypes.h.
Definition at line 115 of file OpenColorTypes.h.
Definition at line 196 of file OpenColorTypes.h.
Definition at line 200 of file OpenColorTypes.h.
Definition at line 204 of file OpenColorTypes.h.
Definition at line 88 of file OpenColorTypes.h.
Definition at line 253 of file OpenColorTypes.h.
Definition at line 208 of file OpenColorTypes.h.
Definition at line 212 of file OpenColorTypes.h.
using OCIO_NAMESPACE::LoggingFunction = typedef std::function<void(const char*)> |
Define the logging function signature.
Definition at line 265 of file OpenColorTypes.h.
Definition at line 220 of file OpenColorTypes.h.
typedef OCIO_SHARED_PTR<Look> OCIO_NAMESPACE::LookRcPtr |
Definition at line 53 of file OpenColorTypes.h.
Definition at line 216 of file OpenColorTypes.h.
Definition at line 224 of file OpenColorTypes.h.
Definition at line 228 of file OpenColorTypes.h.
Definition at line 232 of file OpenColorTypes.h.
Definition at line 249 of file OpenColorTypes.h.
Definition at line 57 of file OpenColorTypes.h.
Definition at line 81 of file OpenColorTypes.h.
Definition at line 69 of file OpenColorTypes.h.
Definition at line 236 of file OpenColorTypes.h.
Definition at line 106 of file OpenColorTypes.h.
Definition at line 128 of file OpenColorTypes.h.
Definition at line 41 of file OpenColorTypes.h.
Definition at line 61 of file OpenColorTypes.h.
Enumerator | |
---|---|
ALLOCATION_UNKNOWN | |
ALLOCATION_UNIFORM | |
ALLOCATION_LG2 |
Definition at line 439 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.
Definition at line 408 of file OpenColorTypes.h.
Enumeration of the :cpp:class:CDLTransform
transform algorithms.
Enumerator | |
---|---|
CDL_ASC |
ASC CDL specification v1.2. |
CDL_NO_CLAMP |
CDL that does not clamp. |
CDL_TRANSFORM_DEFAULT |
Definition at line 507 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 430 of file OpenColorTypes.h.
Enumerator | |
---|---|
COLORSPACE_DIR_TO_REFERENCE | |
COLORSPACE_DIR_FROM_REFERENCE |
Definition at line 324 of file OpenColorTypes.h.
Enumerator | |
---|---|
COLORSPACE_ACTIVE | |
COLORSPACE_INACTIVE | |
COLORSPACE_ALL |
Definition at line 304 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 535 of file OpenColorTypes.h.
Controls which environment variables are loaded into a Context object.
Enumerator | |
---|---|
ENV_ENVIRONMENT_UNKNOWN | |
ENV_ENVIRONMENT_LOAD_PREDEFINED |
Only load vars in the config's environment section. |
ENV_ENVIRONMENT_LOAD_ALL |
Load all env. vars (note: may reduce performance) |
Definition at line 460 of file OpenColorTypes.h.
Enumeration of the :cpp:class:ExposureContrastTransform
transform algorithms.
Definition at line 493 of file OpenColorTypes.h.
Enumeration of the :cpp:class:FixedFunctionTransform
transform algorithms.
Definition at line 475 of file OpenColorTypes.h.
Used when there is a choice of hardware shader language.
Definition at line 446 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 527 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.
Definition at line 390 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 269 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 422 of file OpenColorTypes.h.
Enumerator | |
---|---|
NAMEDTRANSFORM_ACTIVE | |
NAMEDTRANSFORM_INACTIVE | |
NAMEDTRANSFORM_ALL |
Definition at line 311 of file OpenColorTypes.h.
Negative values handling style for ExponentTransform and ExponentWithLinearTransform transform algorithms.
Definition at line 518 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.
Definition at line 567 of file OpenColorTypes.h.
enum OCIO_NAMESPACE::ProcessorCacheFlags : unsigned int |
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 667 of file OpenColorTypes.h.
A RangeTransform may be set to clamp the values, or not.
Enumerator | |
---|---|
RANGE_NO_CLAMP | |
RANGE_CLAMP |
Definition at line 468 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 291 of file OpenColorTypes.h.
Types for GradingRGBCurve.
Enumerator | |
---|---|
RGB_RED | |
RGB_GREEN | |
RGB_BLUE | |
RGB_MASTER | |
RGB_NUM_CURVES |
Definition at line 546 of file OpenColorTypes.h.
Enumerator | |
---|---|
SEARCH_REFERENCE_SPACE_SCENE | |
SEARCH_REFERENCE_SPACE_DISPLAY | |
SEARCH_REFERENCE_SPACE_ALL |
Definition at line 297 of file OpenColorTypes.h.
Enumerator | |
---|---|
TRANSFORM_DIR_FORWARD | |
TRANSFORM_DIR_INVERSE |
Definition at line 336 of file OpenColorTypes.h.
Definition at line 342 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 556 of file OpenColorTypes.h.
Enumerator | |
---|---|
VIEWTRANSFORM_DIR_TO_REFERENCE | |
VIEWTRANSFORM_DIR_FROM_REFERENCE |
Definition at line 330 of file OpenColorTypes.h.
Enumerator | |
---|---|
VIEW_SHARED | |
VIEW_DISPLAY_DEFINED |
Definition at line 318 of file OpenColorTypes.h.
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.
OCIOEXPORT TransformDirection OCIO_NAMESPACE::CombineTransformDirections | ( | TransformDirection | d1, |
TransformDirection | d2 | ||
) |
|
inline |
Definition at line 259 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 void OCIO_NAMESPACE::ExtractOCIOZArchive | ( | const char * | archivePath, |
const char * | destinationDir | ||
) |
Extract an OCIO Config archive.
Converts an archived config file (.ocioz file) back to its original form as a config file and associated LUT files. This creates destinationDir and then creates a config.ocio file at the root of that working directory and then unpacks the LUT files into their relative locations relative to that working directory, creating any necessary sub-directories in the process. Note that configs which contain LUT files outside the working directory are not archivable, and so this function will not create directories outside the working directory.
archivePath | Absolute path to the .ocioz file. |
destinationDir | Absolute path of the directory you want to be created to contain the contents of the unarchived config. |
Exception | If the archive is not found or there is a problem extracting it. |
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 bool OCIO_NAMESPACE::operator!= | ( | const GradingRGBM & | lhs, |
const GradingRGBM & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator!= | ( | const GradingPrimary & | lhs, |
const GradingPrimary & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator!= | ( | const GradingControlPoint & | lhs, |
const GradingControlPoint & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator!= | ( | const GradingBSplineCurve & | lhs, |
const GradingBSplineCurve & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator!= | ( | const GradingRGBCurve & | lhs, |
const GradingRGBCurve & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator!= | ( | const GradingRGBMSW & | lhs, |
const GradingRGBMSW & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator!= | ( | const GradingTone & | lhs, |
const GradingTone & | rhs | ||
) |
OCIOEXPORT ConstColorSpaceSetRcPtr OCIO_NAMESPACE::operator&& | ( | const ConstColorSpaceSetRcPtr & | lcss, |
const ConstColorSpaceSetRcPtr & | rcss | ||
) |
Perform the intersection of two sets.
lcss | |
rcss |
OCIOEXPORT ConstColorSpaceSetRcPtr OCIO_NAMESPACE::operator- | ( | const ConstColorSpaceSetRcPtr & | lcss, |
const ConstColorSpaceSetRcPtr & | rcss | ||
) |
Perform the difference of two sets.
lcss | |
rcss |
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 & | |||
) |
|
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 & | |||
) |
|
noexcept |
|
noexcept |
|
noexcept |
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 LogCameraTransform & | |||
) |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const LogTransform & | |||
) |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const Config & | |||
) |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const LookTransform & | |||
) |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const Lut1DTransform & | |||
) |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const FileRules & | |||
) |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const Lut3DTransform & | |||
) |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const ViewingRules & | |||
) |
|
noexcept |
|
noexcept |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const ColorSpace & | |||
) |
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 ViewTransform & | |||
) |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const ImageDesc & | |||
) |
OCIOEXPORT std::ostream& OCIO_NAMESPACE::operator<< | ( | std::ostream & | , |
const Context & | |||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator== | ( | const GradingRGBM & | lhs, |
const GradingRGBM & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator== | ( | const GradingPrimary & | lhs, |
const GradingPrimary & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator== | ( | const GradingControlPoint & | lhs, |
const GradingControlPoint & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator== | ( | const GradingBSplineCurve & | lhs, |
const GradingBSplineCurve & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator== | ( | const GradingRGBCurve & | lhs, |
const GradingRGBCurve & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator== | ( | const GradingRGBMSW & | lhs, |
const GradingRGBMSW & | rhs | ||
) |
OCIOEXPORT bool OCIO_NAMESPACE::operator== | ( | const GradingTone & | lhs, |
const GradingTone & | rhs | ||
) |
OCIOEXPORT ConstColorSpaceSetRcPtr OCIO_NAMESPACE::operator|| | ( | const ConstColorSpaceSetRcPtr & | lcss, |
const ConstColorSpaceSetRcPtr & | rcss | ||
) |
Perform the union of two sets.
ColorSpaceSetOperators
lcss | |
rcss |
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 | ( | ) |
|
noexcept |
Make a config path forward-compatible by replacing special built-in config names with the current name.
Application developers should call this function on any config path they intend to persist (e.g., to include in a file saved from a DCC).
As the built-in config collection evolves, special names such as "ocio://default" and "ocio://studio-config-latest" will point to newer versions of those configs. Therefore, it is recommended that application developers not save those strings and instead save the string that refers to the current version of that config. That way, it's guaranteed that there will be no change of behavior in the future. For example, as of OCIO 2.3, "ocio://default" should be saved as "ocio://cg-config-v2.1.0_aces-v1.3_ocio-v2.3".
Note that there is no validation done on the path. That is left to the application since typically the application will load the config before attempting to save its path and therefore catch, for example, a badly formed URI such as "ocio:default".
OCIOEXPORT void OCIO_NAMESPACE::SetComputeHashFunction | ( | ComputeHashFunction | hashFunction | ) |
Set the Compute Hash Function to use; otherwise, use the default.
This is not used when using CreateFromFile with an OCIOZ archive or CreateFromConfigIOProxy.
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 | ||
) |
OCIOEXPORT void OCIO_NAMESPACE::SetLoggingFunction | ( | LoggingFunction | logFunction | ) |
Set the logging function to use; otherwise, use the default (i.e. std::cerr).
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 | ) |
Definition at line 130 of file OpenColorTypes.h.
const ptrdiff_t OCIO_NAMESPACE::AutoStride = std::numeric_limits<ptrdiff_t>::min() |
Definition at line 2897 of file OpenColorIO.h.
Definition at line 83 of file OpenColorTypes.h.
Definition at line 134 of file OpenColorTypes.h.
Definition at line 101 of file OpenColorTypes.h.
Definition at line 138 of file OpenColorTypes.h.
Definition at line 43 of file OpenColorTypes.h.
Definition at line 47 of file OpenColorTypes.h.
Definition at line 142 of file OpenColorTypes.h.
Definition at line 31 of file OpenColorTypes.h.
Definition at line 117 of file OpenColorTypes.h.
Definition at line 63 of file OpenColorTypes.h.
Definition at line 71 of file OpenColorTypes.h.
Definition at line 146 of file OpenColorTypes.h.
Definition at line 150 of file OpenColorTypes.h.
Definition at line 154 of file OpenColorTypes.h.
Definition at line 158 of file OpenColorTypes.h.
Definition at line 162 of file OpenColorTypes.h.
Definition at line 166 of file OpenColorTypes.h.
Definition at line 91 of file OpenColorTypes.h.
Definition at line 170 of file OpenColorTypes.h.
Definition at line 174 of file OpenColorTypes.h.
Definition at line 178 of file OpenColorTypes.h.
Definition at line 35 of file OpenColorTypes.h.
Definition at line 182 of file OpenColorTypes.h.
Definition at line 186 of file OpenColorTypes.h.
Definition at line 75 of file OpenColorTypes.h.
Definition at line 93 of file OpenColorTypes.h.
Definition at line 97 of file OpenColorTypes.h.
Definition at line 109 of file OpenColorTypes.h.
Definition at line 190 of file OpenColorTypes.h.
Definition at line 113 of file OpenColorTypes.h.
Definition at line 194 of file OpenColorTypes.h.
Definition at line 198 of file OpenColorTypes.h.
Definition at line 202 of file OpenColorTypes.h.
Definition at line 87 of file OpenColorTypes.h.
Definition at line 206 of file OpenColorTypes.h.
Definition at line 210 of file OpenColorTypes.h.
Definition at line 218 of file OpenColorTypes.h.
Definition at line 51 of file OpenColorTypes.h.
Definition at line 214 of file OpenColorTypes.h.
Definition at line 222 of file OpenColorTypes.h.
Definition at line 226 of file OpenColorTypes.h.
Definition at line 230 of file OpenColorTypes.h.
OCIOEXPORT const char* OCIO_NAMESPACE::METADATA_DESCRIPTION |
rst:: FormatMetadata
These constants describe various types of rich metadata. They are used with FormatMetadata objects as the "name" part of a (name, value) pair. All of these types of metadata are supported in the CLF/CTF file formats whereas other formats support some or none of them.
Although the string constants used here match those used in the CLF/CTF formats, the concepts are generic, so the goal is for other file formats to reuse the same constants within a FormatMetadata object (even if the syntax used in a given format is somewhat different). A description string – used as the "Description" element in CLF/CTF and CDL, and to hold comments for other LUT formats when baking.
OCIOEXPORT const char* OCIO_NAMESPACE::METADATA_ID |
An ID string – used as an "id" attribute in CLF/CTF elements. Use on a GroupTransform to get/set the id for the CLF/CTF ProcessList. Use on an individual Transform (i.e. MatrixTransform, etc.) to get/set the id of the corresponding process node.
OCIOEXPORT const char* OCIO_NAMESPACE::METADATA_INFO |
A block of informative metadata such as the "Info" element in CLF/CTF. Usually contains child elements.
OCIOEXPORT const char* OCIO_NAMESPACE::METADATA_INPUT_DESCRIPTOR |
A string describing the expected input color space – used as the "InputDescriptor" element in CLF/CTF and the "InputDescription" in CDL.
OCIOEXPORT const char* OCIO_NAMESPACE::METADATA_NAME |
A name string – used as a "name" attribute in CLF/CTF elements. Use on a GroupTransform to get/set the name for the CLF/CTF ProcessList. Use on an individual Transform (i.e. MatrixTransform, etc.) to get/set the name of the corresponding process node.
OCIOEXPORT const char* OCIO_NAMESPACE::METADATA_OUTPUT_DESCRIPTOR |
A string describing the output color space – used as the "OutputDescriptor" element in CLF/CTF and the "OutputDescription" in CDL.
Definition at line 55 of file OpenColorTypes.h.
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_ACTIVE_DISPLAYS_ENVVAR |
The envvar 'OCIO_ACTIVE_DISPLAYS' provides a list of displays overriding the 'active_displays' list from the config file.
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_ACTIVE_VIEWS_ENVVAR |
The envvar 'OCIO_ACTIVE_VIEWS' provides a list of views overriding the 'active_views' list from the config file.
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_BUILTIN_URI_PREFIX |
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_CONFIG_ARCHIVE_FILE_EXT |
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_CONFIG_DEFAULT_FILE_EXT |
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_CONFIG_DEFAULT_NAME |
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_CONFIG_ENVVAR |
The envvar 'OCIO' provides a path to the config file used by Config::CreateFromEnv.
Env. variables.
These environmental variables are used by the OpenColorIO library. For variables that allow specifying more than one token, they should be separated by commas.
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_DISABLE_ALL_CACHES |
rst::
rst:: Caches
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_DISABLE_CACHE_FALLBACK |
rst::
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_DISABLE_PROCESSOR_CACHES |
rst::
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_INACTIVE_COLORSPACES_ENVVAR |
The envvar 'OCIO_INACTIVE_COLORSPACES' provides a list of inactive color spaces overriding the 'inactive_color_spaces' list from the config file.
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_OPTIMIZATION_FLAGS_ENVVAR |
The envvar 'OCIO_OPTIMIZATION_FLAGS' provides a way to force a given optimization level. Remove the variable or set the value to empty to not use it. Set the value of the variable to the desired optimization level as either an integer or hexadecimal value. Ex: OCIO_OPTIMIZATION_FLAGS="20479" or "0x4FFF" for OPTIMIZATION_LOSSLESS.
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_USER_CATEGORIES_ENVVAR |
The envvar 'OCIO_USER_CATEGORIES' allows the end-user to filter color spaces shown by applications. Only color spaces that include at least one of the supplied categories will be shown in application menus. Note that applications may also impose their own category filtering in addition to the user-supplied categories. For example, an application may filter by 'working-space' for a menu to select a working space while the user may also filter by '3d-basic' to only show spaces intended for 3d artists who should see the basic set of color spaces. The categories will be ignored if they would result in no color spaces being found.
OCIOEXPORT const char* OCIO_NAMESPACE::OCIO_VIEW_USE_DISPLAY_NAME |
rst:: Shared View A shared view using this for the color space name will use a display color space that has the same name as the display the shared view is used by.
Definition at line 67 of file OpenColorTypes.h.
Definition at line 79 of file OpenColorTypes.h.
Definition at line 234 of file OpenColorTypes.h.
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_COLOR_PICKING |
"color_picking"
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_COLOR_TIMING |
"color_timing"
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_COMPOSITING_LOG |
"compositing_log"
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_DATA |
"data"
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_DEFAULT |
"default"
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:: Extracting color space from file path - (ROLE_DEFAULT) Interchange color spaces between configs - (ROLE_EXCHANGE_SCENE, ROLE_EXCHANGE_DISPLAY)
App Helpers:: LegacyViewingPipeline - (ROLE_SCENE_LINEAR (LinearCC for exposure)) (ROLE_COLOR_TIMING (ColorTimingCC)) MixingColorSpaceManager - (ROLE_COLOR_PICKING)
External Plugins (currently known)::
Colorpicker UIs - (ROLE_COLOR_PICKING) Compositor LogConvert - (ROLE_SCENE_LINEAR, ROLE_COMPOSITING_LOG)
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_INTERCHANGE_DISPLAY |
The cie_xyz_d65_interchange role is used to specify which color space in the config implements CIE XYZ colorimetry with the neutral axis at D65. This may be used when converting display-referred colors from one config to another.
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_INTERCHANGE_SCENE |
The aces_interchange role is used to specify which color space in the config implements the standard ACES2065-1 color space (SMPTE ST2065-1). This may be used when converting scene-referred colors from one config to another.
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_MATTE_PAINT |
This role defines the transform for matte painting. In some workflows this is a 1D HDR to LDR allocation. It is normally combined with another display transform in the host app for preview.
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_REFERENCE |
"reference"
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_RENDERING |
The rendering role may be used to identify a specific color space to be used by CGI renderers. This is typically a scene-linear space but the primaries also matter since they influence the resulting color, especially in areas of indirect illumination.
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_SCENE_LINEAR |
"scene_linear"
OCIOEXPORT const char* OCIO_NAMESPACE::ROLE_TEXTURE_PAINT |
This role defines the transform for painting textures. In some workflows this is just a inverse display gamma with some limits
Definition at line 105 of file OpenColorTypes.h.
Definition at line 126 of file OpenColorTypes.h.
Definition at line 39 of file OpenColorTypes.h.
Definition at line 59 of file OpenColorTypes.h.