C Specification

The XrSystemDynamicObjectMousePropertiesBD structure is defined as:

// Provided by XR_BD_dynamic_object_mouse
typedef struct XrSystemDynamicObjectMousePropertiesBD {
    XrStructureType    type;
    void*              next;
    XrBool32           supportsDynamicObjectMouse;
} XrSystemDynamicObjectMousePropertiesBD;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

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

  • supportsDynamicObjectMouse is an XrBool32, with XR_TRUE indicating that the system supports tracking a computer mouse, and XR_FALSE indicating that the system does not support tracking a computer mouse.

Description

An application can inspect whether the system is capable of tracking a computer mouse by chaining an XrSystemDynamicObjectMousePropertiesBD structure to the XrSystemProperties::next chain when calling xrGetSystemProperties.

If XrSystemSpatialSensingPropertiesBD::supportsSpatialSensing is XR_FALSE or XrSystemDynamicObjectTrackingPropertiesBD::supportsDynamicObjectTracking is XR_FALSE, then supportsDynamicObjectMouse must also be XR_FALSE.

If a runtime returns XR_TRUE for supportsDynamicObjectMouse, the system supports dynamic computer mouse tracking. This implies that XrSystemDynamicObjectTrackingPropertiesBD::supportsDynamicObjectTracking and XrSystemSpatialSensingPropertiesBD::supportsSpatialSensing must also be XR_TRUE.

Note that supportsDynamicObjectMouse may be XR_TRUE, even if the application has not obtained the permission required by the system.

Evaluation of permissions takes place later, in the asynchronous operation started by xrStartSenseDataProviderAsyncBD.

Valid Usage (Implicit)

See Also

XR_BD_dynamic_object_mouse, 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-2026 The Khronos Group Inc.

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