XRVisibilityState

The XRVisibilityState enumerated type defines the string values which are valid for the XRSession interface's visibilityState property, which indicates whether or not an XR session is currently visible to the user, and if it is, whether or not it's currently the primary focus.

Values

hidden
The virtual scene generated by the XRSession is not currently visible to the user, so its requestAnimationFrame() callbacks are not being executed until thevisibilityState changes. Input controllers are not being handled for the session.
visible
The virtual scene rendered by the XRSession is currently visible to the user and is the primary focus of the user's attention. To that end, the session's requestAnimationFrame() callbacks are being processed at the XR device's native refresh rate and input controllers are being processed as normal.
visible-blurred
While the virtual scene rendered by the XRSession may currently be visible to the user, it is not the user's primary focus at the moment; it's also possible the session is not currently visible at all. In order to optimize resource utilization, the user agent may be handling the session's requestAnimationFrame() callbacks at a throttled rate. Inut controllers are not being processed for the session.

Specifications

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

Browser compatibility

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

See also