XRSessionMode

The WebXR Device API's XRSessionMode enumerated type defines the string values used to identify the possible kinds of session mode that can be used.

Values

immersive-ar

The session's output will be given exclusive access to the immersive device, but the rendered content will be blended with the real-world environment. The session's environmentBlendMode indicates the method to be used to blend the content together.

Important: The immersive-ar mode is defined by the WebXR Augmented Reality Module, which is not yet stable and should not be used other than for testing and experimentation.

immersive-vr
Indicates that the rendered session will be displayed using an immersive XR device in VR mode; it is not intended to be overlaid or integrated into the surrounding environment. The environmentBlendMode is expected to be opaque if possible, but might be additive if the hardware requires it.
inline
The output is presented inline within the context of an element in a standard HTML document, rather than occupying the full visual space. Inline sessions can be presented in either mono or stereo mode, and may or may not have viewer tracking available. Inline sessions don't require special hardware and should be avalable on any user agent offering WebXR API support.

Usage notes

The XRSessionMode type indicates the values that can be specified when calling XR.isSessionSupported() to determine whether or not the specified session type is supported and available to be used, and by requestSession() to attempt to open a new WebXR session.

The immersive-ar mode supports all the same features and reference spaces that immersive-vr does, since both are immersive sessions. Browsers may support either or both of these modes, but if WebXR is available, the inline mode is always supported.

Specifications

Specification Status Comment
WebXR Device API
The definition of 'XRSessionMode' in that specification.
Working Draft Initial definition.
WebXR Augmented Reality Module
The definition of 'XRSessionMode: immersive-ar' in that specification.
Editor's Draft The immersive-ar value added

Browser compatibility

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