| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the CanvasModulate.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_CanvasModulate:
- CanvasModulate
- ==============
- **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Tint the entire canvas.
- Description
- -----------
- ``CanvasModulate`` tints the canvas elements using its assigned :ref:`color<class_CanvasModulate_property_color>`.
- Properties
- ----------
- +---------------------------+---------------------------------------------------+-------------------------+
- | :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_property_color>` | ``Color( 1, 1, 1, 1 )`` |
- +---------------------------+---------------------------------------------------+-------------------------+
- Property Descriptions
- ---------------------
- .. _class_CanvasModulate_property_color:
- - :ref:`Color<class_Color>` **color**
- +-----------+-------------------------+
- | *Default* | ``Color( 1, 1, 1, 1 )`` |
- +-----------+-------------------------+
- | *Setter* | set_color(value) |
- +-----------+-------------------------+
- | *Getter* | get_color() |
- +-----------+-------------------------+
- The tint color to apply.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
