XRTransientInputHitTestSource

Limited availability

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

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

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

The XRTransientInputHitTestSource interface of the WebXR Device API handles transient input hit test subscriptions. You can get an XRTransientInputHitTestSource object by calling the XRSession.requestHitTestSourceForTransientInput().

This object doesn't itself contain transient input hit test results, but it is used to compute hit tests for each XRFrame by calling XRFrame.getHitTestResultsForTransientInput(), which returns XRTransientInputHitTestResult objects.

Instance properties

None.

Instance methods

XRTransientInputHitTestSource.cancel()

Unsubscribes from the transient input hit test.

Examples

Getting an XRTransientInputHitTestSource object for a session

Use the XRSession.requestHitTestSourceForTransientInput() method to get a transient input hit test source.

js
const xrSession = navigator.xr.requestSession("immersive-ar", {
  requiredFeatures: ["local", "hit-test"],
});

let transientHitTestSource = null;

xrSession
  .requestHitTestSourceForTransientInput({
    profile: "generic-touchscreen",
    offsetRay: new XRRay(),
  })
  .then((touchScreenHitTestSource) => {
    transientHitTestSource = touchScreenHitTestSource;
  });

// frame loop
function onXRFrame(time, xrFrame) {
  let hitTestResults = xrFrame.getHitTestResultsForTransientInput(
    transientHitTestSource,
  );

  // do things with the transient hit test results
}

Unsubscribe from a transient input hit test

To unsubscribe from a transient input hit test source, use the XRTransientInputHitTestSource.cancel() method. Since the object will no longer be usable, you can clean up and set the XRTransientInputHitTestSource object to null.

js
transientHitTestSource.cancel();
transientHitTestSource = null;

Specifications

Specification
WebXR Hit Test Module
# transient-input-hit-test-source-interface

Browser compatibility

BCD tables only load in the browser

See also