XRCylinderLayer: aspectRatio property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

The aspectRatio property of the XRCylinderLayer interface represents the ratio of the visible cylinder section. It is the ratio of the width of the visible section of the cylinder divided by its height. The width is calculated by multiplying the radius with the centralAngle.

Value

A number representing the ratio of the visible cylinder section.

Examples

Getting a layer's aspect ratio

The XRWebGLBinding.createCylinderLayer() method creates a cylinder layer and allows to specify an aspectRatio. The XRCylinder.aspectRatio property can be used after layer creation to get the aspect ratio used or to set it to a new one.

js
const cylinderLayer = xrGlBinding.createCylinderLayer({
  space: xrReferenceSpace,
  viewPixelWidth: 1200,
  viewPixelHeight: 600,
  centralAngle: (60 * Math.PI) / 180,
  aspectRatio: 2,
  radius: 2,
  transform: new XRRigidTransform(/* … */),
});

cylinderLayer.aspectRatio; // 2

Specifications

Specification
WebXR Layers API Level 1
# dom-xrcylinderlayer-aspectratio

Browser compatibility

BCD tables only load in the browser

See also