VRDisplayEvent.VRDisplayEvent()

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

The VRDisplayEvent constructor creates a VRDisplayEvent object instance.

Syntax

var myEventObject = new VRDisplayEvent(type, eventInitDict);

Parameters

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

Examples

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

Specifications

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

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support Yes1 2 Yes

553

584

No ? ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidIE mobileOpera AndroidiOS 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.

See also

Document Tags and Contributors

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