C Specification

The XrSystemSpatialScenePropertiesBD structure is defined as:

// Provided by XR_BD_spatial_scene
typedef struct XrSystemSpatialScenePropertiesBD {
    XrStructureType    type;
    void*              next;
    XrBool32           supportsSpatialScene;
} XrSystemSpatialScenePropertiesBD;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

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

  • supportsSpatialScene is an XrBool32, indicating if the current system is capable of spatial scene functionality.

Description

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

If a runtime returns XR_FALSE for supportsSpatialScene, the system does not support spatial scene functionality, and must return XR_ERROR_FEATURE_UNSUPPORTED from xrCreateSenseDataProviderBD when passing the XrSenseDataProviderTypeBD value XR_SENSE_DATA_PROVIDER_TYPE_SCENE_BD.

The application should avoid using spatial scene functionality when supportsSpatialScene is XR_FALSE.

If XrSystemSpatialSensingPropertiesBD::supportsSpatialSensing is XR_FALSE, then supportsSpatialScene must also be XR_FALSE.

If a runtime returns XR_TRUE for supportsSpatialScene, the system supports spatial scene functionality. This implies that XrSystemSpatialSensingPropertiesBD::supportsSpatialSensing must also be XR_TRUE.

Note that supportsSpatialScene may be XR_TRUE even if running on an Android-based platform and the application does not have the required com.picovr.permission.SPATIAL_DATA permission both declared in the manifest and granted at runtime. Evaluation of permissions takes place later, in the asynchronous operation started by xrStartSenseDataProviderAsyncBD.

Valid Usage (Implicit)

See Also

XR_BD_spatial_scene, 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.