class_canvasmodulate.rst 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  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. Properties
  13. ----------
  14. +---------------------------+------------------------------------------+
  15. | :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_color>` |
  16. +---------------------------+------------------------------------------+
  17. Description
  18. -----------
  19. ``CanvasModulate`` tints the canvas elements using its assigned ``color``.
  20. Property Descriptions
  21. ---------------------
  22. .. _class_CanvasModulate_color:
  23. - :ref:`Color<class_Color>` **color**
  24. +----------+------------------+
  25. | *Setter* | set_color(value) |
  26. +----------+------------------+
  27. | *Getter* | get_color() |
  28. +----------+------------------+
  29. The tint color to apply.