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

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support No Yes

555

606

No ? ?
VRDisplayEvent() constructor No Yes

555

606

No ? ?
display No15

555

606

No ? ?
reason No15

555

606

No ? ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No561 2 3 4 ? ? ? ?6.0
VRDisplayEvent() constructor No561 2 3 4 ? ? ? ?6.0
display No561 2 3 4 ? ? ? ?6.0
reason 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 60.

See also

Document Tags and Contributors

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