|
ViewingRulesRcPtr | createEditableCopy () const |
| The method clones the content decoupling the two instances. More...
|
|
size_t | getNumEntries () const noexcept |
|
size_t | getIndexForRule (const char *ruleName) const |
|
const char * | getName (size_t ruleIndex) const |
| Get name of the rule. Will throw if ruleIndex is invalid. More...
|
|
size_t | getNumColorSpaces (size_t ruleIndex) const |
| Get number of colorspaces. Will throw if ruleIndex is invalid. More...
|
|
const char * | getColorSpace (size_t ruleIndex, size_t colorSpaceIndex) const |
| Get colorspace name. Will throw if ruleIndex or colorSpaceIndex is invalid. More...
|
|
void | addColorSpace (size_t ruleIndex, const char *colorSpace) |
| Add colorspace name. Will throw if: More...
|
|
void | removeColorSpace (size_t ruleIndex, size_t colorSpaceIndex) |
| Remove colorspace. Will throw if ruleIndex or colorSpaceIndex is invalid. More...
|
|
size_t | getNumEncodings (size_t ruleIndex) const |
| Get number of encodings. Will throw if ruleIndex is invalid. More...
|
|
const char * | getEncoding (size_t ruleIndex, size_t encodingIndex) const |
| Get encoding name. Will throw if ruleIndex or encodingIndex is invalid. More...
|
|
void | addEncoding (size_t ruleIndex, const char *encoding) |
| Add encoding name. Will throw if: More...
|
|
void | removeEncoding (size_t ruleIndex, size_t encodingIndex) |
| Remove encoding. Will throw if ruleIndex or encodingIndex is invalid. More...
|
|
size_t | getNumCustomKeys (size_t ruleIndex) const |
| Get number of key/value pairs. Will throw if ruleIndex is invalid. More...
|
|
const char * | getCustomKeyName (size_t ruleIndex, size_t keyIndex) const |
| Get name of key. Will throw if ruleIndex or keyIndex is invalid. More...
|
|
const char * | getCustomKeyValue (size_t ruleIndex, size_t keyIndex) const |
| Get value for the key. Will throw if ruleIndex or keyIndex is invalid. More...
|
|
void | setCustomKey (size_t ruleIndex, const char *key, const char *value) |
|
void | insertRule (size_t ruleIndex, const char *ruleName) |
| Insert a rule at a given ruleIndex. More...
|
|
void | removeRule (size_t ruleIndex) |
| Remove a rule. Throws if ruleIndex is not valid. More...
|
|
| ViewingRules (const ViewingRules &)=delete |
|
ViewingRules & | operator= (const ViewingRules &)=delete |
|
virtual | ~ViewingRules () |
| Do not use (needed only for pybind11). More...
|
|
ViewingRules
Viewing Rules allow config authors to filter the list of views an application should offer based on the color space of an image. For example, a config may define a large number of views but not all of them may be appropriate for use with all color spaces. E.g., some views may be intended for use with scene-linear color space encodings and others with video color space encodings.
Each rule has a name key for applications to refer to the rule. Name values must be unique (using case insensitive comparison). Viewing Rules may also have the following keys:
- colorspaces: Either a single colorspace name or a list of names.
- encodings: One or more strings to be found in the colorspace's encoding attribute. Either this attribute or colorspaces must be present, but not both.
- custom : Allows arbitrary key / value string pairs, similar to FileRules.
Getters and setters are using the rule position, they will throw if the position is not valid.
Definition at line 1754 of file OpenColorIO.h.