XRReferenceSpaceType

Draft
This page is not complete.

The XRReferenceSpaceType enumerated type defines the strings which identify the types of reference spaces supported by WebXR. This type is used when calling the requestReferenceSpace() method to obtain a reference space for an XRSession.

Values

The reference space returned by XRSession.requestReferenceSpace() is either XRReferenceSpace or XRBoundedReferenceSpace. The "Interface" column in the table below indicates which of the two types is returned for each reference space type constant.

XRReferenceSpaceType Description Interface
bounded-floor Similar to the local type, except the user is not expected to move outside a predetermined boundary, given by the boundsGeometry in the returned object. XRBoundedReferenceSpace
local

A tracking space whose native origin is located near the viewer's position at the time the session was created. The exact position depends on the underlying platform and implementation. The user isn't expected to move much if at all beyond their starting position, and tracking is optimized for this use case.

For devices with six degrees of freedom (6DoF) tracking, the local reference space tries to keep the origin stable relative to the environment.

XRReferenceSpace
local-floor Similar to the local type, except the starting position is placed in a safe location for the viewer to stand, where the value of the y axis is 0 at floor level. If thet floor level isn't known, the user agent will estimate the floor level. If the estimated floor level is non-zero, the browser is expected to round it such a way as to avoid fingerprinting (likely to the nearest centimeter). XRReferenceSpace
unbounded A tracking space which allows the user total freedom of movement, possibly over extremely long distances from their origin point. The viewer isn't tracked at all; tracking is optimized for stability around the user's current position, so the native origin may drift as needed to accomodate that need. XRReferenceSpace
viewer A tracking space whose native origin tracks the viewer's position and orientation. This is used for environments in which the user can physically move around, and is supported by all instances of XRSession, both immersive and inline, though it's most useful for inline sessions. It's particularly useful when determining the distance between the viewer and an input, or when working with offset spaces. Otherwise, typically, one of the other reference space types will be used more often. XRReferenceSpace

Specifications

Specification Status Comment
WebXR Device API
The definition of 'XRReferenceSpaceType' in that specification.
Working Draft Initial definition.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

No compatibility data found. Please contribute data for "api.XRReferenceSpaceType" (depth: 1) to the MDN compatibility data repository.