class_openxrspatialplanetrackingcapability.rst 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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/modules/openxr/doc_classes/OpenXRSpatialPlaneTrackingCapability.xml.
  6. .. _class_OpenXRSpatialPlaneTrackingCapability:
  7. OpenXRSpatialPlaneTrackingCapability
  8. ====================================
  9. **Experimental:** This class may be changed or removed in future versions.
  10. **Inherits:** :ref:`OpenXRExtensionWrapper<class_OpenXRExtensionWrapper>` **<** :ref:`Object<class_Object>`
  11. Implementation for handling spatial entity plane tracking logic.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. This class handles the OpenXR plane tracking spatial entity extension.
  16. .. rst-class:: classref-reftable-group
  17. Methods
  18. -------
  19. .. table::
  20. :widths: auto
  21. +-------------------------+-------------------------------------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`is_supported<class_OpenXRSpatialPlaneTrackingCapability_method_is_supported>`\ (\ ) |
  23. +-------------------------+-------------------------------------------------------------------------------------------+
  24. .. rst-class:: classref-section-separator
  25. ----
  26. .. rst-class:: classref-descriptions-group
  27. Method Descriptions
  28. -------------------
  29. .. _class_OpenXRSpatialPlaneTrackingCapability_method_is_supported:
  30. .. rst-class:: classref-method
  31. :ref:`bool<class_bool>` **is_supported**\ (\ ) :ref:`🔗<class_OpenXRSpatialPlaneTrackingCapability_method_is_supported>`
  32. Returns ``true`` if plane tracking is supported by the current device.
  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  34. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  35. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  36. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  37. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  38. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  39. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  40. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  41. .. |void| replace:: :abbr:`void (No return value.)`