XRCylinderLayer.aspectRatio

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.

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

No specification found

No specification data found for api.XRCylinderLayer.aspectRatio.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

Browser compatibility

No compatibility data found for api.XRCylinderLayer.aspectRatio.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.