UXML element ColorField

A ColorField is an Editor-only control that allows you to 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. HDRhigh dynamic range
See in Glossary colors are high dynamic range colors that can represent a wider range of colors than standard colors.

Create a ColorField

You can create a ColorField with UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary 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;

Example

The following UXML example creates a ColorField:

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <uie:ColorField label="UXML Field" name="the-uxml-field" />
</UXML>

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

// Get a reference to the field from UXML and assign a value to it.
var uxmlField = container.Q<ColorField>("the-uxml-field");
uxmlField.value = Color.red;

// Create a new field, disable it, and give it a style class.
var csharpField = new ColorField("C# Field");
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-field");
csharpField.value = uxmlField.value;
container.Add(csharpField);

// Mirror the value of the UXML field into the C# field.
uxmlField.RegisterCallback<ChangeEvent<Color>>((evt) =>
{
    csharpField.value = evt.newValue;
});

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:

Inherited UXML attributes

This element inherits the following attributes from its base class:

This element also inherits the following attributes from VisualElement:

USS classes

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

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.

Additional resources

• HDRColorPicker
• High dynamic range