C Specification

// Provided by XR_BD_spatial_anchor_sharing
typedef struct XrSystemSpatialAnchorSharingPropertiesBD {
    XrStructureType    type;
    void*              next;
    XrBool32           supportsSpatialAnchorSharing;
} XrSystemSpatialAnchorSharingPropertiesBD;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain.

  • supportsSpatialAnchorSharing is an XrBool32, indicating if the current system is capable of spatial anchor sharing.

Description

An application can inspect whether the system is capable of spatial anchor sharing by chaining an XrSystemSpatialAnchorSharingPropertiesBD structure to the XrSystemProperties::next chain when calling xrGetSystemProperties.

If a runtime returns XR_FALSE for supportsSpatialAnchorSharing, the system does not support spatial anchor sharing. The application should avoid using spatial anchor sharing functionality when supportsSpatialAnchorSharing is XR_FALSE. If XrSystemSpatialSensingPropertiesBD::supportsSpatialSensing is XR_FALSE, then supportsSpatialAnchorSharing must also be XR_FALSE. Similarly, if XrSystemSpatialAnchorPropertiesBD::supportsSpatialAnchor is XR_FALSE, then supportsSpatialAnchorSharing must also be XR_FALSE.

If a runtime returns XR_FALSE for supportsSpatialAnchorSharing, the runtime must return XR_ERROR_FEATURE_UNSUPPORTED for all the functions defined in this extension.

If a runtime returns XR_TRUE for supportsSpatialAnchorSharing, the system supports spatial anchor sharing. This implies that XrSystemSpatialSensingPropertiesBD::supportsSpatialSensing and XrSystemSpatialAnchorPropertiesBD::supportsSpatialAnchor must also be also XR_TRUE.

Valid Usage (Implicit)

See Also

XR_BD_spatial_anchor_sharing, XrBool32, XrStructureType, XrSystemProperties, xrGetSystemProperties

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2025 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.