XRFrame: getJointPose() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The getJointPose() method of the XRFrame interface returns an XRJointPose object providing the pose of a hand joint (see XRHand) relative to a given base space.

Syntax

js
getJointPose(joint, baseSpace)

Parameters

joint

An XRJointSpace specifying the hand joint space for which to obtain an XRJointPose describing the item's position and orientation.

baseSpace

An XRSpace to use as the base or origin for the relative position and orientation.

Return value

An XRJointPose object specifying the position and orientation of the hand joint, relative to the XRSpace indicated by baseSpace.

Examples

Using getJointPose()

Call getJointPose() with an XRJointSpace and an XRReferenceSpace to get an XRJointPose object.

js
navigator.xr
  .requestSession({ optionalFeatures: ["hand-tracking"] })
  .then(/* … */);

function renderFrame(session, frame) {
  // …

  for (const inputSource of session.inputSources) {
    if (inputSource.hand) {
      const indexFingerTipJoint = inputSource.hand.get("index-finger-tip");
      frame.getJointPose(indexFingerTipJoint, referenceSpace); // XRJointPose
    }
  }
}

Specifications

Specification
WebXR Hand Input Module - Level 1
# dom-xrframe-getjointpose

Browser compatibility

BCD tables only load in the browser

See also