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.
Draft Initial definition

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome No support NoEdge Full support YesFirefox Full support 55
Notes
Full support 55
Notes
Notes Windows support was enabled in Firefox 55.
Full support 63
Notes
Notes macOS support was enabled in Firefox 63.
IE No support NoOpera ? Safari ? WebView Android No support NoChrome Android Full support 56
Notes Disabled
Full support 56
Notes Disabled
Notes Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
Notes Daydream View supported in Chrome 56.
Notes Google Cardboard supported in Chrome 57.
Disabled From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
Edge Mobile ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android Full support 6.0

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
See implementation notes.
See implementation notes.
User must explicitly enable this feature.
User must explicitly enable this feature.

See also

Document Tags and Contributors

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