XRHitTestResult: createAnchor() 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 createAnchor() method of the XRHitTestResult interface creates an XRAnchor from a hit test result that is attached to a real-world object.

Syntax

js
createAnchor()

Parameters

None.

Return value

A Promise resolving with an XRAnchor object.

Examples

Creating an anchor from a hit test result

The following example starts with an XRHitTestResult retrieved by calling XRFrame.getHitTestResults(). After calling createAnchor(), the Promise resolves with an XRAnchor to attach a virtual object to that location.

js
hitTestResult.createAnchor().then(
  (anchor) => {
    // add anchored objects to the scene
  },
  (error) => {
    console.error(`Could not create anchor: ${error}`);
  },
);

Specifications

Specification
WebXR Anchors Module
# dom-xrhittestresult-createanchor

Browser compatibility

BCD tables only load in the browser

See also