C Specification

The xrGetBodySkeletonHTC function is defined as:

// Provided by XR_HTC_body_tracking
XrResult xrGetBodySkeletonHTC(
    XrBodyTrackerHTC                            bodyTracker,
    XrSpace                                     baseSpace,
    uint32_t                                    skeletonGenerationId,
    XrBodySkeletonHTC*                          skeleton);

Parameters

Parameter Descriptions

  • bodyTracker is an XrBodyTrackerHTC previously created by xrCreateBodyTrackerHTC.

  • baseSpace is an XrSpace within which the returned body skeleton in T-pose will be represented.

  • skeletonGenerationId is the skeleton id of the skeleton.

  • skeleton is a pointer to XrBodySkeletonHTC receiving the returned body skeleton.

Description

The xrGetBodySkeletonHTC function returns the body skeleton in T-pose. This function can be used to get body skeleton and infer the skeleton scale and proportions in conjunction with XrBodyJointLocationsHTC::skeletonGenerationId. XrBodyJointLocationsHTC::skeletonGenerationId is generated when the tracking auto-calibrates the user skeleton scale and proportions.

If the application supplies a skeletonGenerationId that does not match any value returned in XrBodyJointLocationsHTC::skeletonGenerationId during the current session, 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

See Also

XR_HTC_body_tracking, XrBodySkeletonHTC, XrBodyTrackerHTC, XrSpace

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.