XRFrame.getHitTestResults()

The getHitTestResults() method of the XRFrame interface returns an array of XRHitTestResult objects containing hit test results for a given XRHitTestSource.

Syntax

getHitTestResults(hitTestSource)

Parameters

hitTestSource

An XRHitTestSource object that contains hit test subscriptions.

Return value

An array of XRHitTestResult objects.

Examples

Getting hit test results

To request a hit test source, start an XRSession with the hit-test session feature enabled. Next, request a the hit test source with XRSession.requestHitTestSource() and store it for later use in the frame loop. Finally, call getHitTestResults() to obtain the result.

const xrSession = navigator.xr.requestSession("immersive-ar", {
   requiredFeatures: ["local", "hit-test"]
});
let hitTestSource = null;
xrSession.requestHitTestSource({
  space : viewerSpace, // obtained from xrSession.requestReferenceSpace("viewer");
  offsetRay : new XRRay({y: 0.5})
}).then((viewerHitTestSource) => {
  hitTestSource = viewerHitTestSource;
});
// frame loop
function onXRFrame(time, xrFrame) {
  let hitTestResults = xrFrame.getHitTestResults(hitTestSource);
  // do things with the hit test results
}

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getHitTestResults
81
81
No
No
No
No
No
81
No
No
No
13.0

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/XRFrame/getHitTestResults