OpenXRSpatialCapabilityConfigurationBaseHeader.xml 1.6 KB

12345678910111213141516171819202122232425262728293031
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="OpenXRSpatialCapabilityConfigurationBaseHeader" inherits="RefCounted" experimental="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. Wrapper base class for OpenXR Spatial Capability Configuration headers.
  5. </brief_description>
  6. <description>
  7. Wrapper base class for OpenXR Spatial Capability Configuration headers. This class needs to be implemented for each capability configuration structure usable within OpenXR's spatial entities system.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="_get_configuration" qualifiers="virtual">
  13. <return type="int" />
  14. <description>
  15. Return a pointer (encoded as an [code]int64_t[/code]) to a struct holding the spatial capability configuration data. The memory for this struct should remain accessible as long as this object remains instantiated.
  16. </description>
  17. </method>
  18. <method name="_has_valid_configuration" qualifiers="virtual const">
  19. <return type="bool" />
  20. <description>
  21. Return [code]true[/code] if this object contains a valid configuration that can be retrieved when calling [method _get_configuration].
  22. </description>
  23. </method>
  24. <method name="has_valid_configuration" qualifiers="const">
  25. <return type="bool" />
  26. <description>
  27. Returns [code]true[/code] if this object contains a valid configuration that can be used when calling [method OpenXRSpatialEntityExtension.create_spatial_context].
  28. </description>
  29. </method>
  30. </methods>
  31. </class>