W3cubDocs

/Web APIs

XRFrame: 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 XRFrame interface creates a free-floating XRAnchor which will be fixed relative to the real world.

See XRHitTestResult.createAnchor() for creating an anchor from a hit test result that is attached to a real-world object.

Syntax

createAnchor(pose, space)

Parameters

pose: An XRRigidTransform object with the initial pose where the anchor should be created. The system will make sure that the relationship with the physical world made at this moment in time is maintained as the tracking system's understanding of the world evolves.
space: An XRSpace object the pose is relative to.

Return value

A Promise resolving to an XRAnchor object.

Examples

Creating an anchor

frame.createAnchor(anchorPose, referenceSpace).then(
  (anchor) => {
    // Do stuff with the anchor (assign objects that will be relative to this anchor)
  },
  (error) => {
    console.error(`Could not create anchor: ${error}`);
  },
);

Specifications

Specification
WebXR Anchors Module> # dom-xrframe-createanchor>

Browser compatibility

	Desktop					Mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	WebView on iOS
`createAnchor`	85	85	No	71	No	85	No	60	No	14.0	No	No