XRCylinderLayer: radius 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 radius property of the XRCylinderLayer interface represents the radius of the cylinder.

Value

A number representing the radius of the cylinder.

Examples

Getting a layer's radius

The XRWebGLBinding.createCylinderLayer() method creates a cylinder layer and allows to specify a radius. The XRCylinder.radius property can be used after layer creation to get the radius 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.radius; // 2

Specifications

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

Browser compatibility

BCD tables only load in the browser

See also