XRAnchor
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
Instance properties
XRAnchor.anchorSpace
Read only Experimental-
Returns an
XRSpace
object to locate the anchor relative to otherXRSpace
objects.
Instance methods
XRAnchor.delete()
Experimental-
Removes the anchor.
Examples
Requesting a session with anchors enabled
js
navigator.xr.requestSession("immersive-ar", {
requireFeatures: ["anchors"],
});
Adding anchors
You can use XRFrame.createAnchor()
to create 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
Specification |
---|
WebXR Anchors Module # xr-anchor |
Browser compatibility
BCD tables only load in the browser