XRHitTestSource.cancel()

The cancel() method of the XRHitTestSource interface unsubscribes a hit test.

Syntax

cancel()

Parameters

None.

Return value

Returns undefined.

Examples

Unsubscribe from hit test

The cancel() method unsubscribes from a hit test source. Since the XRHitTestSource object will no longer be usable, you can clean up and set it to null.

hitTestSource.cancel();
hitTestSource = null;

Specifications

Specification
WebXR Hit Test Module (WebXR Hit Test)
# dom-xrhittestsource-cancel

Browser compatibility

BCD tables only load in the browser