This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The VRDisplayEvent constructor creates a VRDisplayEvent object instance.


var myEventObject = new VRDisplayEvent(type, eventInitDict);


A DOMString describing the type of event object you want to create.
A object contaning initialization options to use when creating the constructor. These are:
A property containing the VRDisplay the event is to be associated with.
A property containing a string representing the human-readable reason why the event is to be fired (see VRDisplayEvent.reason).


var myEventObject = new VRDisplayEvent('custom', {
  display: vrDisplay,
  reason: 'Custom reason'


Specification Status Comment
WebVR 1.1
The definition of 'VRDisplayEvent()' in that specification.
Draft Initial definition

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support No Yes



No ? ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No561 2 3 4 ? ? ? ?6.0

1. Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)

2. Daydream View supported in Chrome 56.

3. Google Cardboard supported in Chrome 57.

4. From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.

5. Windows support was enabled in Firefox 55.

6. macOS support was enabled in Firefox 63.

See also

Document Tags and Contributors

Contributors to this page: jpmedley, fscholz, chrisdavidmills
Last updated by: jpmedley,