class_openxrspatialmarkertrackingcapability.rst 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  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/OpenXRSpatialMarkerTrackingCapability.xml.
  6. .. _class_OpenXRSpatialMarkerTrackingCapability:
  7. OpenXRSpatialMarkerTrackingCapability
  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 marker tracking logic.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. This class handles the OpenXR marker 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_april_tag_supported<class_OpenXRSpatialMarkerTrackingCapability_method_is_april_tag_supported>`\ (\ ) |
  23. +-------------------------+----------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`is_aruco_supported<class_OpenXRSpatialMarkerTrackingCapability_method_is_aruco_supported>`\ (\ ) |
  25. +-------------------------+----------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`bool<class_bool>` | :ref:`is_micro_qrcode_supported<class_OpenXRSpatialMarkerTrackingCapability_method_is_micro_qrcode_supported>`\ (\ ) |
  27. +-------------------------+----------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`bool<class_bool>` | :ref:`is_qrcode_supported<class_OpenXRSpatialMarkerTrackingCapability_method_is_qrcode_supported>`\ (\ ) |
  29. +-------------------------+----------------------------------------------------------------------------------------------------------------------+
  30. .. rst-class:: classref-section-separator
  31. ----
  32. .. rst-class:: classref-descriptions-group
  33. Method Descriptions
  34. -------------------
  35. .. _class_OpenXRSpatialMarkerTrackingCapability_method_is_april_tag_supported:
  36. .. rst-class:: classref-method
  37. :ref:`bool<class_bool>` **is_april_tag_supported**\ (\ ) :ref:`🔗<class_OpenXRSpatialMarkerTrackingCapability_method_is_april_tag_supported>`
  38. Returns ``true`` if April tag marker tracking is supported by the current device.
  39. .. rst-class:: classref-item-separator
  40. ----
  41. .. _class_OpenXRSpatialMarkerTrackingCapability_method_is_aruco_supported:
  42. .. rst-class:: classref-method
  43. :ref:`bool<class_bool>` **is_aruco_supported**\ (\ ) :ref:`🔗<class_OpenXRSpatialMarkerTrackingCapability_method_is_aruco_supported>`
  44. Returns ``true`` if Aruco marker tracking is supported by the current device.
  45. .. rst-class:: classref-item-separator
  46. ----
  47. .. _class_OpenXRSpatialMarkerTrackingCapability_method_is_micro_qrcode_supported:
  48. .. rst-class:: classref-method
  49. :ref:`bool<class_bool>` **is_micro_qrcode_supported**\ (\ ) :ref:`🔗<class_OpenXRSpatialMarkerTrackingCapability_method_is_micro_qrcode_supported>`
  50. Returns ``true`` if micro QR code marker tracking is supported by the current device.
  51. .. rst-class:: classref-item-separator
  52. ----
  53. .. _class_OpenXRSpatialMarkerTrackingCapability_method_is_qrcode_supported:
  54. .. rst-class:: classref-method
  55. :ref:`bool<class_bool>` **is_qrcode_supported**\ (\ ) :ref:`🔗<class_OpenXRSpatialMarkerTrackingCapability_method_is_qrcode_supported>`
  56. Returns ``true`` if QR code marker tracking is supported by the current device.
  57. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  58. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  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.)`
  64. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  65. .. |void| replace:: :abbr:`void (No return value.)`