ColorPicker

Inherits: BoxContainer < Container < Control < CanvasItem < Node < 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 ColorPickerButton instead if you need a button that brings up a ColorPicker in a pop-up.

Tutorials

  • Tween Demo

    Properties

    Methods

    Theme Properties

    Signals

  • color_changed ( Color color ) Emitted when the color is changed.
  • preset_added ( Color color ) Emitted when a preset is added.
  • preset_removed ( Color color ) Emitted when a preset is removed.

    Property Descriptions

  • Color color The currently selected color.
  • bool deferred_mode 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).
  • bool edit_alpha true, shows an alpha channel slider (opacity).
  • bool hsv_mode true, allows editing the color with Hue/Saturation/Value sliders. Note: Cannot be enabled if raw mode is on.
  • bool presets_enabled true, the “add preset” button is enabled.
  • bool presets_visible true, saved color presets are visible.
  • bool raw_mode 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.

    Method Descriptions

  • add_preset ( 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.
  • erase_preset ( Color color ) Removes the given color from the list of color presets of this color picker.
  • PoolColorArray get_presets ( ) const Returns the list of colors in the presets of the color picker.

    Theme Property Descriptions

  • int h_width The width of the hue selection slider.

- int label_width

  • int margin ColorPicker.
  • int sv_height The height of the saturation-value selection box.
  • int sv_width The width of the saturation-value selection box.
  • Texture add_preset The icon for the “Add Preset” button.
  • Texture color_hue Custom texture for the hue selection slider on the right.

- Texture color_sample

  • Texture overbright_indicator The indicator used to signalize that the color value is outside the 0-1 range.

- Texture preset_bg

  • Texture screen_picker The icon for the screen color picker button.