XRCylinderLayer

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

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

The XRCylinderLayer interface of the WebXR Device API is a layer that takes up a curved rectangular space in the virtual environment. Only the front of the layer is visible.

XRCylinderLayer requires the layers feature to be enabled for the XRSession. You can request it in XRSystem.requestSession().

To create a new XRCylinderLayer, call either:

To present layers to the XR device, add them to the layers render state using XRSession.updateRenderState().

EventTarget XRLayer XRCompositionLayer XRCylinderLayer

Instance properties

Inherits properties from its parent, XRCompositionLayer.

XRCylinderLayer.aspectRatio

A number indicating 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.

XRCylinderLayer.centralAngle

A number indicating the angle in radians of the visible section of the cylinder.

XRCylinderLayer.radius

A number indicating the radius of the cylinder.

XRCylinderLayer.space

An XRSpace representing the layer's spatial relationship with the user's physical environment.

XRCylinderLayer.transform

An XRRigidTransform representing the offset and orientation relative to space.

Instance methods

Inherits methods from its parents, XRCompositionLayer and EventTarget.

Events

redraw

Sent to the XRCylinderLayer object when the underlying resources of the layer are lost or when the XR Compositor can no longer reproject the layer. If this event is sent, authors should redraw the content of the layer in the next XR animation frame.

Specifications

Specification
WebXR Layers API Level 1
# xrcylinderayertype

Browser compatibility

BCD tables only load in the browser

See also