Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_canvasmodulate.rst

class_canvasmodulate.rst 2.0 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the CanvasModulate.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_CanvasModulate:
    8. 

  8. 

  9. CanvasModulate
    10. 

  10. ==============
    11. 

  11. 

  12. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Tint the entire canvas.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. ``CanvasModulate`` tints the canvas elements using its assigned :ref:`color<class_CanvasModulate_property_color>`.
    20. 

  20. 

  21. Properties
    22. 

  22. ----------
    23. 

  23. 

  24. +---------------------------+---------------------------------------------------+-----------------------+
    25. 

  25. | :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_property_color>` | ``Color(1, 1, 1, 1)`` |
    26. 

  26. +---------------------------+---------------------------------------------------+-----------------------+
    27. 

  27. 

  28. Property Descriptions
    29. 

  29. ---------------------
    30. 

  30. 

  31. .. _class_CanvasModulate_property_color:
    32. 

  32. 

  33. - :ref:`Color<class_Color>` **color**
    34. 

  34. 

  35. +-----------+-----------------------+
    36. 

  36. | *Default* | ``Color(1, 1, 1, 1)`` |
    37. 

  37. +-----------+-----------------------+
    38. 

  38. | *Setter*  | set_color(value)      |
    39. 

  39. +-----------+-----------------------+
    40. 

  40. | *Getter*  | get_color()           |
    41. 

  41. +-----------+-----------------------+
    42. 

  42. 

  43. The tint color to apply.
    44. 

  44. 

  45. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    46. 

  46. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    47. 

  47. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    48. 

  48. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    49. 

  49. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    50. 

  50. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    51.