: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` **<** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`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` instead if you need a button that brings up a **ColorPicker** in a popup. .. rst-class:: classref-introduction-group Tutorials --------- - `Tween Interpolation Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`can_add_swatches` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`color` | ``Color(1, 1, 1, 1)`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`ColorModeType` | :ref:`color_mode` | ``0`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`color_modes_visible` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`deferred_mode` | ``false`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`edit_alpha` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`edit_intensity` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`hex_visible` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`PickerShapeType` | :ref:`picker_shape` | ``0`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`presets_visible` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`sampler_visible` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`sliders_visible` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_preset`\ (\ color\: :ref:`Color`\ ) | +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_recent_preset`\ (\ color\: :ref:`Color`\ ) | +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`erase_preset`\ (\ color\: :ref:`Color`\ ) | +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`erase_recent_preset`\ (\ color\: :ref:`Color`\ ) | +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedColorArray` | :ref:`get_presets`\ (\ ) |const| | +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedColorArray` | :ref:`get_recent_presets`\ (\ ) |const| | +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Color` | :ref:`focused_not_editing_cursor_color` | ``Color(1, 1, 1, 0.275)`` | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`int` | :ref:`center_slider_grabbers` | ``1`` | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :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:`Texture2D` | :ref:`add_preset` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`bar_arrow` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`color_hue` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`color_script` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`expanded_arrow` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`folded_arrow` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`menu_option` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`overbright_indicator` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`picker_cursor` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`picker_cursor_bg` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`sample_bg` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`sample_revert` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`screen_picker` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`shape_circle` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`shape_rect` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture2D` | :ref:`shape_rect_wheel` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`StyleBox` | :ref:`picker_focus_circle` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`StyleBox` | :ref:`picker_focus_rectangle` | | +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`StyleBox` | :ref:`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`\ ) :ref:`🔗` 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`\ ) :ref:`🔗` 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`\ ) :ref:`🔗` 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:`🔗` .. _class_ColorPicker_constant_MODE_RGB: .. rst-class:: classref-enumeration-constant :ref:`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` **MODE_HSV** = ``1`` Allows editing the color with Hue/Saturation/Value sliders. .. _class_ColorPicker_constant_MODE_RAW: .. rst-class:: classref-enumeration-constant :ref:`ColorModeType` **MODE_RAW** = ``2`` **Deprecated:** This is replaced by :ref:`MODE_LINEAR`. .. _class_ColorPicker_constant_MODE_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`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` **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 `__ .. rst-class:: classref-item-separator ---- .. _enum_ColorPicker_PickerShapeType: .. rst-class:: classref-enumeration enum **PickerShapeType**: :ref:`🔗` .. _class_ColorPicker_constant_SHAPE_HSV_RECTANGLE: .. rst-class:: classref-enumeration-constant :ref:`PickerShapeType` **SHAPE_HSV_RECTANGLE** = ``0`` HSV Color Model rectangle color space. .. _class_ColorPicker_constant_SHAPE_HSV_WHEEL: .. rst-class:: classref-enumeration-constant :ref:`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` **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` **SHAPE_OKHSL_CIRCLE** = ``3`` HSL OK Color Model circle color space. .. _class_ColorPicker_constant_SHAPE_NONE: .. rst-class:: classref-enumeration-constant :ref:`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` **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` **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` **can_add_swatches** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_can_add_swatches**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pick_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_pick_color**\ (\ ) The currently selected color. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_property_color_mode: .. rst-class:: classref-property :ref:`ColorModeType` **color_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_color_mode**\ (\ value\: :ref:`ColorModeType`\ ) - :ref:`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` **color_modes_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_modes_visible**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **deferred_mode** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_deferred_mode**\ (\ value\: :ref:`bool`\ ) - :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`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_edit_alpha**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **edit_intensity** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_edit_intensity**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **hex_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_hex_visible**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **picker_shape** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_picker_shape**\ (\ value\: :ref:`PickerShapeType`\ ) - :ref:`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` **presets_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_presets_visible**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **sampler_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sampler_visible**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **sliders_visible** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sliders_visible**\ (\ value\: :ref:`bool`\ ) - :ref:`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`\ ) :ref:`🔗` 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`\ ) :ref:`🔗` 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`\ ) :ref:`🔗` 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`\ ) :ref:`🔗` 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` **get_presets**\ (\ ) |const| :ref:`🔗` 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` **get_recent_presets**\ (\ ) |const| :ref:`🔗` 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` **focused_not_editing_cursor_color** = ``Color(1, 1, 1, 0.275)`` :ref:`🔗` 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` **center_slider_grabbers** = ``1`` :ref:`🔗` Overrides the :ref:`Slider.center_grabber` theme property of the sliders. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_constant_h_width: .. rst-class:: classref-themeproperty :ref:`int` **h_width** = ``30`` :ref:`🔗` 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`` :ref:`🔗` 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` **margin** = ``4`` :ref:`🔗` 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`` :ref:`🔗` 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`` :ref:`🔗` 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` **add_preset** :ref:`🔗` The icon for the "Add Preset" button. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_bar_arrow: .. rst-class:: classref-themeproperty :ref:`Texture2D` **bar_arrow** :ref:`🔗` The texture for the arrow grabber. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_color_hue: .. rst-class:: classref-themeproperty :ref:`Texture2D` **color_hue** :ref:`🔗` 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` **color_script** :ref:`🔗` 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` **expanded_arrow** :ref:`🔗` 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` **folded_arrow** :ref:`🔗` 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` **menu_option** :ref:`🔗` The icon for color preset option menu. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_overbright_indicator: .. rst-class:: classref-themeproperty :ref:`Texture2D` **overbright_indicator** :ref:`🔗` 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` **picker_cursor** :ref:`🔗` The image displayed over the color box/circle (depending on the :ref:`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` **picker_cursor_bg** :ref:`🔗` 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` **sample_bg** :ref:`🔗` 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` **sample_revert** :ref:`🔗` 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` **screen_picker** :ref:`🔗` 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` **shape_circle** :ref:`🔗` The icon for circular picker shapes. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_shape_rect: .. rst-class:: classref-themeproperty :ref:`Texture2D` **shape_rect** :ref:`🔗` The icon for rectangular picker shapes. .. rst-class:: classref-item-separator ---- .. _class_ColorPicker_theme_icon_shape_rect_wheel: .. rst-class:: classref-themeproperty :ref:`Texture2D` **shape_rect_wheel** :ref:`🔗` 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` **picker_focus_circle** :ref:`🔗` The :ref:`StyleBox` used when the circle-shaped part of the picker is focused. Displayed *over* the picker shape, so a partially transparent :ref:`StyleBox` should be used to ensure the picker shape remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`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` **picker_focus_rectangle** :ref:`🔗` The :ref:`StyleBox` used when the rectangle-shaped part of the picker is focused. Displayed *over* the picker shape, so a partially transparent :ref:`StyleBox` should be used to ensure the picker shape remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`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` **sample_focus** :ref:`🔗` The :ref:`StyleBox` used for the old color sample part when it is focused. Displayed *over* the sample, so a partially transparent :ref:`StyleBox` should be used to ensure the picker shape remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`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.)`