class_canvasmodulate.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the CanvasModulate.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CanvasModulate:
  6. CanvasModulate
  7. ==============
  8. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Tint the entire canvas.
  13. Properties
  14. ----------
  15. +---------------------------+---------------------------------------------------+---------------------+
  16. | :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_property_color>` | Color( 1, 1, 1, 1 ) |
  17. +---------------------------+---------------------------------------------------+---------------------+
  18. Description
  19. -----------
  20. ``CanvasModulate`` tints the canvas elements using its assigned :ref:`color<class_CanvasModulate_property_color>`.
  21. Property Descriptions
  22. ---------------------
  23. .. _class_CanvasModulate_property_color:
  24. - :ref:`Color<class_Color>` **color**
  25. +-----------+---------------------+
  26. | *Default* | Color( 1, 1, 1, 1 ) |
  27. +-----------+---------------------+
  28. | *Setter* | set_color(value) |
  29. +-----------+---------------------+
  30. | *Getter* | get_color() |
  31. +-----------+---------------------+
  32. The tint color to apply.