2022-03-15 13:29:32 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-08-26 22:41:21 +02:00
<class name= "ColorPicker" inherits= "BoxContainer" version= "4.1" >
2022-03-15 13:29:32 +01:00
<brief_description >
Color picker control.
</brief_description>
<description >
Displays a color picker widget. Useful for selecting a color from an RGB/RGBA colorspace.
[b]Note:[/b] 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.
</description>
<tutorials >
<link title= "Tween Demo" > https://godotengine.org/asset-library/asset/146</link>
</tutorials>
<methods >
<method name= "add_preset" >
<return type= "void" />
<argument index= "0" name= "color" type= "Color" />
<description >
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.
[b]Note:[/b] The presets list is only for [i]this[/i] color picker.
</description>
</method>
<method name= "erase_preset" >
<return type= "void" />
<argument index= "0" name= "color" type= "Color" />
<description >
Removes the given color from the list of color presets of this color picker.
</description>
</method>
<method name= "get_presets" qualifiers= "const" >
<return type= "PoolColorArray" />
<description >
Returns the list of colors in the presets of the color picker.
</description>
</method>
</methods>
<members >
<member name= "color" type= "Color" setter= "set_pick_color" getter= "get_pick_color" default= "Color( 1, 1, 1, 1 )" >
The currently selected color.
</member>
<member name= "deferred_mode" type= "bool" setter= "set_deferred_mode" getter= "is_deferred_mode" default= "false" >
If [code]true[/code], 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).
</member>
<member name= "edit_alpha" type= "bool" setter= "set_edit_alpha" getter= "is_editing_alpha" default= "true" >
If [code]true[/code], shows an alpha channel slider (opacity).
</member>
<member name= "hsv_mode" type= "bool" setter= "set_hsv_mode" getter= "is_hsv_mode" default= "false" >
If [code]true[/code], allows editing the color with Hue/Saturation/Value sliders.
[b]Note:[/b] Cannot be enabled if raw mode is on.
</member>
<member name= "presets_enabled" type= "bool" setter= "set_presets_enabled" getter= "are_presets_enabled" default= "true" >
If [code]true[/code], the "add preset" button is enabled.
</member>
<member name= "presets_visible" type= "bool" setter= "set_presets_visible" getter= "are_presets_visible" default= "true" >
If [code]true[/code], saved color presets are visible.
</member>
<member name= "raw_mode" type= "bool" setter= "set_raw_mode" getter= "is_raw_mode" default= "false" >
If [code]true[/code], 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).
[b]Note:[/b] Cannot be enabled if HSV mode is on.
</member>
</members>
<signals >
<signal name= "color_changed" >
<argument index= "0" name= "color" type= "Color" />
<description >
Emitted when the color is changed.
</description>
</signal>
<signal name= "preset_added" >
<argument index= "0" name= "color" type= "Color" />
<description >
Emitted when a preset is added.
</description>
</signal>
<signal name= "preset_removed" >
<argument index= "0" name= "color" type= "Color" />
<description >
Emitted when a preset is removed.
</description>
</signal>
</signals>
<constants >
</constants>
<theme_items >
<theme_item name= "h_width" data_type= "constant" type= "int" default= "30" >
The width of the hue selection slider.
</theme_item>
<theme_item name= "label_width" data_type= "constant" type= "int" default= "10" >
</theme_item>
<theme_item name= "margin" data_type= "constant" type= "int" default= "4" >
The margin around the [ColorPicker].
</theme_item>
<theme_item name= "sv_height" data_type= "constant" type= "int" default= "256" >
The height of the saturation-value selection box.
</theme_item>
<theme_item name= "sv_width" data_type= "constant" type= "int" default= "256" >
The width of the saturation-value selection box.
</theme_item>
<theme_item name= "add_preset" data_type= "icon" type= "Texture" >
The icon for the "Add Preset" button.
</theme_item>
<theme_item name= "color_hue" data_type= "icon" type= "Texture" >
Custom texture for the hue selection slider on the right.
</theme_item>
<theme_item name= "color_sample" data_type= "icon" type= "Texture" >
</theme_item>
<theme_item name= "overbright_indicator" data_type= "icon" type= "Texture" >
The indicator used to signalize that the color value is outside the 0-1 range.
</theme_item>
<theme_item name= "preset_bg" data_type= "icon" type= "Texture" >
</theme_item>
<theme_item name= "screen_picker" data_type= "icon" type= "Texture" >
The icon for the screen color picker button.
</theme_item>
</theme_items>
</class>
