VRDisplayEvent

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

The VRDisplayEvent interface of the WebVR API represents represents the event object of WebVR-related events (see the list of WebVR window extensions).

Constructor

VRDisplayEvent.VRDisplayEvent()
Creates a VRDisplayEvent object instance.

Properties

VRDisplayEvent also inherits properties from its parent object, Event.

VRDisplayEvent.display Read only
The VRDisplay associated with this event.
VRDisplayEvent.reason Read only
A human-readable reason why the event was fired.

Examples

window.addEventListener('vrdisplaypresentchange', function(e) {
  console.log('Display ' + e.display.displayId + ' presentation has changed. Reason given: ' + e.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 ? ?
VRDisplayEvent() constructor Yes1 2 Yes

553

584

No ? ?
display Yes1 2 Yes

553

584

No ? ?
reason Yes1 2 Yes

553

584

No ? ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidIE mobileOpera AndroidiOS Safari
Basic support No Yes5 ? ? No ? ?
VRDisplayEvent() constructor No Yes5 ? ? No ? ?
display No Yes5 ? ? No ? ?
reason 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,