W3cubDocs

/Web APIs

XRFrame: createAnchor() method

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

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

js

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

js

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

Browser compatibility

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

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/XRFrame/createAnchor