xrCreateHandTrackerEXT - Create a hand joints handle.

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling createHandTrackerEXT

• session must be a valid Session handle
• createInfo must be a pointer to a valid HandTrackerCreateInfoEXT structure
• handTracker must be a pointer to an HandTrackerEXT handle

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_FUNCTION_UNSUPPORTED
• ERROR_FEATURE_UNSUPPORTED

If the system does not support hand tracking, runtime must return ERROR_FEATURE_UNSUPPORTED from createHandTrackerEXT. In this case, the runtime must return FALSE for supportsHandTracking in SystemHandTrackingPropertiesEXT when the function getSystemProperties is called, so that the application can avoid creating a hand tracker.

See Also

HandTrackerCreateInfoEXT, HandTrackerEXT, Session

A convenience wrapper to make a compatible pair of calls to createHandTrackerEXT and destroyHandTrackerEXT

To ensure that destroyHandTrackerEXT is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

xrDestroyHandTrackerEXT - Destroy a hand joints handle

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling destroyHandTrackerEXT

• handTracker must be a valid HandTrackerEXT handle

Thread Safety

• Access to handTracker, and any child handles, must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID
• ERROR_FUNCTION_UNSUPPORTED

See Also

HandTrackerEXT

xrLocateHandJointsEXT - Locate hand joint locations

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling locateHandJointsEXT

• handTracker must be a valid HandTrackerEXT handle
• locateInfo must be a pointer to a valid HandJointsLocateInfoEXT structure
• locations must be a pointer to an HandJointLocationsEXT structure

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_TIME_INVALID
• ERROR_FUNCTION_UNSUPPORTED

See Also

HandJointLocationsEXT, HandJointsLocateInfoEXT, HandTrackerEXT

XrSystemHandTrackingPropertiesEXT - System property for hand tracking

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using SystemHandTrackingPropertiesEXT

• type must be TYPE_SYSTEM_HAND_TRACKING_PROPERTIES_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain

If a runtime returns FALSE for supportsHandTracking, the runtime must return ERROR_FEATURE_UNSUPPORTED from createHandTrackerEXT.

See Also

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32, StructureType

XrHandTrackerCreateInfoEXT - Information to create a hand joints handle

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using HandTrackerCreateInfoEXT

• type must be TYPE_HAND_TRACKER_CREATE_INFO_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: HandPoseTypeInfoMSFT
• hand must be a valid HandEXT value
• handJointSet must be a valid HandJointSetEXT value

See Also

HandEXT, HandJointSetEXT, StructureType, createHandTrackerEXT

XrHandJointsLocateInfoEXT - Describes the information to locate hand joints

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using HandJointsLocateInfoEXT

• type must be TYPE_HAND_JOINTS_LOCATE_INFO_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• baseSpace must be a valid Space handle

See Also

Space, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, locateHandJointsEXT

XrHandJointLocationEXT - Describes the location and radius of a hand joint

Member Descriptions

Description

If the returned locationFlags has XR_SPACE_LOCATION_POSITION_VALID_BIT set, the returned radius must be a positive value.

If the returned locationFlags has XR_SPACE_LOCATION_POSITION_VALID_BIT unset, the returned radius value is undefined and should be avoided.

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using HandJointLocationEXT

• locationFlags must be a valid combination of XrSpaceLocationFlagBits values
• locationFlags must not be 0

See Also

HandJointLocationsEXT, Posef, SpaceLocationFlags

XrHandJointVelocityEXT - Describes the velocity of a hand joint

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using HandJointVelocityEXT

• velocityFlags must be a valid combination of XrSpaceVelocityFlagBits values
• velocityFlags must not be 0

See Also

HandJointVelocitiesEXT, SpaceVelocityFlags, Vector3f

XrHandJointLocationsEXT - Returns the hand joint locations

Member Descriptions

Description

The application must allocate the memory for the output array jointLocations that can contain at least jointCount of HandJointLocationEXT.

The application must set jointCount as described by the HandJointSetEXT when creating the HandTrackerEXT otherwise the runtime must return ERROR_VALIDATION_FAILURE.

The runtime must update the jointLocations array ordered so that the application can index elements using the corresponding hand joint enum (e.g. HandJointEXT) as described by HandJointSetEXT when creating the HandTrackerEXT. For example, when the HandTrackerEXT is created with HAND_JOINT_SET_DEFAULT_EXT, the application must set the jointCount to HAND_JOINT_COUNT_EXT, and the runtime must fill the jointLocations array ordered so that it may be indexed by the HandJointEXT enum.

If the returned isActive is true, the runtime must return all joint locations with both XR_SPACE_LOCATION_POSITION_VALID_BIT and XR_SPACE_LOCATION_ORIENTATION_VALID_BIT set. Although, in this case, some joint space locations may be untracked (i.e. XR_SPACE_LOCATION_POSITION_TRACKED_BIT or XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT is unset).

If the returned isActive is false, it indicates the hand tracker did not detect the hand input or the application lost input focus. In this case, the runtime must return all jointLocations with neither XR_SPACE_LOCATION_POSITION_VALID_BIT nor XR_SPACE_LOCATION_ORIENTATION_VALID_BIT set.

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using HandJointLocationsEXT

• type must be TYPE_HAND_JOINT_LOCATIONS_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: HandJointVelocitiesEXT
• jointLocations must be a pointer to an array of jointCount HandJointLocationEXT structures
• The jointCount parameter must be greater than 0

See Also

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32, HandJointLocationEXT, StructureType, locateHandJointsEXT

XrHandJointVelocitiesEXT - Returns the hand joint velocities

Member Descriptions

Description

The application must allocate the memory for the output array jointVelocities that can contain at least jointCount of HandJointVelocityEXT.

The application must input jointCount as described by the HandJointSetEXT when creating the HandTrackerEXT. Otherwise, the runtime must return ERROR_VALIDATION_FAILURE.

The runtime must update the jointVelocities array in the order so that the application can index elements using the corresponding hand joint enum (e.g. HandJointEXT) as described by the HandJointSetEXT when creating the HandTrackerEXT. For example, when the HandTrackerEXT is created with HAND_JOINT_SET_DEFAULT_EXT, the application must set the jointCount to HAND_JOINT_COUNT_EXT, and the returned jointVelocities array must be ordered to be indexed by enum HandJointEXT enum.

If the returned HandJointLocationsEXT::isActive is false, it indicates the hand tracker did not detect a hand input or the application lost input focus. In this case, the runtime must return all jointVelocities with neither XR_SPACE_VELOCITY_LINEAR_VALID_BIT nor XR_SPACE_VELOCITY_ANGULAR_VALID_BIT set.

If an HandJointVelocitiesEXT structure is chained to HandJointLocationsEXT::next, the returned HandJointLocationsEXT::isActive is true, and the velocity is observed or can be calculated by the runtime, the runtime must fill in the linear velocity of each hand joint within the reference frame of baseSpace and set the XR_SPACE_VELOCITY_LINEAR_VALID_BIT. Similarly, if an HandJointVelocitiesEXT structure is chained to HandJointLocationsEXT::next, the returned HandJointLocationsEXT::isActive is true, and the angular velocity is observed or can be calculated by the runtime, the runtime must fill in the angular velocity of each joint within the reference frame of baseSpace and set the XR_SPACE_VELOCITY_ANGULAR_VALID_BIT.

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using HandJointVelocitiesEXT

• type must be TYPE_HAND_JOINT_VELOCITIES_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• jointVelocities must be a pointer to an array of jointCount HandJointVelocityEXT structures
• The jointCount parameter must be greater than 0

See Also

HandJointLocationsEXT, HandJointVelocityEXT, StructureType

XrHandEXT - Describes which hand the tracker is tracking.

Enumerant Descriptions

See Also

HandTrackerCreateInfoEXT

XrHandJointEXT - The name of hand joints that can be tracked

See Also

No cross-references are available

XrHandJointSetEXT - The set of hand joints to track.

Enumerant Descriptions

See Also

HandTrackerCreateInfoEXT

XrHandTrackerEXT - Represents a tracker for a hand joints.

Description

An application creates separate HandTrackerEXT handles for left and right hands. This handle can be used to locate hand joints using locateHandJointsEXT function.

A hand tracker provides accurate fidelity to the user’s actual hand shape. When the hand tracking input requires the user to be holding a controller in their hand, the hand tracking input will appear as the user holding the controller. This input can be used to render the hand shape together with rendering the controller in the hand.

See Also

createHandMeshSpaceMSFT, createHandTrackerEXT, destroyHandTrackerEXT, locateHandJointsEXT, updateHandMeshMSFT

XR_HAND_JOINT_COUNT_EXT - The number of hand joint enums defined in XrHandJointEXT

Description

HAND_JOINT_COUNT_EXT defines the number of hand joint enumerants defined in HandJointEXT

See Also

HandJointEXT