XRBoundedReferenceSpace
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.
Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.
TheWebXR Device API'sXRBoundedReferenceSpace interface describes a virtual worldreference space which has preset boundaries. This extendsXRReferenceSpace, which describes an essentially unrestricted space around the viewer's position. These bounds are defined using an array of points, each of which defines a vertex in a polygon inside which the user is allowed to move.
This is typically used when the XR system is capable of tracking the user's physical movement within a limited distance of their starting position. The specified bounds may, in fact, describe the shape and size of the room the user is located in, in order to let the WebXR site or application prevent the user from colliding with the walls or other obstacles in the real world. At a minimum, the boundaries indicate the area in which the XR device is capable of tracking the user's movement. See the articleUsing bounded reference spaces for details on how bounded spaces work and why they're useful.
In this article
Instance properties
In addition to the properties ofXRReferenceSpace,XRBoundedReferenceSpace includes the following:
boundsGeometryRead onlyExperimentalAn array of
DOMPointReadOnlyobjects, each of which defines a vertex in the polygon defining the boundaries within which the user will be required to remain. These verticesmust be sorted such that they moveclockwise around the viewer's position.
Instance methods
XRBoundedReferenceSpace inherits the methods of its parent interface,XRReferenceSpace. It has no further methods.
Specifications
| Specification |
|---|
| WebXR Device API> # xrboundedreferencespace-interface> |