|
Synergy Color Management Component - SDK -
2018.0.80
|
Configuration. More...
Public Types | |
| enum | ColorSpaceTypes { InputColorSpaces, ViewTransforms, AllColorSpaces } |
| List of all types of color space. More... | |
| typedef SharedPtr< Config > | Ptr |
| shared pointer More... | |
Public Member Functions | |
| virtual | ~Config () |
| Destructor. More... | |
| virtual SynStatus | getColorSpace (const char *name, ColorSpace::Ptr &pColorSpace) const =0 |
| virtual unsigned | getNumColorSpaces (ColorSpaceTypes type) const =0 |
| virtual const char * | getColorSpaceName (ColorSpaceTypes type, unsigned index) const =0 |
| virtual SynStatus | getTemplate (TemplateType type, TemplatePtr &pTemplate) const =0 |
Static Public Member Functions | |
| static SynStatus | get (const char *configFile, const char *ocioConfigFile, Ptr &pConfig) |
| Get an initialized configuration using a configuration file. More... | |
| static SynStatus | get (const char *transformPath, const char *sharedPath, const char *ocioConfigFile, Ptr &pConfig) |
| Get an initialized configuration using existing native catalog and shared transform directories. More... | |
| static SynStatus | create (const char *configFile, const char *transformPath, const char *sharedPath, const char *ocioConfigFile, Ptr &pConfig) |
| Create an initialized configuration using the catalog and shared transform paths. More... | |
Configuration.
| typedef SharedPtr<Config> SYNCOLOR::Config::Ptr |
shared pointer
List of all types of color space.
| Enumerator | |
|---|---|
| InputColorSpaces |
Only the input color spaces. |
| ViewTransforms |
Only the view transforms. |
| AllColorSpaces |
All the color spaces. |
|
virtual |
Destructor.
|
static |
Get an initialized configuration using a configuration file.
| configFile | is the configuration file |
| ocioConfigFile | is an OCIO configuration file; it could be null |
| pConfig | [out] is the config class instance |
|
static |
Get an initialized configuration using existing native catalog and shared transform directories.
The method is initializing a configuration using a minimum set of information. It's dedicated to external tools consuming existing a color managed 'scene' (i.e. without the need to change anything, Arnold makeTx, Arnold kick). As a concrete example, the default Maya windows paths are:
| transformPath | is the directory of the native catalog |
| sharedPath | is the directory of the custom color space catalog |
| ocioConfigFile | is an OCIO configuration file; it could be null |
| pConfig | [out] is the config class instance |
|
static |
Create an initialized configuration using the catalog and shared transform paths.
The method creates a new configuration file using the native catalog and shared catalog directories. It overwrites any existing configuration file.
| configFile | is the configuration file to be created |
| transformPath | is the directory of the native catalog |
| sharedPath | is the directory of the custom color space catalog |
| ocioConfigFile | is an OCIO configuration file; it could be null if not used |
| pConfig | [out] is the config class instance |
|
pure virtual |
Get a color space using its name
| name | is the color space unique name |
| pColorSpace | [out] is the color space class instance |
|
pure virtual |
Get the number of color spaces
| type | is the type of the requested color spaces |
|
pure virtual |
Get a color space using its index
| type | is the type of the requested color spaces |
| index | is the color space index |
|
pure virtual |
Get the template based on its type
| type | is the template type |
| pTemplate | [out] is the template class instance |