Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: b51a272459
Branches Tags
godot-docs
/
classes
/
class_colorpicker.rst

class_colorpicker.rst 4.1 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_ColorPicker:
    5. 

  5. 

  6. ColorPicker
    7. 

  7. ===========
    8. 

  8. 

  9. **Inherits:** :ref:`BoxContainer<class_boxcontainer>` **<** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. Color picker control.
    17. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +----------------------------+----------------------------------------------------------------------------------------------------+
    22. 

  22. | void                       | :ref:`set_color<class_ColorPicker_set_color>`  **(** :ref:`Color<class_color>` color  **)**        |
    23. 

  23. +----------------------------+----------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`Color<class_color>`  | :ref:`get_color<class_ColorPicker_get_color>`  **(** **)** const                                   |
    25. 

  25. +----------------------------+----------------------------------------------------------------------------------------------------+
    26. 

  26. | void                       | :ref:`set_raw_mode<class_ColorPicker_set_raw_mode>`  **(** :ref:`bool<class_bool>` mode  **)**     |
    27. 

  27. +----------------------------+----------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`bool<class_bool>`    | :ref:`is_raw_mode<class_ColorPicker_is_raw_mode>`  **(** **)** const                               |
    29. 

  29. +----------------------------+----------------------------------------------------------------------------------------------------+
    30. 

  30. | void                       | :ref:`set_edit_alpha<class_ColorPicker_set_edit_alpha>`  **(** :ref:`bool<class_bool>` show  **)** |
    31. 

  31. +----------------------------+----------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`bool<class_bool>`    | :ref:`is_editing_alpha<class_ColorPicker_is_editing_alpha>`  **(** **)** const                     |
    33. 

  33. +----------------------------+----------------------------------------------------------------------------------------------------+
    34. 

  34. | void                       | :ref:`add_preset<class_ColorPicker_add_preset>`  **(** :ref:`Color<class_color>` arg0  **)**       |
    35. 

  35. +----------------------------+----------------------------------------------------------------------------------------------------+
    36. 

  36. 

  37. Signals
    38. 

  38. -------
    39. 

  39. 

  40. -  **color_changed**  **(** :ref:`Color<class_color>` color  **)**
    41. 

  41. 

  42. Description
    43. 

  43. -----------
    44. 

  44. 

  45. This is a simple color picker :ref:`Control<class_control>`. It's useful for selecting a color from an RGB/RGBA colorspace.
    46. 

  46. 

  47. Member Function Description
    48. 

  48. ---------------------------
    49. 

  49. 

  50. .. _class_ColorPicker_set_color:
    51. 

  51. 

  52. - void  **set_color**  **(** :ref:`Color<class_color>` color  **)**
    53. 

  53. 

  54. Select the current color.
    55. 

  55. 

  56. .. _class_ColorPicker_get_color:
    57. 

  57. 

  58. - :ref:`Color<class_color>`  **get_color**  **(** **)** const
    59. 

  59. 

  60. Return the current (edited) color.
    61. 

  61. 

  62. .. _class_ColorPicker_set_raw_mode:
    63. 

  63. 

  64. - void  **set_raw_mode**  **(** :ref:`bool<class_bool>` mode  **)**
    65. 

  65. 

  66. When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255.
    67. 

  67. 

  68. .. _class_ColorPicker_is_raw_mode:
    69. 

  69. 

  70. - :ref:`bool<class_bool>`  **is_raw_mode**  **(** **)** const
    71. 

  71. 

  72. Returns whether this color picker is in raw mode or not
    73. 

  73. 

  74. .. _class_ColorPicker_set_edit_alpha:
    75. 

  75. 

  76. - void  **set_edit_alpha**  **(** :ref:`bool<class_bool>` show  **)**
    77. 

  77. 

  78. Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color.
    79. 

  79. 

  80. .. _class_ColorPicker_is_editing_alpha:
    81. 

  81. 

  82. - :ref:`bool<class_bool>`  **is_editing_alpha**  **(** **)** const
    83. 

  83. 

  84. Returns whether the color has transparency or not.
    85. 

  85. 

  86. .. _class_ColorPicker_add_preset:
    87. 

  87. 

  88. - void  **add_preset**  **(** :ref:`Color<class_color>` arg0  **)**
    89. 

  89. 

  90. Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
    91. 

  91. 

  92.