class_canvasgroup.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasGroup.xml.
  6. .. _class_CanvasGroup:
  7. CanvasGroup
  8. ===========
  9. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. .. container:: contribute
  11. There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  12. Properties
  13. ----------
  14. +---------------------------+--------------------------------------------------------------+-----------+
  15. | :ref:`float<class_float>` | :ref:`clear_margin<class_CanvasGroup_property_clear_margin>` | ``10.0`` |
  16. +---------------------------+--------------------------------------------------------------+-----------+
  17. | :ref:`float<class_float>` | :ref:`fit_margin<class_CanvasGroup_property_fit_margin>` | ``10.0`` |
  18. +---------------------------+--------------------------------------------------------------+-----------+
  19. | :ref:`bool<class_bool>` | :ref:`use_mipmaps<class_CanvasGroup_property_use_mipmaps>` | ``false`` |
  20. +---------------------------+--------------------------------------------------------------+-----------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_CanvasGroup_property_clear_margin:
  24. - :ref:`float<class_float>` **clear_margin**
  25. +-----------+-------------------------+
  26. | *Default* | ``10.0`` |
  27. +-----------+-------------------------+
  28. | *Setter* | set_clear_margin(value) |
  29. +-----------+-------------------------+
  30. | *Getter* | get_clear_margin() |
  31. +-----------+-------------------------+
  32. .. container:: contribute
  33. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  34. ----
  35. .. _class_CanvasGroup_property_fit_margin:
  36. - :ref:`float<class_float>` **fit_margin**
  37. +-----------+-----------------------+
  38. | *Default* | ``10.0`` |
  39. +-----------+-----------------------+
  40. | *Setter* | set_fit_margin(value) |
  41. +-----------+-----------------------+
  42. | *Getter* | get_fit_margin() |
  43. +-----------+-----------------------+
  44. .. container:: contribute
  45. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  46. ----
  47. .. _class_CanvasGroup_property_use_mipmaps:
  48. - :ref:`bool<class_bool>` **use_mipmaps**
  49. +-----------+------------------------+
  50. | *Default* | ``false`` |
  51. +-----------+------------------------+
  52. | *Setter* | set_use_mipmaps(value) |
  53. +-----------+------------------------+
  54. | *Getter* | is_using_mipmaps() |
  55. +-----------+------------------------+
  56. .. container:: contribute
  57. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  58. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  59. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  60. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  61. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  62. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  63. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`