ColorPicker

Color picker control.

node displaying a color picker widget. It’s useful for selecting a color from an RGB/RGBA colorspace.

Tutorials

https://godotengine.org/asset-library/asset/146

Methods

void	( Color color )
void	( Color color )
	get_presets ( ) const

	add_preset
Texture	color_hue
	color_sample
int	h_width	30
	label_width	10
int	margin	4
	overbright_indicator
Texture	preset_bg
	screen_picker
int	sv_height	256
	sv_width	256

Signals

color_changed ( Color color )

Emitted when the color is changed.

preset_added ( color )

Emitted when a preset is added.

preset_removed ( Color color )

Emitted when a preset is removed.

color

Default	`false`
Setter	set_deferred_mode(value)
Getter	is_deferred_mode()

If true, the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).

bool edit_alpha

Default	`true`
Setter	set_edit_alpha(value)
Getter	is_editing_alpha()

If true, shows an alpha channel slider (transparency).

hsv_mode

If true, allows editing the color with Hue/Saturation/Value sliders.

Note: Cannot be enabled if raw mode is on.

bool presets_enabled

Default	`true`
Setter	set_presets_enabled(value)
Getter	are_presets_enabled()

If true, the “add preset” button is enabled.

presets_visible

Default	`true`
Setter	set_presets_visible(value)
Getter	are_presets_visible()

bool raw_mode

If true, allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).

Note: Cannot be enabled if HSV mode is on.

Method Descriptions

void add_preset ( color )

Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them.

Note: the presets list is only for this color picker.

Removes the given color from the list of color presets of this color picker.

PoolColorArray get_presets ( ) const