class_canvasgroup.rst 3.0 KB

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