XRAnchor

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The XRAnchor interface creates anchors which keep track of the pose that is fixed relative to the real world. With anchors, you can specify poses in the world that need to be updated to correctly reflect the evolving understanding of the world, such that the poses remain aligned with the same place in the physical world. That helps to build an illusion that the placed objects are really present in the user’s environment.

Properties

XRAnchor.anchorSpace Read only

Returns an XRSpace object to locate the anchor relative to other XRSpace objects.

Methods

XRAnchor.delete()

Removes the anchor.

Examples

Requesting a session with anchors enabled

navigator.xr.requestSession("immersive-ar", {
  requireFeatures: ["anchors"],
}

Adding anchors

You can use XRFrame.createAnchor() to create 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 (WebXR Anchors)
# xr-anchor

Browser compatibility

BCD tables only load in the browser

See also