class_canvasmodulate.rst 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_CanvasModulate:
  4. CanvasModulate
  5. ==============
  6. **Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Tint the entire canvas
  11. Member Functions
  12. ----------------
  13. +----------------------------+------------------------------------------------------------------------------------------------+
  14. | :ref:`Color<class_color>` | :ref:`get_color<class_CanvasModulate_get_color>` **(** **)** const |
  15. +----------------------------+------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_color<class_CanvasModulate_set_color>` **(** :ref:`Color<class_color>` color **)** |
  17. +----------------------------+------------------------------------------------------------------------------------------------+
  18. Description
  19. -----------
  20. CanvasModulate tints the canvas elements using its asigned color
  21. Member Function Description
  22. ---------------------------
  23. .. _class_CanvasModulate_get_color:
  24. - :ref:`Color<class_color>` **get_color** **(** **)** const
  25. Gets the canvas tint color
  26. .. _class_CanvasModulate_set_color:
  27. - void **set_color** **(** :ref:`Color<class_color>` color **)**
  28. Sets the canvas tint color