xrLocateHandJointsEXT(3)

C Specification

The xrLocateHandJointsEXT function locates an array of hand joints to a base space at given time.

// Provided by XR_EXT_hand_tracking
XrResult xrLocateHandJointsEXT(
    XrHandTrackerEXT                            handTracker,
    const XrHandJointsLocateInfoEXT*            locateInfo,
    XrHandJointLocationsEXT*                    locations);

Parameters

Parameter Descriptions

handTracker is an XrHandTrackerEXT previously created by xrCreateHandTrackerEXT.
locateInfo is a pointer to XrHandJointsLocateInfoEXT describing information to locate hand joints.
locations is a pointer to XrHandJointLocationsEXT receiving the returned hand joint locations.

Description

Valid Usage (Implicit)

The XR_EXT_hand_tracking extension must be enabled prior to calling xrLocateHandJointsEXT
handTracker must be a valid XrHandTrackerEXT handle
locateInfo must be a pointer to a valid XrHandJointsLocateInfoEXT structure
locations must be a pointer to an XrHandJointLocationsEXT 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_EXT_hand_tracking, XrHandJointLocationsEXT, XrHandJointsLocateInfoEXT, XrHandTrackerEXT

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.