HMDVRDevice

Obsolete
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

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 HMDVRDevice interface of the WebVR API represents a head mounted display, providing access to information about each eye, and allowing us to modify the current field of view.

Methods

HMDVRDevice.getEyeParameters()
Returns current parameters for the eye specified as its argument ("left" or "right") — such as field of view information — stored in a VREyeParameters object.
HMDVRDevice.setFieldOfView()
Sets the field of view for both eyes.

Properties

This interface doesn't define any properties of its own, but it does inherit the properties of its parent interface, VRDevice.

VRDevice.hardwareUnitId Read only
Returns the distinct hardware ID for the overall hardware unit that this VRDevice is a part of. All devices that are part of the same physical piece of hardware will have the same hardwareUnitId.
VRDevice.deviceId Read only
Returns the ID for this specific VRDevice. The ID shouldn’t change across browser restarts, allowing configuration data to be saved based on it.
VRDevice.deviceName Read only
A human-readable name to identify the VRDevice.

Examples

The following example, taken from the WebVR spec, finds the first available HMDVRDevice and its associated PositionSensorVRDevice, if it has one.

navigator.getVRDevices().then(function(devices) {
  for (var i = 0; i < devices.length; ++i) {
    if (devices[i] instanceof HMDVRDevice) {
      gHMD = devices[i];
      break;
    }
  }

  if (gHMD) {
    for (var i = 0; i < devices.length; ++i) {
      if (devices[i] instanceof PositionSensorVRDevice && devices[i].hardwareUnitId === gHMD.hardwareUnitId) {
        gPositionSensor = devices[i];
        break;
      }
    }
  }
});

Specifications

Specification Status Comment
WebVR
The definition of 'HMDVRDevice' in that specification.
Editor's Draft Initial definition

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes)[1] 39 (39)[2] No support No support No support
Feature Android Firefox Mobile (Gecko) Firefox OS (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support No support 39.0 (39)[2]
44.0 (44)[3]
No support No support No support No support No support
  • [1] The support in Chrome is currently experimental. To find information on Chrome's WebVR implementation status including supporting builds, check out Bringing VR to Chrome by Brandon Jones.
  • [2] The support for this feature is currently disabled by default in Firefox. To enable WebVR support in Firefox Nightly/Developer Edition, you can go to about:config and enable the dom.vr* prefs. A better option however is to install the WebVR Enabler Add-on, which does this for you and sets up other necessary parts of the environment.
  • [3] The dom.vr* prefs are enabled by default at this point, in Nightly/Aurora editions.

See also

Document Tags and Contributors

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