Go to: Synopsis. Return value. Keywords. Flags. MEL examples.

Synopsis

colorManagementPrefs [-cmConfigFileEnabled boolean] [-cmEnabled boolean] [-colorManagePots boolean] [-colorManagedNodes] [-colorManagementSDKVersion string] [-configFilePath string] [-defaultInputSpaceName string] [-equalsToPolicyFile string] [-exportPolicy string] [-inputSpaceNames] [-loadPolicy string] [-loadedDefaultInputSpaceName string] [-loadedOutputTransformName string] [-loadedRenderingSpaceName string] [-loadedViewTransformName string] [-missingColorSpaceNodes] [-ocioRulesEnabled boolean] [-outputTarget string] [-outputTransformEnabled boolean] [-outputTransformName string] [-outputTransformNames] [-outputUseViewTransform] [-policyFileName string] [-popupOnError boolean] [-refresh] [-renderingSpaceName string] [-renderingSpaceNames] [-restoreDefaults] [-viewTransformName string] [-viewTransformNames]

colorManagementPrefs is undoable, queryable, and editable.

This command allows querying and editing the color management global data in a scene. It also allows for setting the view transform and rendering space which automatically configures the color processing in the enabled views.

Return value

None

In query mode, return type is based on queried flag.

Keywords

color, management

Flags

cmConfigFileEnabled, cmEnabled, colorManagePots, colorManagedNodes, colorManagementSDKVersion, configFilePath, defaultInputSpaceName, equalsToPolicyFile, exportPolicy, inputSpaceNames, loadPolicy, loadedDefaultInputSpaceName, loadedOutputTransformName, loadedRenderingSpaceName, loadedViewTransformName, missingColorSpaceNodes, ocioRulesEnabled, outputTarget, outputTransformEnabled, outputTransformName, outputTransformNames, outputUseViewTransform, policyFileName, popupOnError, refresh, renderingSpaceName, renderingSpaceNames, restoreDefaults, viewTransformName, viewTransformNames
Long name (short name) Argument types Properties
-cmConfigFileEnabled(-cfe) boolean queryedit
Turn on or off applying an OCIO configuration file. If set, the color management configuration set in the preferences is used.
-cmEnabled(-cme) boolean queryedit
Turn on or off color management in general. If set, the color management configuration set in the preferences is used.
-colorManagePots(-cmp) boolean queryedit
Turn on or off color management of color pots in the UI. If set, colors in color pots are taken to be in rendering space, and are displayed after being transformed by the view transform set in the preferences.
-colorManagedNodes(-cmn) queryedit
Gets the names of all nodes that apply color management to bring pixels from an input color space to the rendering space. Examples include file texture node.
-colorManagementSDKVersion(-cmv) string queryedit
Obtain the version of the color management SDK used by Maya.
-configFilePath(-cfp) string queryedit
The configuration file to be used, if color management is enabled.
-defaultInputSpaceName(-din) string queryedit
This flag is obsolete. See the colorManagementFileRules command for more information.
-equalsToPolicyFile(-etp) string queryedit
Query if the current loaded policy settings is the same with the settings described in the policy file which is the argument of the command.

In query mode, this flag needs a value.

-exportPolicy(-epy) string createqueryedit
Export the color management parameters to policy file
-inputSpaceNames(-iss) queryedit
Returns the list of available input color spaces. Used to populate the input color spaces UI popup.
-loadPolicy(-lpy) string createqueryedit
Load the color management policy file. This file overides the color management settings.
-loadedDefaultInputSpaceName(-ldn) string queryedit
This flag is obsolete.
-loadedOutputTransformName(-lon) string queryedit
Gets the loaded output transform. Used by file open, import, and reference to check for missing color spaces or transforms.
-loadedRenderingSpaceName(-lrn) string queryedit
Gets the loaded rendering space. Used by file open, import, and reference to check for missing color spaces or transforms.
-loadedViewTransformName(-lvn) string queryedit
Gets the loaded view transform. Used by file open, import, and reference to check for missing color spaces or transforms.
-missingColorSpaceNodes(-mcn) queryedit
Gets the names of the nodes that have color spaces not defined in the selected transform collection.
-ocioRulesEnabled(-ore) boolean queryedit
Turn on or off the use of colorspace assignment rules from the OCIO library.
-outputTarget(-ott) string queryedit
Indicates to which output the outputTransformEnabled or the outputTransformName flags are to be applied. Valid values are "renderer" or "playblast".

In query mode, this flag needs a value.

-outputTransformEnabled(-ote) boolean queryedit
Turn on or off applying the output transform for out of viewport renders. If set, the output transform set in the preferences is used.
-outputTransformName(-otn) string queryedit
The output transform to be applied for out of viewport renders. Disables output use view transform mode.
-outputTransformNames(-ots) queryedit
Returns the list of available output transforms.
-outputUseViewTransform(-ovt) queryedit
Turns use view transform mode on. In this mode, the output transform is set to match the view transform. To turn the mode off, set an output transform using the outputTransformName flag.
-policyFileName(-pfn) string queryedit
Set the policy file name
-popupOnError(-poe) boolean queryedit
Turn on or off displaying a modal popup on error (as well as the normal script editor reporting of the error), for this invocation of the command. Default is off.
-refresh(-rfr) createqueryedit
Refresh the color management.
-renderingSpaceName(-rsn) string queryedit
The color space to be used during rendering. This is the source color space to the viewing transform, for color managed viewers and color managed UI controls, and the destination color space for color managed input pixels.
-renderingSpaceNames(-rss) queryedit
Returns the list of available rendering spaces. Used to populate the color management preference UI popup.
-restoreDefaults(-rde) createqueryedit
Restore the color management settings to their default value.
-viewTransformName(-vtn) string queryedit
The view transform to be applied by color managed viewers and color managed UI controls.
-viewTransformNames(-vts) queryedit
Returns the list of available view transforms. Used to populate the color management preference UI popup.

Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples


string $wsName = `colorManagementPrefs -q -renderingSpaceName`;
colorManagementPrefs -e -viewTransformName "Log";

string $renderingSpaces[] = `colorManagementPrefs -q -renderingSpaceNames`;
string $viewingTransforms[] = `colorManagementPrefs -q -viewTransformNames`;

colorManagementPrefs -e -configFilePath "/project/local_config.ocio";