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.
In query mode, return type is based on queried flag.
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)
|
|
|
|
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)
|
|
|
|
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)
|
|
|
|
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)
|
|
|
|
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)
|
|
|
|
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
|
|
|
-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)
|
|
|
|
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)
|
|
|
|
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)
|
|
|
|
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
|
|
|
-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)
|
|
|
|
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)
|
|
|
|
Returns the list of available rendering spaces. Used to populate the color
management preference UI popup.
|
|
-restoreDefaults(-rde)
|
|
|
|
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)
|
|
|
|
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)
|
|
|
|
Returns the list of available view transforms. Used to populate the color
management preference UI popup.
|
|