Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The mode
property of the XRPermissionDescriptor
dictionary is a string taken from the XRSessionMode
enumerated type, specifying which Web XR session mode (inline
, immersive-vr
, or immersive-ar
) the described permissions will be used for.
Syntax
xrPermissionDescriptor = { mode: xrSessionMode, requiredFeatures: reqFeatureList, optionalFeatures: optFeatureList }; xrPermissionDescriptor.mode = xrSessionMode; xrMode = xrPermissionDescriptor.mode;
Value
A DOMString
whose value is one of the strings found in the XRSessionMode
enumerated type:
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 beopaque
if possible, but might beadditive
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
Examples
The example below checks to ensure that permission has been granted to allow the user to use WebXR for an immersive virtual reality experience. No specific features are specified during this query; see requiredFeatures
and optionalFeatures
for more information on specifying features during a WebXR permission check.
let xrPermissionDesc = {
name: "xr",
mode: "immersive-vr"
};
if (navigator.permissions) {
navigator.permissions.query(xrPermissionDesc).then(({state}) => {
switch(state) {
case "granted":
setupXR();
break;
case "prompt":
promptAndSetupXR();
break;
default:
/* do nothing otherwise */
break;
}
.catch(err) {
console.log(err);
}
} else {
setupXR();
}
Specifications
Specification | Status | Comment |
---|---|---|
WebXR Device APIThe definition of 'XRPermissionDescriptor.mode' in that specification. | Working Draft | Initial definition. |
Browser compatibility
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
mode
|
Chrome
No support No |
Edge
No support No |
Firefox
No support No |
IE
No support No |
Opera
No support No |
Safari
No support No |
WebView Android
No support No |
Chrome Android
No support No |
Firefox Android
No support No |
Opera Android
No support No |
Safari iOS
No support No |
Samsung Internet Android
No support No |
Legend
- No support
- No support
See also
- Permissions and security for WebXR
XRPermissionStatus
navigator.permissions
andWorkerNavigator.permissions
Permissions
XRPermissionDescriptor.mode by Mozilla Contributors is licensed under CC-BY-SA 2.5.