xrLocateBodyJointsFB(3)

C Specification

The xrLocateBodyJointsFB function locates an array of body joints to a base space at a given time.

// Provided by XR_FB_body_tracking
XrResult xrLocateBodyJointsFB(
    XrBodyTrackerFB                             bodyTracker,
    const XrBodyJointsLocateInfoFB*             locateInfo,
    XrBodyJointLocationsFB*                     locations);

Parameters

Parameter Descriptions

bodyTracker is an XrBodyTrackerFB previously created by xrCreateBodyTrackerFB.
locateInfo is a pointer to XrBodyJointsLocateInfoFB describing information to locate body joints.
locations is a pointer to XrBodyJointLocationsFB receiving the returned body joint locations.

Description

Valid Usage (Implicit)

The XR_FB_body_tracking extension must be enabled prior to calling xrLocateBodyJointsFB
bodyTracker must be a valid XrBodyTrackerFB handle
locateInfo must be a pointer to a valid XrBodyJointsLocateInfoFB structure
locations must be a pointer to an XrBodyJointLocationsFB structure

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_TIME_INVALID

See Also

XR_FB_body_tracking, XrBodyJointLocationsFB, XrBodyJointsLocateInfoFB, XrBodyTrackerFB

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

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