MDN self-hosted library · e01.org

HMDVRDevice

WebVR API

WebVR API

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.

Instance properties

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

  • VRDisplay.hardwareUnitId
  • : 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.
  • VRDisplay.displayId
  • : Returns the ID for this specific VRDevice. The ID shouldn't change across browser restarts, allowing configuration data to be saved based on it.
  • VRDisplay.displayName
  • : A human-readable name to identify the VRDevice.

Instance 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.

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((devices) => {
  for (const device of devices) {
    if (device instanceof HMDVRDevice) {
      gHMD = device;
      break;
    }
  }

  if (gHMD) {
    for (const device of devices) {
      if (
        device instanceof PositionSensorVRDevice &&
        device.hardwareUnitId === gHMD.hardwareUnitId
      ) {
        gPositionSensor = devices[i];
        break;
      }
    }
  }
});

Browser compatibility

See also