web api interface
XRTransientInputHitTestSource
Secure contextLimited availability
The XRTransientInputHitTestSource interface of the WebXR Device API handles transient input hit test subscriptions. You can get an XRTransientInputHitTestSource object by calling the 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 getHitTestResultsForTransientInput(), which returns XRTransientInputHitTestResult objects.
Instance properties
None.
Instance methods
cancel()Experimental- : Unsubscribes from the transient input hit test.
Examples
Getting an XRTransientInputHitTestSource object for a session
Use the requestHitTestSourceForTransientInput() method to get a transient input hit test source.
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 cancel() method. Since the object will no longer be usable, you can clean up and set the XRTransientInputHitTestSource object to null.
transientHitTestSource.cancel();
transientHitTestSource = null;