ColorPicker

ColorPicker

Inherits: BoxContainer < Container < Control < CanvasItem < Node < Object

Color picker control.

Description

Displays a color picker widget. Useful for selecting a color from an RGB/RGBA colorspace.

Note: This control is the color picker widget itself. You can use a ColorPickerButton instead if you need a button that brings up a ColorPicker in a pop-up.

Tutorials

Tween Demo

Properties

Color	color	`Color( 1, 1, 1, 1 )`
bool	deferred_mode	`false`
bool	edit_alpha	`true`
bool	hsv_mode	`false`
bool	presets_enabled	`true`
bool	presets_visible	`true`
bool	raw_mode	`false`

Methods

void	add_preset ( Color color )
void	erase_preset ( Color color )
PoolColorArray	get_presets ( ) const

Theme Properties

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

Signals

color_changed ( Color color )

Emitted when the color is changed.

preset_added ( Color color )

Emitted when a preset is added.

preset_removed ( Color color )

Emitted when a preset is removed.

Property Descriptions

Color color

Default	`Color( 1, 1, 1, 1 )`
Setter	set_pick_color(value)
Getter	get_pick_color()

The currently selected color.

bool deferred_mode

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).

bool hsv_mode

Default	`false`
Setter	set_hsv_mode(value)
Getter	is_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.

bool presets_visible

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

If true, saved color presets are visible.

bool raw_mode

Default	`false`
Setter	set_raw_mode(value)
Getter	is_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 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.

void erase_preset ( Color color )

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

PoolColorArray get_presets ( ) const

Returns the list of colors in the presets of the color picker.

Theme Property Descriptions

Texture add_preset

The icon for the “Add Preset” button.

Texture color_hue

Custom texture for the hue selection slider on the right.

Texture color_sample

int h_width

Default

30

The width of the hue selection slider.

int label_width

Default

10

int margin

Default

4

The margin around the ColorPicker.

Texture overbright_indicator

The indicator used to signalize that the color value is outside the 0-1 range.

Texture preset_bg

Texture screen_picker

The icon for the screen color picker button.

int sv_height

Default

256

The height of the saturation-value selection box.

int sv_width

Default

256

The width of the saturation-value selection box.