XRHitTestResult: getPose() 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 getPose() method of the XRHitTestResult interface returns the XRPose of the hit test result relative to the given base space.

Syntax

js
getPose(baseSpace)

Parameters

baseSpace

An XRSpace to use as the base or origin for computing the relative position and orientation of hit test results.

Return value

Returns an XRPose object.

Examples

Getting the hit test result's pose

The following example uses getPose() to query a single hit test result's pose.

js
let hitTestResults = xrFrame.getHitTestResults(hitTestSource);

if (hitTestResults.length > 0) {
  let pose = hitTestResults[0].getPose(referenceSpace);
}

Specifications

Specification
WebXR Hit Test Module
# dom-xrhittestresult-getpose

Browser compatibility

BCD tables only load in the browser

See also