VRDisplay

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 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 Navigator.getVRDisplays() method.

Properties

VRDisplay.capabilities Read only

Returns a VRDisplayCapabilities object that indicates the various capabilities of the VRDisplay.

VRDisplay.depthFar

Gets and sets the z-depth defining the far plane of the eye view frustum, i.e. the furthest viewable boundary of the scene.

VRDisplay.depthNear

Gets and sets the z-depth defining the near plane of the eye view frustum, i.e. the nearest viewable boundary of the scene.

VRDisplay.displayId Read only

Returns an identifier for this particular VRDisplay, which is also used as an association point in the Gamepad API (see Gamepad.displayId).

VRDisplay.displayName Read only

Returns a human-readable name to identify the VRDisplay.

VRDisplay.hardwareUnitId

Returns a DOMString defining the shared ID of the display, and any other devices that are part of that hardware set (e.g. controllers). This is no longer needed, and has been removed from the spec. Displays now use VRDisplay.displayId, and corresponsing controllers will now return the same ID under Gamepad.displayId.

VRDisplay.isConnected Read only

Returns a boolean value indicating whether the VRDisplay is connected to the computer.

VRDisplay.isPresenting Read only

Returns a boolean value indicating whether the VRDisplay is currently having content presented through it.

VRDisplay.stageParameters Read only

Returns a VRStageParameters object containing room-scale parameters, if the VRDisplay is capable of supporting room-scale experiences.

Methods

VRDisplay.getEyeParameters()

Returns the VREyeParameters object containing the eye parameters for the specified eye.

VRDisplay.getFrameData()

Accepts a VRFrameData object and populates it with the information required to render the current frame.

VRDisplay.getImmediatePose()

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.

VRDisplay.getLayers()

Returns the layers currently being presented by the VRDisplay.

VRDisplay.getPose()

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 VRDisplay.getFrameData(), which also provides a VRPose object.

VRDisplay.resetPose()

Resets the pose for this VRDisplay, treating its current VRPose.position and VRPose.orientation as the "origin/zero" values.

VRDisplay.cancelAnimationFrame()

A special implementation of Window.cancelAnimationFrame that allows callbacks registered with VRDisplay.requestAnimationFrame() to be unregistered.

VRDisplay.requestAnimationFrame()

A special implementation of Window.requestAnimationFrame containing a callback function that will be called every time a new frame of the VRDisplay presentation is rendered.

VRDisplay.requestPresent()

Starts the VRDisplay presenting a scene.

VRDisplay.exitPresent()

Stops the VRDisplay presenting a scene.

VRDisplay.submitFrame()

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(function(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 [1].

Browser compatibility

BCD tables only load in the browser

See also