C Specification

The XrSystemSpatialPlanePropertiesBD structure is defined as:

// Provided by XR_BD_spatial_plane
typedef struct XrSystemSpatialPlanePropertiesBD {
    XrStructureType    type;
    void*              next;
    XrBool32           supportsSpatialPlane;
} XrSystemSpatialPlanePropertiesBD;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

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

  • supportsSpatialPlane is an XrBool32, indicating if the current system is capable of spatial plane functionality.

Description

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

If a runtime returns XR_FALSE for supportsSpatialPlane, the system does not support spatial plane functionality, and the runtime must return XR_ERROR_FEATURE_UNSUPPORTED from xrCreateSenseDataProviderBD when called with XR_SENSE_DATA_PROVIDER_TYPE_PLANE_BD.

The application should avoid using spatial plane functionality when supportsSpatialPlane is XR_FALSE.

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

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

Note that supportsSpatialPlane 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_plane, 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.