Files
godot-docs/classes/class_canvasmodulate.rst
Rémi Verschelde 782dd64a19 classref: Use code markup for default values/overrides
Sync with godotengine/godot#35357.
Fixes #3071.
2020-01-20 12:41:39 +01:00

45 lines
1.4 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.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.