C Specification

The xrCreateBodyTrackerBD function is defined as:

// Provided by XR_BD_body_tracking
XrResult xrCreateBodyTrackerBD(
    XrSession                                   session,
    const XrBodyTrackerCreateInfoBD*            createInfo,
    XrBodyTrackerBD*                            bodyTracker);

Parameters

Parameter Descriptions

Description

An application can create an XrBodyTrackerBD handle using xrCreateBodyTrackerBD function.

If the system does not support body tracking, the runtime must return XR_ERROR_FEATURE_UNSUPPORTED from xrCreateBodyTrackerBD. In this case, the runtime must return XR_FALSE for XrSystemBodyTrackingPropertiesBD::supportsBodyTracking when the function xrGetSystemProperties is called, so that the application avoids creating a body tracker.

If an invalid value of XrBodyTrackerCreateInfoBD::jointSet is passed in createInfo, the runtime must return XR_ERROR_VALIDATION_FAILURE.

Valid Usage (Implicit)
Return Codes
On success, this command returns

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_VALIDATION_FAILURE

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_OUT_OF_MEMORY

  • XR_ERROR_LIMIT_REACHED

  • XR_ERROR_FEATURE_UNSUPPORTED

See Also

XR_BD_body_tracking, XrBodyTrackerBD, XrBodyTrackerCreateInfoBD, XrSession

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.