VRDisplayEvent.VRDisplayEvent()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

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

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support[1] (Yes) 55 (55)[2] No support No support No support
Feature Android Edge Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android Samsung Internet for GearVR
Basic support No support No support 55.0 (55) No support No support No support (Yes)[3] (Yes)
 

[1] API Available on all platforms behind a flag, but currently only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays() is invoked).

[2] Currently only Windows support is enabled by default. Mac support is available in Firefox Nightly.

[3] Currently supported only by Google Daydream.

See also

Document Tags and Contributors

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