XREquirectLayer: upperVerticalAngle property

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

The upperVerticalAngle property of the XREquirectLayer interface represents the upper vertical angle in radians for the sphere.

Value

A number representing the upper vertical angle in radians for the sphere. Setting upperVerticalAngle to a value less than -π/2 will set it to -π/2 and setting it to a value higher than π/2 will set it to π/2.

Examples

Getting a layer's upper vertical angle

The XRWebGLBinding.createEquirectLayer() method creates an equirect layer and allows specifying a upperVerticalAngle. The XREquirectLayer.upperVerticalAngle property can be used after layer creation to get the upper vertical angle used or to set it to a new one.

js

const equirectLayer = xrGlBinding.createEquirectLayer({
  space: xrReferenceSpace,
  viewPixelWidth: 1200,
  viewPixelHeight: 600,
  centralHorizontalAngle: 2 * Math.PI,
  upperVerticalAngle: Math.PI / 2.0,
  lowerVerticalAngle: -Math.PI / 2.0,
  radius: 0,
});

equirectLayer.upperVerticalAngle; // 1.5707963267948966

Specifications

Specification
WebXR Layers API Level 1
# dom-xrequirectlayer-upperverticalangle

Browser compatibility

BCD tables only load in the browser

See also