: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:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`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 :ref:`ColorPickerButton` instead if you need a button that brings up a ``ColorPicker`` in a pop-up. Tutorials --------- - `Tween Demo `__ Properties ---------- +----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`color` | ``Color(1, 1, 1, 1)`` | +----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`ColorModeType` | :ref:`color_mode` | ``0`` | +----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`deferred_mode` | ``false`` | +----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`edit_alpha` | ``true`` | +----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`PickerShapeType` | :ref:`picker_shape` | ``0`` | +----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`presets_enabled` | ``true`` | +----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`presets_visible` | ``true`` | +----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ Methods ------- +-------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | void | :ref:`add_preset` **(** :ref:`Color` color **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_preset` **(** :ref:`Color` color **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :ref:`PackedColorArray` | :ref:`get_presets` **(** **)** |const| | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- +-----------------------------------+--------------------------------------------------------------------------------+---------+ | :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:`overbright_indicator` | | +-----------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`Texture2D` | :ref:`picker_cursor` | | +-----------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`Texture2D` | :ref:`sample_bg` | | +-----------------------------------+--------------------------------------------------------------------------------+---------+ | :ref:`Texture2D` | :ref:`screen_picker` | | +-----------------------------------+--------------------------------------------------------------------------------+---------+ Signals ------- .. _class_ColorPicker_signal_color_changed: - **color_changed** **(** :ref:`Color` color **)** Emitted when the color is changed. ---- .. _class_ColorPicker_signal_preset_added: - **preset_added** **(** :ref:`Color` color **)** Emitted when a preset is added. ---- .. _class_ColorPicker_signal_preset_removed: - **preset_removed** **(** :ref:`Color` color **)** Emitted when a preset is removed. Enumerations ------------ .. _enum_ColorPicker_ColorModeType: .. _class_ColorPicker_constant_MODE_RGB: .. _class_ColorPicker_constant_MODE_HSV: .. _class_ColorPicker_constant_MODE_RAW: .. _class_ColorPicker_constant_MODE_OKHSL: enum **ColorModeType**: - **MODE_RGB** = **0** --- Allows editing the color with Red/Green/Blue sliders. - **MODE_HSV** = **1** --- Allows editing the color with Hue/Saturation/Value sliders. - **MODE_RAW** = **2** --- 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). - **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 `__ ---- .. _enum_ColorPicker_PickerShapeType: .. _class_ColorPicker_constant_SHAPE_HSV_RECTANGLE: .. _class_ColorPicker_constant_SHAPE_HSV_WHEEL: .. _class_ColorPicker_constant_SHAPE_VHS_CIRCLE: .. _class_ColorPicker_constant_SHAPE_OKHSL_CIRCLE: enum **PickerShapeType**: - **SHAPE_HSV_RECTANGLE** = **0** --- HSV Color Model rectangle color space. - **SHAPE_HSV_WHEEL** = **1** --- HSV Color Model rectangle color space with a wheel. - **SHAPE_VHS_CIRCLE** = **2** --- HSV Color Model circle color space. Use Saturation as a radius. - **SHAPE_OKHSL_CIRCLE** = **3** --- HSL OK Color Model circle color space. Property Descriptions --------------------- .. _class_ColorPicker_property_color: - :ref:`Color` **color** +-----------+-----------------------+ | *Default* | ``Color(1, 1, 1, 1)`` | +-----------+-----------------------+ | *Setter* | set_pick_color(value) | +-----------+-----------------------+ | *Getter* | get_pick_color() | +-----------+-----------------------+ The currently selected color. ---- .. _class_ColorPicker_property_color_mode: - :ref:`ColorModeType` **color_mode** +-----------+-----------------------+ | *Default* | ``0`` | +-----------+-----------------------+ | *Setter* | set_color_mode(value) | +-----------+-----------------------+ | *Getter* | get_color_mode() | +-----------+-----------------------+ The currently selected color mode. See :ref:`ColorModeType`. ---- .. _class_ColorPicker_property_deferred_mode: - :ref:`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). ---- .. _class_ColorPicker_property_edit_alpha: - :ref:`bool` **edit_alpha** +-----------+-----------------------+ | *Default* | ``true`` | +-----------+-----------------------+ | *Setter* | set_edit_alpha(value) | +-----------+-----------------------+ | *Getter* | is_editing_alpha() | +-----------+-----------------------+ If ``true``, shows an alpha channel slider (opacity). ---- .. _class_ColorPicker_property_picker_shape: - :ref:`PickerShapeType` **picker_shape** +-----------+-------------------------+ | *Default* | ``0`` | +-----------+-------------------------+ | *Setter* | set_picker_shape(value) | +-----------+-------------------------+ | *Getter* | get_picker_shape() | +-----------+-------------------------+ The shape of the color space view. See :ref:`PickerShapeType`. ---- .. _class_ColorPicker_property_presets_enabled: - :ref:`bool` **presets_enabled** +-----------+----------------------------+ | *Default* | ``true`` | +-----------+----------------------------+ | *Setter* | set_presets_enabled(value) | +-----------+----------------------------+ | *Getter* | are_presets_enabled() | +-----------+----------------------------+ If ``true``, the "add preset" button is enabled. ---- .. _class_ColorPicker_property_presets_visible: - :ref:`bool` **presets_visible** +-----------+----------------------------+ | *Default* | ``true`` | +-----------+----------------------------+ | *Setter* | set_presets_visible(value) | +-----------+----------------------------+ | *Getter* | are_presets_visible() | +-----------+----------------------------+ If ``true``, saved color presets are visible. Method Descriptions ------------------- .. _class_ColorPicker_method_add_preset: - 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. ---- .. _class_ColorPicker_method_erase_preset: - void **erase_preset** **(** :ref:`Color` color **)** Removes the given color from the list of color presets of this color picker. ---- .. _class_ColorPicker_method_get_presets: - :ref:`PackedColorArray` **get_presets** **(** **)** |const| Returns the list of colors in the presets of the color picker. Theme Property Descriptions --------------------------- .. _class_ColorPicker_theme_constant_h_width: - :ref:`int` **h_width** +-----------+--------+ | *Default* | ``30`` | +-----------+--------+ The width of the hue selection slider. ---- .. _class_ColorPicker_theme_constant_label_width: - :ref:`int` **label_width** +-----------+--------+ | *Default* | ``10`` | +-----------+--------+ ---- .. _class_ColorPicker_theme_constant_margin: - :ref:`int` **margin** +-----------+-------+ | *Default* | ``4`` | +-----------+-------+ The margin around the ``ColorPicker``. ---- .. _class_ColorPicker_theme_constant_sv_height: - :ref:`int` **sv_height** +-----------+---------+ | *Default* | ``256`` | +-----------+---------+ The height of the saturation-value selection box. ---- .. _class_ColorPicker_theme_constant_sv_width: - :ref:`int` **sv_width** +-----------+---------+ | *Default* | ``256`` | +-----------+---------+ The width of the saturation-value selection box. ---- .. _class_ColorPicker_theme_icon_add_preset: - :ref:`Texture2D` **add_preset** The icon for the "Add Preset" button. ---- .. _class_ColorPicker_theme_icon_bar_arrow: - :ref:`Texture2D` **bar_arrow** The texture for the arrow grabber. ---- .. _class_ColorPicker_theme_icon_color_hue: - :ref:`Texture2D` **color_hue** Custom texture for the hue selection slider on the right. ---- .. _class_ColorPicker_theme_icon_overbright_indicator: - :ref:`Texture2D` **overbright_indicator** The indicator used to signalize that the color value is outside the 0-1 range. ---- .. _class_ColorPicker_theme_icon_picker_cursor: - :ref:`Texture2D` **picker_cursor** ---- .. _class_ColorPicker_theme_icon_sample_bg: - :ref:`Texture2D` **sample_bg** ---- .. _class_ColorPicker_theme_icon_screen_picker: - :ref:`Texture2D` **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.)` .. |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.)`