Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

EditorGUI.ColorField

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function ColorField(position: Rect, value: Color): Color;
public static Color ColorField(Rect position, Color value);
public static function ColorField(position: Rect, label: string, value: Color): Color;
public static Color ColorField(Rect position, string label, Color value);
public static function ColorField(position: Rect, label: GUIContent, value: Color): Color;
public static Color ColorField(Rect position, GUIContent label, Color value);
public static function ColorField(position: Rect, label: GUIContent, value: Color, showEyedropper: bool, showAlpha: bool, hdr: bool, hdrConfig: ColorPickerHDRConfig): Color;
public static Color ColorField(Rect position, GUIContent label, Color value, bool showEyedropper, bool showAlpha, bool hdr, ColorPickerHDRConfig hdrConfig);

Parameters

position Rectangle on the screen to use for the field.
label Optional label to display in front of the field.
value The color to edit.
showEyedropper If true, the color picker should show the eyedropper control. If false, don't show it.
showAlpha If true, allow the user to set an alpha value for the color. If false, hide the alpha component.
hdr If true, treat the color as an HDR value. If false, treat it as a standard LDR value.
hdrConfig An object that sets the presentation parameters for an HDR color. If not using an HDR color, set this to null.

Returns

Color The color selected by the user.

Description

Make a field for selecting a Color.


Color field in an Editor Window.

// Change The color of the selected Game Objects
class EditorGUIColorField extends EditorWindow {
 
	var matColor : Color = Color.white;
	
	@MenuItem("Examples/Mass Color Change")
	static function Init() {
		var window = GetWindow(EditorGUIColorField);
		window.position = Rect(0,0,170,60);
		window.Show();
	}
	function OnGUI() {
		matColor = EditorGUI.ColorField(Rect(3,3,position.width - 6, 15),
				"New Color:", 
				matColor); 
		if(GUI.Button(Rect(3,25,position.width-6, 30),"Change!"))
			ChangeColors();
	}
  
	function ChangeColors() {
		if(Selection.activeGameObject)
			for(var t: GameObject in Selection.gameObjects) {
			
				var rend = t.GetComponent.<Renderer>();
				
				if(rend != null)
					rend.sharedMaterial.color = matColor;
			}
	}
}