XRPermissionStatus.granted

Secure context

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

Draft

This page is not complete.

The WebXR Device API's XRPermissionStatus interface's granted property is an array of strings, each identifying one of the WebXR features for which permission has been granted as of the time at which the Permission API's navigator.permissions.query() method was called.

Syntax

grantedFeatures = xrPermissionStatus.granted;

Value

An array of DOMString objects, each identifying a single WebXR feature which the app or site has been granted permission to use. Currently, all of these strings come from the XRReferenceSpaceType enumerated type.

The types of reference space are listed in the table below, with brief information about their use cases and which interface is used to implement them.

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 that 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 accommodate 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

Usage notes

Examples

Specifications

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

Browser compatibility

BCD tables only load in the browser

See also