HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
VarsFormatMetadata

Variables

OCIOEXPORT const char * OCIO_NAMESPACE::METADATA_DESCRIPTION
 
OCIOEXPORT const char * OCIO_NAMESPACE::METADATA_INFO
 
OCIOEXPORT const char * OCIO_NAMESPACE::METADATA_INPUT_DESCRIPTOR
 
OCIOEXPORT const char * OCIO_NAMESPACE::METADATA_OUTPUT_DESCRIPTOR
 
OCIOEXPORT const char * OCIO_NAMESPACE::METADATA_NAME
 
OCIOEXPORT const char * OCIO_NAMESPACE::METADATA_ID
 

Detailed Description

Variable Documentation

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.