UXML element ColorField

A ColorField is an Editor-only control that lets users select a color from a color picker. It supports alpha channel and HDR colors. An alpha channel is an extra channel to represent the transparency level of a color. HDR colors are high-dynamic range colors that can represent a wider range of colors than standard colors.

Note: To align an element with other fields in an Inspector window, simply apply the .unity-base-field__aligned USS class to it. For more information, refer to BaseField.

Create a ColorField

You can create a ColorField with UI Builder, UXML, or C#. The following C# example creates a ColorField with a default color and enables the alpha channel, eye dropper, and treats the color as an HDR value.

using UnityEditor.UIElements;
...
var colorField = new ColorField();
colorField.value = new Color(0.5f, 0.5f, 0.5f, 1.0f);
colorField.showAlpha = true;
colorField.showEyeDropper = true;
colorField.hdr = true;

示例

The following UXML example creates a ColorField:

[!code-xml[(External/Resources/editor_resources/Assets/Editor Default Resources/UIPackageResources/Snippets/UXML/ColorFieldSnippet.uxml)]

The following C# example illustrates some of the customizable functionalities of the ColorField:

[!code-cs[(Modules/UIElementsSamplesEditor/Snippets/ColorFieldSnippet.cs#sample)]

To try this example live in Unity, go to Window > UI Toolkit > Samples.

C# base class and namespace

C# class: ColorField
Namespace: UnityEditor.UIElements
Base class: BaseField_1

Member UXML attributes

This element has the following member attributes:

名称	类型	描述
hdr	boolean	If true, treats the color as an HDR value. If false, treats the color as a standard LDR value.
show-alpha	boolean	If true, allows the user to set an alpha value for the color. If false, hides the alpha component.
show-eye-dropper	boolean	If true, the color picker will show the eyedropper control. If false, the color picker won’t show the eyedropper control.

Inherited UXML attributes

This element inherits the following attributes from its base class:

名称	类型	描述
binding-path	string	Path of the target property to be bound.
focusable	boolean	True if the element can be focused.
label	string	The string representing the label that will appear beside the field.
tabindex	int	An integer used to sort focusables in the focus ring. Must be greater than or equal to zero.
value	Color	The value associated with the field.

This element also inherits the following attributes from VisualElement:

名称	类型	描述
content-container	string	Child elements are added to it, usually this is the same as the element itself.
data-source	Object	Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children.
data-source-path	string	Path from the data source to the value.
name	string	The name of this VisualElement. Use this property to write USS selectors that target a specific element. The standard practice is to give an element a unique name.
picking-mode	UIElements.PickingMode	Determines if this element can be pick during mouseEvents or IPanel.Pick queries.
style	string	Reference to the style object of this element. Contains data computed from USS files or inline styles written to this object in C#.
tooltip	string	Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI.
usage-hints	UIElements.UsageHints	A combination of hint values that specify high-level intended usage patterns for the VisualElement. This property can only be set when the VisualElement is not yet part of a Panel. Once part of a Panel, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It’s advised to always consider specifying the proper UsageHints, but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform).
view-data-key	string	Used for view data persistence, such as tree expanded states, scroll position, or zoom level. This key is used to save and load the view data from the view data store. If you don’t set this key, the persistence is disabled for the associated VisualElement. For more information, refer to View data persistence.

USS classes

The following table lists all the C# public property names and their related USS selector.

C# property	USS selector	描述
ussClassName	.unity-color-field	USS class name of elements of this type.
labelUssClassName	.unity-color-field__label	USS class name of labels in elements of this type.
inputUssClassName	.unity-color-field__input	USS class name of input elements in elements of this type.
colorContainerUssClassName	.unity-color-field__color-container	USS class name of color container elements in elements of this type.
colorUssClassName	.unity-color-field__color	USS class name of color elements in elements of this type.
mixedValueColorUssClassName	.unity-color-field__color--mixed-value	USS class name of color elements in elements of this type when showing mixed values.
eyeDropperUssClassName	.unity-color-field__eyedropper	USS class name of eyedropper elements in elements of this type.
hdrLabelUssClassName	.unity-color-field__hdr	USS class name of hdr label elements in elements of this type.
gradientContainerUssClassName	.unity-color-field__gradient-container	USS class name of gradient container elements in elements of this type.
ussClassName	.unity-base-field	USS class name of elements of this type.
labelUssClassName	.unity-base-field__label	USS class name of labels in elements of this type.
inputUssClassName	.unity-base-field__input	USS class name of input elements in elements of this type.
noLabelVariantUssClassName	.unity-base-field--no-label	USS class name of elements of this type, when there is no label.
labelDraggerVariantUssClassName	.unity-base-field__label--with-dragger	USS class name of labels in elements of this type, when there is a dragger attached on them.
mixedValueLabelUssClassName	.unity-base-field__label--mixed-value	USS class name of elements that show mixed values
alignedFieldUssClassName	.unity-base-field__aligned	USS class name of elements that are aligned in a inspector element
disabledUssClassName	.unity-disabled	USS class name of local disabled elements.

You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.

其他资源

• HDRColorPicker
• High dynamic range