XRQuadLayer

Secure contextLimited availability

The XRQuadLayer interface of the WebXR Device API is a layer that takes up a flat rectangular space in the virtual environment. An XRQuadLayer has no thickness. It is a two-dimensional object positioned and oriented in 3D space. The position of a quad refers to the center of the quad. Only the front of the layer is visible.

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

To create a new XRQuadLayer, call either:

• createQuadLayer() for a WebGL opaque texture quad layer, or
• createQuadLayer() for an HTML <video> playback quad layer.

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

Instance properties

Inherits properties from its parent, XRCompositionLayer.

• height Experimental
  • : Represents the height of the layer in meters.
• space Experimental
  • : An XRSpace representing the layer’s spatial relationship with the user’s physical environment.
• transform Experimental
  • : An XRRigidTransform representing the offset and orientation relative to space.
• width Experimental
  • : Represents the width of the layer in meters.

Instance methods

Inherits methods from its parents, XRCompositionLayer and EventTarget.

Events

• redraw Experimental
  • : Sent to the XRQuadLayer 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

Browser compatibility

See also

• XRLayer
• EventTarget
• XRCompositionLayer
• XREquirectLayer
• XRCubeLayer
• XRCylinderLayer
• XRProjectionLayer