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 thecompatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

TheVRDisplay interface of theWebVR 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 oldWebVR API. It has been superseded by theWebXR Device API.

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

Instance properties

VRDisplay.capabilitiesRead onlyDeprecated Non-standard: Returns a VRDisplayCapabilities object that indicates the various capabilities of theVRDisplay.
VRDisplay.depthFarDeprecated Non-standard: 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.depthNearDeprecated Non-standard: 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.displayIdRead onlyDeprecated Non-standard: Returns an identifier for this particular VRDisplay, which is also used as an association point in the Gamepad API (seeGamepad.displayId).
VRDisplay.displayNameRead onlyDeprecated Non-standard: Returns a human-readable name to identify theVRDisplay.
VRDisplay.isConnectedRead onlyDeprecated Non-standard: Returns a boolean value indicating whether theVRDisplay is connected to the computer.
VRDisplay.isPresentingRead onlyDeprecated Non-standard: Returns a boolean value indicating whether theVRDisplay is currently having content presented through it.
VRDisplay.stageParametersRead onlyDeprecated Non-standard: Returns a VRStageParameters object containing room-scale parameters, if theVRDisplay is capable of supporting room-scale experiences.

Instance methods

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

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 atraw-webgl-example.

Specifications

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

Until all browsers have implemented the newWebXR APIs, it is recommended to rely on frameworks, likeA-Frame,Babylon.js, orThree.js, or apolyfill, to develop WebXR applications that will work across all browsers. ReadMeta's Porting from WebVR to WebXR guide for more information.

Browser compatibility

Help improve MDN

Learn how to contribute

This page was last modified on⁨Apr 3, 2025⁩ byMDN contributors.

View this page on GitHub •Report a problem with this content

Movatterモバイル変換