class_canvasgroup.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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. Properties
  11. ----------
  12. +---------------------------+--------------------------------------------------------------+-----------+
  13. | :ref:`float<class_float>` | :ref:`clear_margin<class_CanvasGroup_property_clear_margin>` | ``10.0`` |
  14. +---------------------------+--------------------------------------------------------------+-----------+
  15. | :ref:`float<class_float>` | :ref:`fit_margin<class_CanvasGroup_property_fit_margin>` | ``10.0`` |
  16. +---------------------------+--------------------------------------------------------------+-----------+
  17. | :ref:`bool<class_bool>` | :ref:`use_mipmaps<class_CanvasGroup_property_use_mipmaps>` | ``false`` |
  18. +---------------------------+--------------------------------------------------------------+-----------+
  19. Property Descriptions
  20. ---------------------
  21. .. _class_CanvasGroup_property_clear_margin:
  22. - :ref:`float<class_float>` **clear_margin**
  23. +-----------+-------------------------+
  24. | *Default* | ``10.0`` |
  25. +-----------+-------------------------+
  26. | *Setter* | set_clear_margin(value) |
  27. +-----------+-------------------------+
  28. | *Getter* | get_clear_margin() |
  29. +-----------+-------------------------+
  30. ----
  31. .. _class_CanvasGroup_property_fit_margin:
  32. - :ref:`float<class_float>` **fit_margin**
  33. +-----------+-----------------------+
  34. | *Default* | ``10.0`` |
  35. +-----------+-----------------------+
  36. | *Setter* | set_fit_margin(value) |
  37. +-----------+-----------------------+
  38. | *Getter* | get_fit_margin() |
  39. +-----------+-----------------------+
  40. ----
  41. .. _class_CanvasGroup_property_use_mipmaps:
  42. - :ref:`bool<class_bool>` **use_mipmaps**
  43. +-----------+------------------------+
  44. | *Default* | ``false`` |
  45. +-----------+------------------------+
  46. | *Setter* | set_use_mipmaps(value) |
  47. +-----------+------------------------+
  48. | *Getter* | is_using_mipmaps() |
  49. +-----------+------------------------+
  50. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  51. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  52. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  53. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  54. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  55. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`