godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
f875de93e5e931fe84a75a3958005e9ffd35646b
godot-docs/classes/class_colorpicker.rst
Godot Organization 3a953d77f9 classref: Sync with current master branch (09ed9d4)
2025-06-14 03:32:40 +00:00

935 lines
40 KiB
ReStructuredText
Raw Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ColorPicker.xml.
.. _class_ColorPicker:
ColorPicker
===========
**Inherits:** :ref:`VBoxContainer<class_VBoxContainer>` **<** :ref:`BoxContainer<class_BoxContainer>` **<** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
A widget that provides an interface for selecting or modifying a color.
.. rst-class:: classref-introduction-group
Description
-----------
A widget that provides an interface for selecting or modifying a color. It can optionally provide functionalities like a color sampler (eyedropper), color modes, and presets.
\ **Note:** This control is the color picker widget itself. You can use a :ref:`ColorPickerButton<class_ColorPickerButton>` instead if you need a button that brings up a **ColorPicker** in a popup.
.. rst-class:: classref-introduction-group
Tutorials
---------
- `Tween Interpolation Demo <https://godotengine.org/asset-library/asset/2733>`__
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`can_add_swatches<class_ColorPicker_property_can_add_swatches>` | ``true`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPicker_property_color>` | ``Color(1, 1, 1, 1)`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`ColorModeType<enum_ColorPicker_ColorModeType>` | :ref:`color_mode<class_ColorPicker_property_color_mode>` | ``0`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`color_modes_visible<class_ColorPicker_property_color_modes_visible>` | ``true`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`deferred_mode<class_ColorPicker_property_deferred_mode>` | ``false`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPicker_property_edit_alpha>` | ``true`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`edit_intensity<class_ColorPicker_property_edit_intensity>` | ``true`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`hex_visible<class_ColorPicker_property_hex_visible>` | ``true`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` | :ref:`picker_shape<class_ColorPicker_property_picker_shape>` | ``0`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`presets_visible<class_ColorPicker_property_presets_visible>` | ``true`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`sampler_visible<class_ColorPicker_property_sampler_visible>` | ``true`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`sliders_visible<class_ColorPicker_property_sliders_visible>` | ``true`` |
+----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_preset<class_ColorPicker_method_add_preset>`\ (\ color\: :ref:`Color<class_Color>`\ ) |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_recent_preset<class_ColorPicker_method_add_recent_preset>`\ (\ color\: :ref:`Color<class_Color>`\ ) |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`erase_preset<class_ColorPicker_method_erase_preset>`\ (\ color\: :ref:`Color<class_Color>`\ ) |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`erase_recent_preset<class_ColorPicker_method_erase_recent_preset>`\ (\ color\: :ref:`Color<class_Color>`\ ) |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`get_presets<class_ColorPicker_method_get_presets>`\ (\ ) |const| |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`get_recent_presets<class_ColorPicker_method_get_recent_presets>`\ (\ ) |const| |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Theme Properties
----------------
.. table::
:widths: auto
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Color<class_Color>` | :ref:`focused_not_editing_cursor_color<class_ColorPicker_theme_color_focused_not_editing_cursor_color>` | ``Color(1, 1, 1, 0.275)`` |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`int<class_int>` | :ref:`center_slider_grabbers<class_ColorPicker_theme_constant_center_slider_grabbers>` | ``1`` |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`int<class_int>` | :ref:`h_width<class_ColorPicker_theme_constant_h_width>` | ``30`` |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`int<class_int>` | :ref:`label_width<class_ColorPicker_theme_constant_label_width>` | ``10`` |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`int<class_int>` | :ref:`margin<class_ColorPicker_theme_constant_margin>` | ``4`` |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`int<class_int>` | :ref:`sv_height<class_ColorPicker_theme_constant_sv_height>` | ``256`` |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`int<class_int>` | :ref:`sv_width<class_ColorPicker_theme_constant_sv_width>` | ``256`` |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`add_preset<class_ColorPicker_theme_icon_add_preset>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`bar_arrow<class_ColorPicker_theme_icon_bar_arrow>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`color_hue<class_ColorPicker_theme_icon_color_hue>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`color_script<class_ColorPicker_theme_icon_color_script>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`expanded_arrow<class_ColorPicker_theme_icon_expanded_arrow>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`folded_arrow<class_ColorPicker_theme_icon_folded_arrow>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`menu_option<class_ColorPicker_theme_icon_menu_option>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`overbright_indicator<class_ColorPicker_theme_icon_overbright_indicator>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`picker_cursor<class_ColorPicker_theme_icon_picker_cursor>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`picker_cursor_bg<class_ColorPicker_theme_icon_picker_cursor_bg>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`sample_bg<class_ColorPicker_theme_icon_sample_bg>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`sample_revert<class_ColorPicker_theme_icon_sample_revert>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`screen_picker<class_ColorPicker_theme_icon_screen_picker>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`shape_circle<class_ColorPicker_theme_icon_shape_circle>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`shape_rect<class_ColorPicker_theme_icon_shape_rect>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`shape_rect_wheel<class_ColorPicker_theme_icon_shape_rect_wheel>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`picker_focus_circle<class_ColorPicker_theme_style_picker_focus_circle>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`picker_focus_rectangle<class_ColorPicker_theme_style_picker_focus_rectangle>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`sample_focus<class_ColorPicker_theme_style_sample_focus>` | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signals
-------
.. _class_ColorPicker_signal_color_changed:
.. rst-class:: classref-signal
**color_changed**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ColorPicker_signal_color_changed>`
Emitted when the color is changed.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_signal_preset_added:
.. rst-class:: classref-signal
**preset_added**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ColorPicker_signal_preset_added>`
Emitted when a preset is added.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_signal_preset_removed:
.. rst-class:: classref-signal
**preset_removed**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ColorPicker_signal_preset_removed>`
Emitted when a preset is removed.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_ColorPicker_ColorModeType:
.. rst-class:: classref-enumeration
enum **ColorModeType**: :ref:`🔗<enum_ColorPicker_ColorModeType>`
.. _class_ColorPicker_constant_MODE_RGB:
.. rst-class:: classref-enumeration-constant
:ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **MODE_RGB** = ``0``
Allows editing the color with Red/Green/Blue sliders in sRGB color space.
.. _class_ColorPicker_constant_MODE_HSV:
.. rst-class:: classref-enumeration-constant
:ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **MODE_HSV** = ``1``
Allows editing the color with Hue/Saturation/Value sliders.
.. _class_ColorPicker_constant_MODE_RAW:
.. rst-class:: classref-enumeration-constant
:ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **MODE_RAW** = ``2``
**Deprecated:** This is replaced by :ref:`MODE_LINEAR<class_ColorPicker_constant_MODE_LINEAR>`.
.. _class_ColorPicker_constant_MODE_LINEAR:
.. rst-class:: classref-enumeration-constant
:ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **MODE_LINEAR** = ``2``
Allows editing the color with Red/Green/Blue sliders in linear color space.
.. _class_ColorPicker_constant_MODE_OKHSL:
.. rst-class:: classref-enumeration-constant
:ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **MODE_OKHSL** = ``3``
Allows editing the color with Hue/Saturation/Lightness sliders.
OKHSL is a new color space similar to HSL but that better match perception by leveraging the Oklab color space which is designed to be simple to use, while doing a good job at predicting perceived lightness, chroma and hue.
\ `Okhsv and Okhsl color spaces <https://bottosson.github.io/posts/colorpicker/>`__
.. rst-class:: classref-item-separator
----
.. _enum_ColorPicker_PickerShapeType:
.. rst-class:: classref-enumeration
enum **PickerShapeType**: :ref:`🔗<enum_ColorPicker_PickerShapeType>`
.. _class_ColorPicker_constant_SHAPE_HSV_RECTANGLE:
.. rst-class:: classref-enumeration-constant
:ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` **SHAPE_HSV_RECTANGLE** = ``0``
HSV Color Model rectangle color space.
.. _class_ColorPicker_constant_SHAPE_HSV_WHEEL:
.. rst-class:: classref-enumeration-constant
:ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` **SHAPE_HSV_WHEEL** = ``1``
HSV Color Model rectangle color space with a wheel.
.. _class_ColorPicker_constant_SHAPE_VHS_CIRCLE:
.. rst-class:: classref-enumeration-constant
:ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` **SHAPE_VHS_CIRCLE** = ``2``
HSV Color Model circle color space. Use Saturation as a radius.
.. _class_ColorPicker_constant_SHAPE_OKHSL_CIRCLE:
.. rst-class:: classref-enumeration-constant
:ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` **SHAPE_OKHSL_CIRCLE** = ``3``
HSL OK Color Model circle color space.
.. _class_ColorPicker_constant_SHAPE_NONE:
.. rst-class:: classref-enumeration-constant
:ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` **SHAPE_NONE** = ``4``
The color space shape and the shape select button are hidden. Can't be selected from the shapes popup.
.. _class_ColorPicker_constant_SHAPE_OK_HS_RECTANGLE:
.. rst-class:: classref-enumeration-constant
:ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` **SHAPE_OK_HS_RECTANGLE** = ``5``
OKHSL Color Model rectangle with constant lightness.
.. _class_ColorPicker_constant_SHAPE_OK_HL_RECTANGLE:
.. rst-class:: classref-enumeration-constant
:ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` **SHAPE_OK_HL_RECTANGLE** = ``6``
OKHSL Color Model rectangle with constant saturation.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_ColorPicker_property_can_add_swatches:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **can_add_swatches** = ``true`` :ref:`🔗<class_ColorPicker_property_can_add_swatches>`
.. rst-class:: classref-property-setget
- |void| **set_can_add_swatches**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **are_swatches_enabled**\ (\ )
If ``true``, it's possible to add presets under Swatches. If ``false``, the button to add presets is disabled.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_ColorPicker_property_color>`
.. rst-class:: classref-property-setget
- |void| **set_pick_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_pick_color**\ (\ )
The currently selected color.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_color_mode:
.. rst-class:: classref-property
:ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **color_mode** = ``0`` :ref:`🔗<class_ColorPicker_property_color_mode>`
.. rst-class:: classref-property-setget
- |void| **set_color_mode**\ (\ value\: :ref:`ColorModeType<enum_ColorPicker_ColorModeType>`\ )
- :ref:`ColorModeType<enum_ColorPicker_ColorModeType>` **get_color_mode**\ (\ )
The currently selected color mode.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_color_modes_visible:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **color_modes_visible** = ``true`` :ref:`🔗<class_ColorPicker_property_color_modes_visible>`
.. rst-class:: classref-property-setget
- |void| **set_modes_visible**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **are_modes_visible**\ (\ )
If ``true``, the color mode buttons are visible.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_deferred_mode:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **deferred_mode** = ``false`` :ref:`🔗<class_ColorPicker_property_deferred_mode>`
.. rst-class:: classref-property-setget
- |void| **set_deferred_mode**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_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<class_bool>` **edit_alpha** = ``true`` :ref:`🔗<class_ColorPicker_property_edit_alpha>`
.. rst-class:: classref-property-setget
- |void| **set_edit_alpha**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_editing_alpha**\ (\ )
If ``true``, shows an alpha channel slider (opacity).
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_edit_intensity:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **edit_intensity** = ``true`` :ref:`🔗<class_ColorPicker_property_edit_intensity>`
.. rst-class:: classref-property-setget
- |void| **set_edit_intensity**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_editing_intensity**\ (\ )
If ``true``, shows an intensity slider. The intensity is applied as follows: multiply the color by ``2 ** intensity`` in linear RGB space, and then convert it back to sRGB.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_hex_visible:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **hex_visible** = ``true`` :ref:`🔗<class_ColorPicker_property_hex_visible>`
.. rst-class:: classref-property-setget
- |void| **set_hex_visible**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_hex_visible**\ (\ )
If ``true``, the hex color code input field is visible.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_picker_shape:
.. rst-class:: classref-property
:ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` **picker_shape** = ``0`` :ref:`🔗<class_ColorPicker_property_picker_shape>`
.. rst-class:: classref-property-setget
- |void| **set_picker_shape**\ (\ value\: :ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>`\ )
- :ref:`PickerShapeType<enum_ColorPicker_PickerShapeType>` **get_picker_shape**\ (\ )
The shape of the color space view.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_presets_visible:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **presets_visible** = ``true`` :ref:`🔗<class_ColorPicker_property_presets_visible>`
.. rst-class:: classref-property-setget
- |void| **set_presets_visible**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **are_presets_visible**\ (\ )
If ``true``, the Swatches and Recent Colors presets are visible.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_sampler_visible:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **sampler_visible** = ``true`` :ref:`🔗<class_ColorPicker_property_sampler_visible>`
.. rst-class:: classref-property-setget
- |void| **set_sampler_visible**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_sampler_visible**\ (\ )
If ``true``, the color sampler and color preview are visible.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_property_sliders_visible:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **sliders_visible** = ``true`` :ref:`🔗<class_ColorPicker_property_sliders_visible>`
.. rst-class:: classref-property-setget
- |void| **set_sliders_visible**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **are_sliders_visible**\ (\ )
If ``true``, the color sliders are visible.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_ColorPicker_method_add_preset:
.. rst-class:: classref-method
|void| **add_preset**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ColorPicker_method_add_preset>`
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_add_recent_preset:
.. rst-class:: classref-method
|void| **add_recent_preset**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ColorPicker_method_add_recent_preset>`
Adds the given color to a list of color recent presets so that it can be picked later. Recent presets are the colors that were picked recently, a new preset is automatically created and added to recent presets when you pick a new color.
\ **Note:** The recent 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**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ColorPicker_method_erase_preset>`
Removes the given color from the list of color presets of this color picker.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_method_erase_recent_preset:
.. rst-class:: classref-method
|void| **erase_recent_preset**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_ColorPicker_method_erase_recent_preset>`
Removes the given color from the list of color recent presets of this color picker.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_method_get_presets:
.. rst-class:: classref-method
:ref:`PackedColorArray<class_PackedColorArray>` **get_presets**\ (\ ) |const| :ref:`🔗<class_ColorPicker_method_get_presets>`
Returns the list of colors in the presets of the color picker.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_method_get_recent_presets:
.. rst-class:: classref-method
:ref:`PackedColorArray<class_PackedColorArray>` **get_recent_presets**\ (\ ) |const| :ref:`🔗<class_ColorPicker_method_get_recent_presets>`
Returns the list of colors in the recent presets of the color picker.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Theme Property Descriptions
---------------------------
.. _class_ColorPicker_theme_color_focused_not_editing_cursor_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **focused_not_editing_cursor_color** = ``Color(1, 1, 1, 0.275)`` :ref:`🔗<class_ColorPicker_theme_color_focused_not_editing_cursor_color>`
Color of rectangle or circle drawn when a picker shape part is focused but not editable via keyboard or joypad. Displayed *over* the picker shape, so a partially transparent color should be used to ensure the picker shape remains visible.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_constant_center_slider_grabbers:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **center_slider_grabbers** = ``1`` :ref:`🔗<class_ColorPicker_theme_constant_center_slider_grabbers>`
Overrides the :ref:`Slider.center_grabber<class_Slider_theme_constant_center_grabber>` theme property of the sliders.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_constant_h_width:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **h_width** = ``30`` :ref:`🔗<class_ColorPicker_theme_constant_h_width>`
The width of the hue selection slider.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_constant_label_width:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **label_width** = ``10`` :ref:`🔗<class_ColorPicker_theme_constant_label_width>`
The minimum width of the color labels next to sliders.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_constant_margin:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **margin** = ``4`` :ref:`🔗<class_ColorPicker_theme_constant_margin>`
The margin around the **ColorPicker**.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_constant_sv_height:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **sv_height** = ``256`` :ref:`🔗<class_ColorPicker_theme_constant_sv_height>`
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<class_int>` **sv_width** = ``256`` :ref:`🔗<class_ColorPicker_theme_constant_sv_width>`
The width of the saturation-value selection box.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_add_preset:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **add_preset** :ref:`🔗<class_ColorPicker_theme_icon_add_preset>`
The icon for the "Add Preset" button.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_bar_arrow:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **bar_arrow** :ref:`🔗<class_ColorPicker_theme_icon_bar_arrow>`
The texture for the arrow grabber.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_color_hue:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **color_hue** :ref:`🔗<class_ColorPicker_theme_icon_color_hue>`
Custom texture for the hue selection slider on the right.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_color_script:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **color_script** :ref:`🔗<class_ColorPicker_theme_icon_color_script>`
The icon for the button that switches color text to hexadecimal.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_expanded_arrow:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **expanded_arrow** :ref:`🔗<class_ColorPicker_theme_icon_expanded_arrow>`
The icon for color preset drop down menu when expanded.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_folded_arrow:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folded_arrow** :ref:`🔗<class_ColorPicker_theme_icon_folded_arrow>`
The icon for color preset drop down menu when folded.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_menu_option:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **menu_option** :ref:`🔗<class_ColorPicker_theme_icon_menu_option>`
The icon for color preset option menu.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_overbright_indicator:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **overbright_indicator** :ref:`🔗<class_ColorPicker_theme_icon_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_picker_cursor:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **picker_cursor** :ref:`🔗<class_ColorPicker_theme_icon_picker_cursor>`
The image displayed over the color box/circle (depending on the :ref:`picker_shape<class_ColorPicker_property_picker_shape>`), marking the currently selected color.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_picker_cursor_bg:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **picker_cursor_bg** :ref:`🔗<class_ColorPicker_theme_icon_picker_cursor_bg>`
The fill image displayed behind the picker cursor.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_sample_bg:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **sample_bg** :ref:`🔗<class_ColorPicker_theme_icon_sample_bg>`
Background panel for the color preview box (visible when the color is translucent).
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_sample_revert:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **sample_revert** :ref:`🔗<class_ColorPicker_theme_icon_sample_revert>`
The icon for the revert button (visible on the middle of the "old" color when it differs from the currently selected color). This icon is modulated with a dark color if the "old" color is bright enough, so the icon should be bright to ensure visibility in both scenarios.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_screen_picker:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **screen_picker** :ref:`🔗<class_ColorPicker_theme_icon_screen_picker>`
The icon for the screen color picker button.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_shape_circle:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **shape_circle** :ref:`🔗<class_ColorPicker_theme_icon_shape_circle>`
The icon for circular picker shapes.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_shape_rect:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **shape_rect** :ref:`🔗<class_ColorPicker_theme_icon_shape_rect>`
The icon for rectangular picker shapes.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_icon_shape_rect_wheel:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **shape_rect_wheel** :ref:`🔗<class_ColorPicker_theme_icon_shape_rect_wheel>`
The icon for rectangular wheel picker shapes.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_style_picker_focus_circle:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **picker_focus_circle** :ref:`🔗<class_ColorPicker_theme_style_picker_focus_circle>`
The :ref:`StyleBox<class_StyleBox>` used when the circle-shaped part of the picker is focused. Displayed *over* the picker shape, so a partially transparent :ref:`StyleBox<class_StyleBox>` should be used to ensure the picker shape remains visible. A :ref:`StyleBox<class_StyleBox>` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_style_picker_focus_rectangle:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **picker_focus_rectangle** :ref:`🔗<class_ColorPicker_theme_style_picker_focus_rectangle>`
The :ref:`StyleBox<class_StyleBox>` used when the rectangle-shaped part of the picker is focused. Displayed *over* the picker shape, so a partially transparent :ref:`StyleBox<class_StyleBox>` should be used to ensure the picker shape remains visible. A :ref:`StyleBox<class_StyleBox>` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
.. rst-class:: classref-item-separator
----
.. _class_ColorPicker_theme_style_sample_focus:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **sample_focus** :ref:`🔗<class_ColorPicker_theme_style_sample_focus>`
The :ref:`StyleBox<class_StyleBox>` used for the old color sample part when it is focused. Displayed *over* the sample, so a partially transparent :ref:`StyleBox<class_StyleBox>` should be used to ensure the picker shape remains visible. A :ref:`StyleBox<class_StyleBox>` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`
Reference in New Issue View Git Blame Copy Permalink