HMDVRDevice.setFieldOfView()

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.

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The setFieldOfView() method of the HMDVRDevice interface can be used to set the field of view for one eye, or both eyes simultaneously.

Syntax

HMDVRDevice.setFieldOfView(leftFOV,rightFOV,zNear,zFar);

Parameters

leftFOV Optional
A VRFieldOfView object that defines the new field of view for the left eye. If not specified, the left eye field of view does not change.
rightFOV Optional
A VRFieldOfView object that defines the new field of view for the right eye. If not specified, the right eye field of view does not change.
zNear Optional
The distance from the eyes of the nearest point of the view. The closest things can be and still be in the view. If not specified, the default is used — 0.01.
zFar Optional
The distance from the eyes of the farthest point of the view. The furthest away things can be and still be in the view. If not specified, the default is used — 10000.0.

Returns

Void.

Examples

The following simple example shows a function that can be used to set a custom field of view with four specified degree values for up, right, down and left. The VRFieldOfView() constructor is used to create a VRFieldOfView object from the supplied values, which is then fed into the setFieldOfView() method (the default zNear and zFar values are always used, in this case.)

function setCustomFOV(up,right,down,left) {
  var testFOV = new VRFieldOfView(up,right,down,left);

  gHMD.setFieldOfView(testFOV,testFOV,0.01,10000.0);

  var lEye = gHMD.getEyeParameters('left');
  var rEye = gHMD.getEyeParameters('right');
  console.log(lEye.currentFieldOfView);
  console.log(rEye.currentFieldOfView);
}

Note: When testing, setting a weird/tiny field of view can really mess up your view. It is a good idea to grab the current field of view first (using VREyeParameters.currentFieldOfView) before making any drastic changes, so you can reset it afterwards if needed.

Browser compatibility

BCD tables only load in the browser

See also