class_canvasmodulate.rst 1.7 KB

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