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

Synopsis

displayRGBColor( string , [alpha=boolean], [create=boolean], [hueSaturationValue=boolean], [list=boolean], [resetToFactory=boolean], [resetToSaved=boolean])

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

displayRGBColor is undoable, queryable, and NOT editable.

This command changes or queries the display color for anything in the application that allows the user to set its color. These colors are part of the UI and not part of the saved data for a model. This command is not undoable.

Return value

stringwhen the list flag is used, none otherwise

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

Related

currentUnit, displayAffected, displayColor, displayCull, displayLevelOfDetail, displayPref, displaySmoothness, displayStats, displaySurface, hide, refresh, showHidden, toggle

Flags

alpha, create, hueSaturationValue, list, resetToFactory, resetToSaved
Long name (short name) Argument types Properties
alpha(a)
2023
 boolean query
Indicates that we want to query the alpha value of the color. Upon query, returns RGBA or HSVA as an array of 4 floats.
create(c) boolean create
Creates a new RGB display color which can be queried or set. If is used only when saving color preferences. name Specifies the name of color to change.
hueSaturationValue(hsv) boolean createquery
Indicates that rgb values are really hsv values. Upon query, returns the HSV values as an array of 3 floats. h s v The HSV values for the color. (Between 0-1)
list(l) boolean create
Writes out a list of all RGB color names and their value.
resetToFactory(rf) boolean create
Resets all the RGB display colors to their factory defaults.
resetToSaved(rs) boolean create
Resets all the RGB display colors to their saved values.
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

# Set the background colour to red
cmds.displayRGBColor( 'background', 1, 0, 0 )

# List the current RGB color settings
cmds.displayRGBColor( list=True )

# Query a RGB color by name
cmds.displayRGBColor("object", query=True)

# Query the HSVA values of a color
cmds.displayRGBColor("object", query=True, hsv=True, alpha=True)