This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The reason
read-only property of the VRDisplayEvent
interface returns a human-readable reason why the event was fired.
var myReason = vrDisplayEventInstance.reason;
A string representing the reason why the event was fired. The available reasons are defined in the VRDisplayEventReason
enum, and are as follows:
mounted
— The VRDisplay
has detected that the user has put it on (or it has been otherwise activated).navigation
— The page has been navigated to from a context that allows this page to begin presenting immediately, such as from another site that was already in VR presentation mode.requested
— The user agent has requested that VR presentation mode be started. This allows user agents to include a consistent UI to enter VR across diferent sites.unmounted
— The VRDisplay
has detected that the user has taken it off (or it has been otherwise slept/put on standby).window.addEventListener('vrdisplaypresentchange', function(e) { console.log('Display ' + e.display.displayId + ' presentation has changed. Reason given: ' + e.reason + '.'); })
Specification | Status | Comment |
---|---|---|
WebVR 1.1 The definition of 'reason' in that specification. | Editor's Draft | Initial definition |
Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | Yes1 2 | Yes |
553 584 |
No | ? | ? |
Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
---|---|---|---|---|---|---|---|
Basic support | No | Yes5 | ? | ? | No | ? | ? |
1. Only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays()
is invoked).
2. This feature is behind the WebVR
preference. To change preferences in Chrome, visit chrome://flags.
3. Windows support was enabled in Firefox 55.
4. macOS support was enabled in Firefox 58.
5. Currently supported only by Google Daydream.
© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/VRDisplayEvent/reason