colorManagementPrefs

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

Synopsis

colorManagementPrefs([cmConfigFileEnabled=boolean], [cmEnabled=boolean], [colorManageAllNodes=boolean], [colorManagePots=boolean], [colorManagedNodes=boolean], [colorManagementSDKVersion=string], [configFilePath=string], [configFileVersion=string], [defaultInputSpaceName=string], [displayName=string], [displayNames=boolean], [equalsToPolicyFile=string], [exportPolicy=string], [inhibitEvents=boolean], [inputSpaceDescription=string], [inputSpaceFamilies=string], [inputSpaceNames=boolean], [loadPolicy=string], [loadedDefaultInputSpaceName=string], [loadedDisplayName=string], [loadedOutputTransformName=string], [loadedRenderingSpaceName=string], [loadedViewName=string], [loadedViewTransformName=string], [missingColorSpaceNodes=boolean], [ocioRulesEnabled=boolean], [ociov2Enabled=boolean], [outputTarget=string], [outputTransformEnabled=boolean], [outputTransformName=string], [outputTransformNames=boolean], [outputTransformUseColorConversion=boolean], [outputUseViewTransform=boolean], [policyFileName=string], [popupOnError=boolean], [refresh=boolean], [renderingSpaceName=string], [renderingSpaceNames=boolean], [restoreDefaults=boolean], [viewDisplayNames=string], [viewName=string], [viewNames=boolean], [viewTransformName=string], [viewTransformNames=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

colorManagementPrefs is undoable, queryable, and editable.

Return value

None

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

Keywords

Flags

Long name (short name)	Argument types	Properties
cmConfigFileEnabled(cfe)	boolean
Turn on or off applying an OCIO configuration file. If set, the color management configuration set in the preferences is used.
cmEnabled(cme)	boolean
Turn on or off color management in general. If set, the color management configuration set in the preferences is used.
colorManageAllNodes(cma)	boolean
Adds color management to all input nodes such as file texture nodes
colorManagePots(cmp)	boolean
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)	boolean
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
Obtain the version of the color management SDK used by Maya.
configFilePath(cfp)	string
The configuration file to be used, if color management is enabled.
configFileVersion(cfv)	string
Obtain the version of the config version.
defaultInputSpaceName(din)	string
This flag is obsolete. See the colorManagementFileRules command for more information.
displayName(dn)	string
The display from the (display, view) pair, to be applied by color managed viewers and color managed UI controls.
displayNames(dns)	boolean
Returns the list of available displays. Used to populate the color management preference UI popup.
equalsToPolicyFile(etp)	string
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
Export the color management parameters to policy file
inhibitEvents(ie)	boolean
Inhibit client-server notifications and event triggers which occur when changing the color management settings.
inputSpaceDescription(isd)	string
Returns the description for a specific input color space. In query mode, this flag needs a value.
inputSpaceFamilies(isf)	string
Returns the list of families for a specific input color space. Used to add submenus when populating the input color spaces UI popup. In query mode, this flag needs a value.
inputSpaceNames(iss)	boolean
Returns the list of available input color spaces. Used to populate the input color spaces UI popup.
loadPolicy(lpy)	string
Load the color management policy file. This file overides the color management settings.
loadedDefaultInputSpaceName(ldn)	string
This flag is obsolete.
loadedDisplayName(ld)	string
Gets the loaded display from the (display, view) pair. Used by file open, import, and reference to check for missing color spaces or transforms.
loadedOutputTransformName(lon)	string
Gets the loaded output transform. Used by file open, import, and reference to check for missing color spaces or transforms.
loadedRenderingSpaceName(lrn)	string
Gets the loaded rendering space. Used by file open, import, and reference to check for missing color spaces or transforms.
loadedViewName(lv)	string
Gets the loaded view from the (display, view) pair. Used by file open, import, and reference to check for missing color spaces or transforms.
loadedViewTransformName(lvn)	string
Gets the loaded view transform. Used by file open, import, and reference to check for missing color spaces or transforms.
missingColorSpaceNodes(mcn)	boolean
Gets the names of the nodes that have color spaces not defined in the selected transform collection or in the selected config file. Note that an inactive color space is not a missing color space.
ocioRulesEnabled(ore)	boolean
Turn on or off the use of colorspace assignment rules from the OCIO library.
ociov2Enabled(oci)	boolean
Is OCIOv2 the colour management system by default.
outputTarget(ott)	string
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
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
The output transform to be applied for out of viewport renders. Disables output use view transform mode.
outputTransformNames(ots)	boolean
Returns the list of available output transforms.
outputTransformUseColorConversion(otc)	boolean
Turn on or off selecting the color space conversion for the output color space of viewport renders. If set, a conversion color space is used; otherwise, a view transform is used.
outputUseViewTransform(ovt)	boolean
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
Set the policy file name
popupOnError(poe)	boolean
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)	boolean
Refresh the color management.
renderingSpaceName(rsn)	string
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)	boolean
Returns the list of available rendering spaces. Used to populate the color management preference UI popup.
restoreDefaults(rde)	boolean
Restore the color management settings to their default value.
viewDisplayNames(vds) 2023	string
Returns the list of available views for a specific display. Used to populate the view name list UI for file and image plane nodes. In query mode, this flag needs a value.
viewName(vn)	string
The view from the (display, view) pair, to be applied by color managed viewers and color managed UI controls.
viewNames(vns)	boolean
Returns the list of available views from the selected display. Used to populate the color management preference UI popup.
viewTransformName(vtn)	string
The view transform to be applied by color managed viewers and color managed UI controls.
viewTransformNames(vts)	boolean
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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds


ws = cmds.colorManagementPrefs(q=True, renderingSpaceName=True)
cmds.colorManagementPrefs(e=True, viewTransformName="Log")

renderingSpaces = cmd.colorManagementPrefs(q=True, renderingSpaceNames=True)
viewingTransforms = cmd.colorManagementPrefs(q=True, viewTransformNames=True)

cmds.colorManagementPrefs(e=True, configFilePath="/project/local_config.ocio")