VRDisplay

The VRDisplay interface of the WebVR API represents any VR device supported by this API. It includes generic information such as device IDs and descriptions, as well as methods for starting to present a VR scene, retrieving eye parameters and display capabilities, and other important functionality.

[!NOTE] This interface was part of the old WebVR API. It has been superseded by the WebXR Device API.

An array of all connected VR Devices can be returned by invoking the getVRDisplays() method.

Instance properties

• capabilities Read only Deprecated
  • : Returns a VRDisplayCapabilities object that indicates the various capabilities of the VRDisplay.
• depthFar Deprecated
  • : Gets and sets the z-depth defining the far plane of the eye view frustum, i.e., the furthest viewable boundary of the scene.
• depthNear Deprecated
  • : Gets and sets the z-depth defining the near plane of the eye view frustum, i.e., the nearest viewable boundary of the scene.
• displayId Read only Deprecated
  • : Returns an identifier for this particular VRDisplay, which is also used as an association point in the Gamepad API (see displayId).
• displayName Read only Deprecated
  • : Returns a human-readable name to identify the VRDisplay.
• isConnected Read only Deprecated
  • : Returns a boolean value indicating whether the VRDisplay is connected to the computer.
• isPresenting Read only Deprecated
  • : Returns a boolean value indicating whether the VRDisplay is currently having content presented through it.
• stageParameters Read only Deprecated
  • : Returns a VRStageParameters object containing room-scale parameters, if the VRDisplay is capable of supporting room-scale experiences.

Instance methods

• getEyeParameters() Deprecated
  • : Returns the VREyeParameters object containing the eye parameters for the specified eye.
• getFrameData() Deprecated
  • : Accepts a VRFrameData object and populates it with the information required to render the current frame.
• getImmediatePose() Deprecated
  • : Returns a VRPose object defining the current pose of the VRDisplay, with no prediction applied. This is no longer needed, and has been removed from the spec.
• getLayers() Deprecated
  • : Returns the layers currently being presented by the VRDisplay.
• getPose() Deprecated
  • : Returns a VRPose object defining the future predicted pose of the VRDisplay as it will be when the current frame is actually presented. This method is deprecated — instead, you should use getFrameData(), which also provides a VRPose object.
• resetPose() Deprecated
  • : Resets the pose for this VRDisplay, treating its current position and orientation as the “origin/zero” values.
• cancelAnimationFrame() Deprecated
  • : A special implementation of cancelAnimationFrame that allows callbacks registered with requestAnimationFrame() to be unregistered.
• requestAnimationFrame() Deprecated
  • : A special implementation of requestAnimationFrame containing a callback function that will be called every time a new frame of the VRDisplay presentation is rendered.
• requestPresent() Deprecated
  • : Starts the VRDisplay presenting a scene.
• exitPresent() Deprecated
  • : Stops the VRDisplay presenting a scene.
• submitFrame() Deprecated
  • : Captures the current state of the VRLayerInit currently being presented and displays it on the VRDisplay.

Examples

if (navigator.getVRDisplays) {
  console.log("WebVR 1.1 supported");
  // Then get the displays attached to the computer
  navigator.getVRDisplays().then((displays) => {
    // If a display is available, use it to present the scene
    if (displays.length > 0) {
      vrDisplay = displays[0];
      // Now we have our VRDisplay object and can do what we want with it
    }
  });
}

[!NOTE] You can see this complete code at raw-webgl-example.

Specifications

This interface was part of the old WebVR API that has been superseded by the WebXR Device API. It is no longer on track to becoming a standard.

Until all browsers have implemented the new WebXR APIs, it is recommended to rely on frameworks, like A-Frame, Babylon.js, or Three.js, or a polyfill, to develop WebXR applications that will work across all browsers. Read Meta’s Porting from WebVR to WebXR guide for more information.

Browser compatibility

See also

• WebVR API