Config

Caution

API Docs are a work in progress, expect them to improve over time.

A config defines all the color spaces to be available at runtime.

The color configuration (Config) is the main object for interacting with this library. It encapsulates all of the information necessary to use customized ColorSpaceTransform and DisplayViewTransform operations.

See the user-guide for more information on selecting, creating, and working with custom color configurations.

For applications interested in using only one color config at a time (this is the vast majority of apps), their API would traditionally get the global configuration and use that, as opposed to creating a new one. This simplifies the use case for plugins and bindings, as it alleviates the need to pass around configuration handles.

An example of an application where this would not be sufficient would be a multi-threaded image proxy server (daemon), which wished to handle multiple show configurations in a single process concurrently. This app would need to keep multiple configurations alive, and to manage them appropriately.

Roughly speaking, a novice user should select a default configuration that most closely approximates the use case (animation, visual effects, etc.), and set the OCIO environment variable to point at the root of that configuration.

Note

Initialization using environment variables is typically preferable in a multi-app ecosystem, as it allows all applications to be consistently configured.

class Config

ConfigRcPtr createEditableCopy() const
unsigned int getMajorVersion() const

Get the configuration major version.

void setMajorVersion(unsigned int major)

Set the configuration major version.

unsigned int getMinorVersion() const

Get the configuration minor version.

void setMinorVersion(unsigned int minor)

Set the configuration minor version.

void upgradeToLatestVersion()

Allows an older config to be serialized as the current version.

void sanityCheck() const

Performs a thorough sanity check for the most common user errors.

This will throw an exception if the config is malformed. The most common error occurs when references are made to colorspaces that do not exist.

char getFamilySeparator() const

If not empty or null a single character to separate the family string in levels.

void setFamilySeparator(char separator)

Succeeds if the characters is null or a valid character from the ASCII table i.e. from value 32 (i.e. space) to 126 (i.e. ‘~’); otherwise, it throws an exception.

const char *getDescription() const
void setDescription(const char *description)
void serialize(std::ostream &os) const

Returns the string representation of the Config in YAML text form.

This is typically stored on disk in a file with the extension .ocio.

const char *getCacheID() const

This will produce a hash of the all colorspace definitions, etc. All external references, such as files used in FileTransforms, etc., will be incorporated into the cacheID. While the contents of the files are not read, the file system is queried for relevant information (mtime, inode) so that the config’s cacheID will change when the underlying luts are updated. If a context is not provided, the current Context will be used. If a null context is provided, file references will not be taken into account (this is essentially a hash of `Config::serialize`_).

const char *getCacheID(const ConstContextRcPtr &context) const
ConstContextRcPtr getCurrentContext() const
void addEnvironmentVar(const char *name, const char *defaultValue)
int getNumEnvironmentVars() const
const char *getEnvironmentVarNameByIndex(int index) const
const char *getEnvironmentVarDefault(const char *name) const
void clearEnvironmentVars()
void setEnvironmentMode(EnvironmentMode mode)
EnvironmentMode getEnvironmentMode() const
void loadEnvironment()
const char *getSearchPath() const
void setSearchPath(const char *path)

Set all search paths as a concatenated string, ‘:’ to separate the paths.

See `addSearchPath`_ for a more robust and platform-agnostic method of setting the search paths.

int getNumSearchPaths() const
const char *getSearchPath(int index) const

Get a search path from the list.

The paths are in the order they will be searched (that is, highest to lowest priority).

void clearSearchPaths()
void addSearchPath(const char *path)

Add a single search path to the end of the list.

Paths may be either absolute or relative. Relative paths are relative to the working directory. Forward slashes will be normalized to reverse for Windows. Environment (context) variables may be used in paths.

const char *getWorkingDir() const
void setWorkingDir(const char *dirname)

The working directory defaults to the location of the config file. It is used to convert any relative paths to absolute. If no search paths have been set, the working directory will be used as the fallback search path. No environment (context) variables may be used in the working directory.

ColorSpaceSetRcPtr getColorSpaces(const char *category) const

Get all active color spaces having a specific category in the order they appear in the config file.

Note If the category is null or empty, the method returns all the active color spaces like :cpp:func:`Config::getNumColorSpaces`_ and :cpp:func:`Config::getColorSpaceNameByIndex`_ do.

Note It’s worth noticing that the method returns a copy of the selected color spaces decoupling the result from the config. Hence, any changes on the config do not affect the existing color space sets, and vice-versa.

int getNumColorSpaces(SearchReferenceSpaceType searchReferenceType, ColorSpaceVisibility visibility) const

Work on the color spaces selected by the reference color space type and visibility.

const char *getColorSpaceNameByIndex(SearchReferenceSpaceType searchReferenceType, ColorSpaceVisibility visibility, int index) const

Work on the color spaces selected by the reference color space type and visibility (active or inactive).

Return empty for invalid index.

ConstColorSpaceRcPtr getColorSpace(const char *name) const

Get the color space from all the color spaces (i.e. active and inactive) and return null if the name is not found.

Note The fcn accepts either a color space OR role name. (Color space names take precedence over roles.)

int getNumColorSpaces() const

Work on the active color spaces only.

Note Only works from the list of active color spaces.

const char *getColorSpaceNameByIndex(int index) const

Work on the active color spaces only and return null for invalid index.

Note Only works from the list of active color spaces.

int getIndexForColorSpace(const char *name) const

Get an index from the active color spaces only and return -1 if the name is not found.

Note The fcn accepts either a color space OR role name. (Color space names take precedence over roles.)

void addColorSpace(const ConstColorSpaceRcPtr &cs)

Add a color space to the configuration.

Note If another color space is already present with the same name, this will overwrite it. This stores a copy of the specified color space.

Note Adding a color space to a Config does not affect any ColorSpaceSet sets that have already been created.

void removeColorSpace(const char *name)

Remove a color space from the configuration.

Note It does not throw an exception if the color space is not present or used by an existing role. Role name arguments are ignored.

Note Removing a color space to a Config does not affect any ColorSpaceSet sets that have already been created.

bool isColorSpaceUsed(const char *name) const noexcept

Return true if the color space is used by a transform, a role, or a look.

void clearColorSpaces()

Remove all the color spaces from the configuration.

Note Removing color spaces from a Config does not affect any ColorSpaceSet sets that have already been created.

const char *parseColorSpaceFromString(const char *str) const

Given the specified string, get the longest, right-most, colorspace substring that appears.

  • If strict parsing is enabled, and no color space is found,

return an empty string.

  • If strict parsing is disabled, return ROLE_DEFAULT (if

defined).

  • If the default role is not defined, return an empty

string.

bool isStrictParsingEnabled() const
void setStrictParsingEnabled(bool enabled)
void setInactiveColorSpaces(const char *inactiveColorSpaces)

Set/get a list of inactive color space names.

  • The inactive spaces are color spaces that should not

appear in application menus.

  • These color spaces will still work in

:cpp:func:Config::getProcessor calls.

  • The argument is a comma-delimited string. A null or empty

string empties the list.

  • The environment variable OCIO_INACTIVE_COLORSPACES may

also be used to set the inactive color space list.

  • The env. var. takes precedence over the

inactive_colorspaces list in the config file.

  • Setting the list via the API takes precedence over either

the env. var. or the config file list.

  • Roles may not be used.

const char *getInactiveColorSpaces() const
void setRole(const char *role, const char *colorSpaceName)

Note Setting the colorSpaceName name to a null string unsets it.

int getNumRoles() const
bool hasRole(const char *role) const

Return true if the role has been defined.

const char *getRoleName(int index) const

Get the role name at index, this will return values like ‘scene_linear’, ‘compositing_log’.

Return empty string if index is out of range.

const char *getRoleColorSpace(int index) const

Get the role color space at index.

Return empty string if index is out of range.

void addSharedView(const char *view, const char *viewTransformName, const char *colorSpaceName, const char *looks, const char *ruleName, const char *description)

Will throw if view or colorSpaceName are null or empty.

void removeSharedView(const char *view)

Remove a shared view. Will throw if the view does not exist.

const char *getDefaultDisplay() const
int getNumDisplays() const
const char *getDisplay(int index) const

Will return “” if the index is invalid.

const char *getDefaultView(const char *display) const
int getNumViews(const char *display) const

Return the number of views attached to the display including the number of shared views if any. Return 0 if display does not exist.

const char *getView(const char *display, int index) const
int getNumViews(const char *display, const char *colorspaceName) const

If the config has ViewingRules, get the number of active Views for this colorspace. (If there are no rules, it returns all of them.)

const char *getView(const char *display, const char *colorspaceName, int index) const
const char *getDisplayViewTransformName(const char *display, const char *view) const

Returns the view_transform attribute of the (display, view) pair. View can be a shared view of the display. If display is null or empty, config shared views are used.

const char *getDisplayViewColorSpaceName(const char *display, const char *view) const

Returns the colorspace attribute of the (display, view) pair. (Note that this may be either a color space or a display color space.)

const char *getDisplayViewLooks(const char *display, const char *view) const

Returns the looks attribute of a (display, view) pair.

const char *getDisplayViewRule(const char *display, const char *view) const noexcept

Returns the rule attribute of a (display, view) pair.

const char *getDisplayViewDescription(const char *display, const char *view) const noexcept

Returns the description attribute of a (display, view) pair.

void addDisplayView(const char *display, const char *view, const char *colorSpaceName, const char *looks)

For the (display, view) pair, specify which color space and look to use. If a look is not desired, then just pass a null or empty string.

void addDisplayView(const char *display, const char *view, const char *viewTransformName, const char *colorSpaceName, const char *looks, const char *ruleName, const char *description)

For the (display, view) pair, specify the color space or alternatively specify the view transform and display color space. The looks, viewing rule, and description are optional. Pass a null or empty string for any optional arguments. If the view already exists, it is replaced.

Will throw if:

  • Display, view or colorSpace are null or empty.

  • Display already has a shared view with the same name.

void addDisplaySharedView(const char *display, const char *sharedView)

Add a (reference to a) shared view to a display.

The shared view must be part of the config. See `Config::addSharedView`_

This will throw if:

  • Display or view are null or empty.

  • Display already has a view (shared or not) with the same

name.

void removeDisplayView(const char *display, const char *view)

Remove the view and the display if no more views.

It does not remove the associated color space. If the view name is a shared view, it only removes the reference to the view from the display but the shared view, remains in the config.

Will throw if the view does not exist.

void clearDisplays()
void setActiveDisplays(const char *displays)

$OCIO_ACTIVE_DISPLAYS envvar can, at runtime, optionally override the allowed displays. It is a comma or colon delimited list. Active displays that are not in the specified profile will be ignored, and the left-most defined display will be the default.

Comma-delimited list of names to filter and order the active displays.

Note The setter does not override the envvar. The getter does not take into account the envvar value and thus may not represent what the user is seeing.

const char *getActiveDisplays() const
void setActiveViews(const char *views)

$OCIO_ACTIVE_VIEWS envvar can, at runtime, optionally override the allowed views. It is a comma or colon delimited list. Active views that are not in the specified profile will be ignored, and the left-most defined view will be the default.

Comma-delimited list of names to filter and order the active views.

Note The setter does not override the envvar. The getter does not take into account the envvar value and thus may not represent what the user is seeing.

const char *getActiveViews() const
int getNumDisplaysAll() const

Get all displays in the config, ignoring the active_displays list.

const char *getDisplayAll(int index) const
int getNumViews(ViewType type, const char *display) const

Get either the shared or display-defined views for a display. The active_views list is ignored. Passing a null or empty display (with type=VIEW_SHARED) returns the contents of the shared_views section of the config. Return 0 if display does not exist.

const char *getView(ViewType type, const char *display, int index) const**
ConstViewingRulesRcPtr getViewingRules() const noexcept

Get read-only version of the viewing rules.

void setViewingRules(ConstViewingRulesRcPtr viewingRules)

Set viewing rules.

Note The argument is cloned.

void getDefaultLumaCoefs(double *rgb) const

Get the default coefficients for computing luma.

Note There is no “1 size fits all” set of luma coefficients. (The values are typically different for each colorspace, and the application of them may be nonsensical depending on the intensity coding anyways). Thus, the ‘right’ answer is to make these functions on the :cpp:class:Config class. However, it’s often useful to have a config-wide default so here it is. We will add the colorspace specific luma call if/when another client is interesting in using it.

void setDefaultLumaCoefs(const double *rgb)

These should be normalized (sum to 1.0 exactly).

ConstLookRcPtr getLook(const char *name) const
int getNumLooks() const
const char *getLookNameByIndex(int index) const
void addLook(const ConstLookRcPtr &look)
void clearLooks()
int getNumViewTransforms() const noexcept
ConstViewTransformRcPtr getViewTransform(const char *name) const noexcept
const char *getViewTransformNameByIndex(int i) const noexcept
void addViewTransform(const ConstViewTransformRcPtr &viewTransform)
ConstViewTransformRcPtr getDefaultSceneToDisplayViewTransform() const

The default transform to use for scene-referred to display-referred reference space conversions is the first scene-referred view transform listed in that section of the config (the one with the lowest index). Returns a null ConstTransformRcPtr if there isn’t one.

void clearViewTransforms()
ConstFileRulesRcPtr getFileRules() const noexcept

Get read-only version of the file rules.

void setFileRules(ConstFileRulesRcPtr fileRules)

Set file rules.

Note The argument is cloned.

const char *getColorSpaceFromFilepath(const char *filePath) const

Get the color space of the first rule that matched filePath.

const char *getColorSpaceFromFilepath(const char *filePath, size_t &ruleIndex) const

Most applications will use the preceding method, but this method may be used for applications that want to know which was the highest priority rule to match filePath. The :cpp:func:`FileRules::getNumCustomKeys`_ and custom keys methods may then be used to get additional information about the matching rule.

bool filepathOnlyMatchesDefaultRule(const char *filePath) const

Returns true if the only rule matched by filePath is the default rule. This is a convenience method for applications that want to require the user to manually choose a color space when strictParsing is true and no other rules match.

ConstProcessorRcPtr getProcessor(const ConstContextRcPtr &context, const ConstColorSpaceRcPtr &srcColorSpace, const ConstColorSpaceRcPtr &dstColorSpace) const
ConstProcessorRcPtr getProcessor(const ConstColorSpaceRcPtr &srcColorSpace, const ConstColorSpaceRcPtr &dstColorSpace) const
ConstProcessorRcPtr getProcessor(const char *srcColorSpaceName, const char *dstColorSpaceName) const

Note Names can be colorspace name, role name, or a combination of both.

ConstProcessorRcPtr getProcessor(const ConstContextRcPtr &context, const char *srcColorSpaceName, const char *dstColorSpaceName) const
ConstProcessorRcPtr getProcessor(const char *srcColorSpaceName, const char *display, const char *view) const
ConstProcessorRcPtr getProcessor(const ConstContextRcPtr &context, const char *srcColorSpaceName, const char *display, const char *view) const
ConstProcessorRcPtr getProcessor(const ConstTransformRcPtr &transform) const

Get the processor for the specified transform.

Not often needed, but will allow for the re-use of atomic OCIO functionality (such as to apply an individual LUT file).

ConstProcessorRcPtr getProcessor(const ConstTransformRcPtr &transform, TransformDirection direction) const
ConstProcessorRcPtr getProcessor(const ConstContextRcPtr &context, const ConstTransformRcPtr &transform, TransformDirection direction) const
Config(const Config&) = delete
`Config`_ &operator=(const Config&) = delete
~Config()

-[ Public Static Functions ]-

ConfigRcPtr Create()

Create a default empty configuration.

ConstConfigRcPtr CreateRaw()

Create a fall-back config.

This may be useful to allow client apps to launch in cases when the supplied config path is not loadable.

ConstConfigRcPtr CreateFromEnv()

Create a configuration using the OCIO environment variable.

If the variable is missing or empty, returns the same result as `Config::CreateRaw`_ .

ConstConfigRcPtr CreateFromFile(const char *filename)

Create a configuration using a specific config file.

ConstConfigRcPtr CreateFromStream(std::istream &istream)

Create a configuration using a stream.

ConstProcessorRcPtr GetProcessorFromConfigs(const ConstConfigRcPtr &srcConfig, const char *srcColorSpaceName, const ConstConfigRcPtr &dstConfig, const char *dstColorSpaceName)

Get a processor to convert between color spaces in two separate configs.

This relies on both configs having the aces_interchange role (when srcName is scene-referred) or the role cie_xyz_d65_interchange (when srcName is display-referred) defined. An exception is thrown if that is not the case.

ConstProcessorRcPtr GetProcessorFromConfigs(const ConstContextRcPtr &srcContext, const ConstConfigRcPtr &srcConfig, const char *srcColorSpaceName, const ConstContextRcPtr &dstContext, const ConstConfigRcPtr &dstConfig, const char *dstColorSpaceName)
ConstProcessorRcPtr GetProcessorFromConfigs(const ConstConfigRcPtr &srcConfig, const char *srcColorSpaceName, const char *srcInterchangeName, const ConstConfigRcPtr &dstConfig, const char *dstColorSpaceName, const char *dstInterchangeName)

The srcInterchangeName and dstInterchangeName must refer to a pair of color spaces in the two configs that are the same. A role name may also be used.

ConstProcessorRcPtr GetProcessorFromConfigs(const ConstContextRcPtr &srcContext, const ConstConfigRcPtr &srcConfig, const char *srcColorSpaceName, const char *srcInterchangeName, const ConstContextRcPtr &dstContext, const ConstConfigRcPtr &dstConfig, const char *dstColorSpaceName, const char *dstInterchangeName)
class PyOpenColorIO.Config
class ActiveColorSpaceIterator
class ActiveColorSpaceNameIterator
class ColorSpaceIterator
class ColorSpaceNameIterator
CreateFromEnv()PyOpenColorIO.Config
CreateFromFile(fileName: str)PyOpenColorIO.Config
CreateFromStream(str: str)PyOpenColorIO.Config
CreateRaw()PyOpenColorIO.Config
class DisplayIterator
class EnvironmentVarNameIterator
GetProcessorFromConfigs(*args, **kwargs)

Overloaded function.

  1. GetProcessorFromConfigs(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str) → OpenColorIO_v2_0dev::Processor
  2. GetProcessorFromConfigs(srcContext: OpenColorIO_v2_0dev::Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, dstContext: OpenColorIO_v2_0dev::Context, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str) → OpenColorIO_v2_0dev::Processor
  3. GetProcessorFromConfigs(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str, dstInterchangeName: str) → OpenColorIO_v2_0dev::Processor
  4. GetProcessorFromConfigs(srcContext: OpenColorIO_v2_0dev::Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstContext: OpenColorIO_v2_0dev::Context, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str, dstInterchangeName: str) → OpenColorIO_v2_0dev::Processor
class LookIterator
class LookNameIterator
class RoleColorSpaceIterator
class RoleNameIterator
class SearchPathIterator
class SharedViewIterator
class ViewForColorSpaceIterator
class ViewIterator
class ViewTransformIterator
class ViewTransformNameIterator
addColorSpace(self: PyOpenColorIO.Config, colorSpace: OpenColorIO_v2_0dev::ColorSpace) → None
addDisplaySharedView(self: PyOpenColorIO.Config, display: str, view: str) → None
addDisplayView(*args, **kwargs)

Overloaded function.

1. addDisplayView(self: PyOpenColorIO.Config, display: str, view: str, colorSpaceName: str, looks: str) -> None

2. addDisplayView(self: PyOpenColorIO.Config, display: str, view: str, viewTransform: str, displayColorSpaceName: str, looks: str, ruleName: str, description: str) -> None

addEnvironmentVar(self: PyOpenColorIO.Config, name: str, defaultValue: str) → None
addLook(self: PyOpenColorIO.Config, look: OpenColorIO_v2_0dev::Look) → None
addSearchPath(self: PyOpenColorIO.Config, path: str) → None
addSharedView(self: PyOpenColorIO.Config, view: str, viewTransformName: str, colorSpaceName: str, looks: str, ruleName: str, description: str) → None
addViewTransform(self: PyOpenColorIO.Config, viewTransform: OpenColorIO_v2_0dev::ViewTransform) → None
clearColorSpaces(self: PyOpenColorIO.Config) → None
clearDisplays(self: PyOpenColorIO.Config) → None
clearEnvironmentVars(self: PyOpenColorIO.Config) → None
clearLooks(self: PyOpenColorIO.Config) → None
clearSearchPaths(self: PyOpenColorIO.Config) → None
clearViewTransforms(self: PyOpenColorIO.Config) → None
filepathOnlyMatchesDefaultRule(self: PyOpenColorIO.Config, filePath: str) → bool
getActiveDisplays(self: PyOpenColorIO.Config) → str
getActiveViews(self: PyOpenColorIO.Config) → str
getCacheID(*args, **kwargs)

Overloaded function.

  1. getCacheID(self: PyOpenColorIO.Config) -> str

  2. getCacheID(self: PyOpenColorIO.Config, context: OpenColorIO_v2_0dev::Context) -> str

*getColorSpace(self: PyOpenColorIO.Config, name: str) -> OpenColorIO_v2_0dev::ColorSpace**
getColorSpaceFromFilepath(*args, **kwargs)

Overloaded function.

1. getColorSpaceFromFilepath(self: PyOpenColorIO.Config, filePath: str) -> str

2. getColorSpaceFromFilepath(self: PyOpenColorIO.Config, filePath: str, ruleIndex: int) -> str

getColorSpaceNames(*args, **kwargs)

Overloaded function.

  1. getColorSpaceNames(self: PyOpenColorIO.Config, searchReferenceType: PyOpenColorIO.SearchReferenceSpaceType, visibility: PyOpenColorIO.ColorSpaceVisibility) -> OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 2, OpenColorIO_v2_0dev::SearchReferenceSpaceType, OpenColorIO_v2_0dev::ColorSpaceVisibility>

  2. getColorSpaceNames(self: PyOpenColorIO.Config) -> OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 4>

getColorSpaces(*args, **kwargs)

Overloaded function.

  1. getColorSpaces(self: PyOpenColorIO.Config, category: str) -> OpenColorIO_v2_0dev::ColorSpaceSet

  2. getColorSpaces(self: PyOpenColorIO.Config, searchReferenceType: PyOpenColorIO.SearchReferenceSpaceType, visibility: PyOpenColorIO.ColorSpaceVisibility) -> OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 3, OpenColorIO_v2_0dev::SearchReferenceSpaceType, OpenColorIO_v2_0dev::ColorSpaceVisibility>

  3. getColorSpaces(self: PyOpenColorIO.Config) -> OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 5>

getCurrentContext(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::Context
getDefaultDisplay(self: PyOpenColorIO.Config) → str
getDefaultLumaCoefs(self: PyOpenColorIO.Config) → List[float[3]]
getDefaultSceneToDisplayViewTransform(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::ViewTransform
getDefaultView(self: PyOpenColorIO.Config, display: str) → str
getDescription(self: PyOpenColorIO.Config) → str
getDisplayViewColorSpaceName(self: PyOpenColorIO.Config, display: str, view: str) → str
getDisplayViewDescription(self: PyOpenColorIO.Config, display: str, view: str) → str
getDisplayViewLooks(self: PyOpenColorIO.Config, display: str, view: str) → str
getDisplayViewRule(self: PyOpenColorIO.Config, display: str, view: str) → str
getDisplayViewTransformName(self: PyOpenColorIO.Config, display: str, view: str) → str
getDisplays(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 8>
getEnvironmentMode(self: PyOpenColorIO.Config)PyOpenColorIO.EnvironmentMode
getEnvironmentVarDefault(self: PyOpenColorIO.Config, name: str) → str
getEnvironmentVarNames(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 0>
getFamilySeparator(self: PyOpenColorIO.Config) → str
getFileRules(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::FileRules
getInactiveColorSpaces(self: PyOpenColorIO.Config) → str
getLook(self: PyOpenColorIO.Config, name: str) → OpenColorIO_v2_0dev::Look
getLookNames(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 12>
getLooks(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 13>
getMajorVersion(self: PyOpenColorIO.Config) → int
getMinorVersion(self: PyOpenColorIO.Config) → int
getProcessor(*args, **kwargs)

Overloaded function.

  1. getProcessor(self: PyOpenColorIO.Config, srcColorSpace: OpenColorIO_v2_0dev::ColorSpace, dstColorSpace: OpenColorIO_v2_0dev::ColorSpace) -> OpenColorIO_v2_0dev::Processor

  2. getProcessor(self: PyOpenColorIO.Config, context: OpenColorIO_v2_0dev::Context, srcColorSpace: OpenColorIO_v2_0dev::ColorSpace, dstColorSpace: OpenColorIO_v2_0dev::ColorSpace) -> OpenColorIO_v2_0dev::Processor

  3. getProcessor(self: PyOpenColorIO.Config, srcColorSpaceName: str, dstColorSpaceName: str) -> OpenColorIO_v2_0dev::Processor

  4. getProcessor(self: PyOpenColorIO.Config, context: OpenColorIO_v2_0dev::Context, srcColorSpaceName: str, dstColorSpaceName: str) -> OpenColorIO_v2_0dev::Processor

  5. getProcessor(self: PyOpenColorIO.Config, srcColorSpaceName: str, display: str, view: str) -> OpenColorIO_v2_0dev::Processor

  6. getProcessor(self: PyOpenColorIO.Config, context: OpenColorIO_v2_0dev::Context, srcColorSpaceName: str, display: str, view: str) -> OpenColorIO_v2_0dev::Processor

  7. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform) -> OpenColorIO_v2_0dev::Processor

  8. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> OpenColorIO_v2_0dev::Processor

  9. getProcessor(self: PyOpenColorIO.Config, context: OpenColorIO_v2_0dev::Context, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> OpenColorIO_v2_0dev::Processor

getRoleNames(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 6>
getRoles(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 7>
getSearchPath(self: PyOpenColorIO.Config) → str
getSearchPaths(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 1>
getSharedViews(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 9>
getViewTransform(self: PyOpenColorIO.Config, name: str) → OpenColorIO_v2_0dev::ViewTransform
getViewTransformNames(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 14>
getViewTransforms(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 15>
getViewingRules(self: PyOpenColorIO.Config) → OpenColorIO_v2_0dev::ViewingRules
getViews(*args, **kwargs)

Overloaded function.

  1. getViews(self: PyOpenColorIO.Config, display: str) -> OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 10, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > >

  2. getViews(self: PyOpenColorIO.Config, display: str, colorSpaceName: str) -> OpenColorIO_v2_0dev::PyIterator<std::shared_ptr<OpenColorIO_v2_0dev::Config>, 11, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > >

getWorkingDir(self: PyOpenColorIO.Config) → str
hasRole(self: PyOpenColorIO.Config, role: str) → bool
isColorSpaceUsed(self: PyOpenColorIO.Config, name: str) → bool
isStrictParsingEnabled(self: PyOpenColorIO.Config) → bool
loadEnvironment(self: PyOpenColorIO.Config) → None
parseColorSpaceFromString(self: PyOpenColorIO.Config, str: str) → str
removeColorSpace(self: PyOpenColorIO.Config, name: str) → None
removeDisplayView(self: PyOpenColorIO.Config, display: str, view: str) → None
removeSharedView(self: PyOpenColorIO.Config, view: str) → None
sanityCheck(self: PyOpenColorIO.Config) → None**
serialize(*args, **kwargs)

Overloaded function.

  1. serialize(self: PyOpenColorIO.Config, fileName: str) -> None

  2. serialize(self: PyOpenColorIO.Config) -> str

setActiveDisplays(self: PyOpenColorIO.Config, displays: str) → None
setActiveViews(self: PyOpenColorIO.Config, views: str) → None
setDefaultLumaCoefs(self: PyOpenColorIO.Config, rgb: List[float[3]]) → None
setDescription(self: PyOpenColorIO.Config, description: str) → None
setEnvironmentMode(self: PyOpenColorIO.Config, mode: PyOpenColorIO.EnvironmentMode) → None
setFamilySeparator(self: PyOpenColorIO.Config, separator: str) → None
setFileRules(self: PyOpenColorIO.Config, fileRules: OpenColorIO_v2_0dev::FileRules) → None
setInactiveColorSpaces(self: PyOpenColorIO.Config, inactiveColorSpaces: str) → None
setMajorVersion(self: PyOpenColorIO.Config, major: int) → None
setMinorVersion(self: PyOpenColorIO.Config, minor: int) → None
setRole(self: PyOpenColorIO.Config, role: str, colorSpaceName: str) → None
setSearchPath(self: PyOpenColorIO.Config, path: str) → None
setViewingRules(self: PyOpenColorIO.Config, ViewingRules: OpenColorIO_v2_0dev::ViewingRules) → None
setWorkingDir(self: PyOpenColorIO.Config, dirName: str) → None
upgradeToLatestVersion(self: PyOpenColorIO.Config) → None