VRDisplayEvent.VRDisplayEvent()

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

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 containing 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

BCD tables only load in the browser

See also