:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ColorPicker.xml. .. _class_ColorPicker: ColorPicker =========== **Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Color picker control. .. rst-class:: classref-introduction-group 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 :ref:`ColorPickerButton` instead if you need a button that brings up a **ColorPicker** in a pop-up. .. rst-class:: classref-introduction-group Tutorials --------- - `Tween Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+--------------------------------------------------------------------+-------------------------+ | :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | +---------------------------+--------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`deferred_mode` | ``false`` | +---------------------------+--------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`edit_alpha` | ``true`` | +---------------------------+--------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`hsv_mode` | ``false`` | +---------------------------+--------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`presets_enabled` | ``true`` | +---------------------------+--------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`presets_visible` | ``true`` | +---------------------------+--------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`raw_mode` | ``false`` | +---------------------------+--------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------+--------------------------------------------------------------------------------------------------------+ | void | :ref:`add_preset` **(** :ref:`Color` color **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_preset` **(** :ref:`Color` color **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :ref:`PoolColorArray` | :ref:`get_presets` **(** **)** |const| | +---------------------------------------------+--------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`int` | :ref:`h_width` | ``30`` | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`int` | :ref:`label_width` | ``10`` | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`int` | :ref:`margin` | ``4`` | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`int` | :ref:`sv_height` | ``256`` | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`int` | :ref:`sv_width` | ``256`` | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`Texture` | :ref:`add_preset` | | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`Texture` | :ref:`color_hue` | | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`Texture` | :ref:`color_sample` | | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`Texture` | :ref:`overbright_indicator` | | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`Texture` | :ref:`preset_bg` | | +-------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`Texture` | :ref:`screen_picker` | | +-------------------------------+--------------------------------------------------------------------------------+---------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_ColorPicker_signal_color_changed: .. rst-class:: classref-signal **color_changed** **(** :ref:`Color` color **)** Emitted when the color is changed. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_signal_preset_added: .. rst-class:: classref-signal **preset_added** **(** :ref:`Color` color **)** Emitted when a preset is added. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_signal_preset_removed: .. rst-class:: classref-signal **preset_removed** **(** :ref:`Color` color **)** Emitted when a preset is removed. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ColorPicker_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color( 1, 1, 1, 1 )`` .. rst-class:: classref-property-setget - void **set_pick_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_pick_color** **(** **)** The currently selected color. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_property_deferred_mode: .. rst-class:: classref-property :ref:`bool` **deferred_mode** = ``false`` .. rst-class:: classref-property-setget - void **set_deferred_mode** **(** :ref:`bool` value **)** - :ref:`bool` **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). .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_property_edit_alpha: .. rst-class:: classref-property :ref:`bool` **edit_alpha** = ``true`` .. rst-class:: classref-property-setget - void **set_edit_alpha** **(** :ref:`bool` value **)** - :ref:`bool` **is_editing_alpha** **(** **)** If ``true``, shows an alpha channel slider (opacity). .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_property_hsv_mode: .. rst-class:: classref-property :ref:`bool` **hsv_mode** = ``false`` .. rst-class:: classref-property-setget - void **set_hsv_mode** **(** :ref:`bool` value **)** - :ref:`bool` **is_hsv_mode** **(** **)** If ``true``, allows editing the color with Hue/Saturation/Value sliders. \ **Note:** Cannot be enabled if raw mode is on. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_property_presets_enabled: .. rst-class:: classref-property :ref:`bool` **presets_enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_presets_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **are_presets_enabled** **(** **)** If ``true``, the "add preset" button is enabled. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_property_presets_visible: .. rst-class:: classref-property :ref:`bool` **presets_visible** = ``true`` .. rst-class:: classref-property-setget - void **set_presets_visible** **(** :ref:`bool` value **)** - :ref:`bool` **are_presets_visible** **(** **)** If ``true``, saved color presets are visible. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_property_raw_mode: .. rst-class:: classref-property :ref:`bool` **raw_mode** = ``false`` .. rst-class:: classref-property-setget - void **set_raw_mode** **(** :ref:`bool` value **)** - :ref:`bool` **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. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ColorPicker_method_add_preset: .. rst-class:: classref-method void **add_preset** **(** :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_method_erase_preset: .. rst-class:: classref-method void **erase_preset** **(** :ref:`Color` color **)** Removes the given color from the list of color presets of this color picker. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_method_get_presets: .. rst-class:: classref-method :ref:`PoolColorArray` **get_presets** **(** **)** |const| Returns the list of colors in the presets of the color picker. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_ColorPicker_theme_constant_h_width: .. rst-class:: classref-themeproperty :ref:`int` **h_width** = ``30`` The width of the hue selection slider. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_constant_label_width: .. rst-class:: classref-themeproperty :ref:`int` **label_width** = ``10`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_constant_margin: .. rst-class:: classref-themeproperty :ref:`int` **margin** = ``4`` The margin around the **ColorPicker**. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_constant_sv_height: .. rst-class:: classref-themeproperty :ref:`int` **sv_height** = ``256`` The height of the saturation-value selection box. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_constant_sv_width: .. rst-class:: classref-themeproperty :ref:`int` **sv_width** = ``256`` The width of the saturation-value selection box. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_add_preset: .. rst-class:: classref-themeproperty :ref:`Texture` **add_preset** The icon for the "Add Preset" button. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_color_hue: .. rst-class:: classref-themeproperty :ref:`Texture` **color_hue** Custom texture for the hue selection slider on the right. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_color_sample: .. rst-class:: classref-themeproperty :ref:`Texture` **color_sample** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_overbright_indicator: .. rst-class:: classref-themeproperty :ref:`Texture` **overbright_indicator** The indicator used to signalize that the color value is outside the 0-1 range. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_preset_bg: .. rst-class:: classref-themeproperty :ref:`Texture` **preset_bg** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_screen_picker: .. rst-class:: classref-themeproperty :ref:`Texture` **screen_picker** The icon for the screen color picker button. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`