XRCubeLayer

Limited availability

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

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 XRCubeLayer interface of the WebXR Device API is a layer that renders directly from a cubemap and projects it onto the inside faces of a cube.

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

To create a new XRCubeLayer, call XRWebGLBinding.createCubeLayer().

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

EventTarget XRLayer XRCompositionLayer XRCubeLayer

Instance properties

Inherits properties from its parent, XRCompositionLayer.

XRCubeLayer.space Experimental

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

XRCubeLayer.orientation Experimental

A DOMPointReadOnly representing the orientation relative to the space property.

Instance methods

Inherits methods from its parents, XRCompositionLayer and EventTarget.

Events

redraw Experimental

Sent to the XRCubeLayer 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
# xcubelayertype

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
XRCubeLayer
Experimental
orientation
Experimental
redraw event
Experimental
space
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.

See also