XREquirectLayer

{{securecontext_header}}{{APIRef("WebXR Device API")}}{{SeeCompatTable}}

The XREquirectLayer interface of the WebXR Device API is a layer that maps equirectangular coded data onto the inside of a sphere.

XREquirectLayer requires the layers feature to be enabled for the {{domxref("XRSession")}}. You can request it in {{domxref("XRSystem.requestSession()")}}.

To create a new XREquirectLayer, call either:

• {{domxref("XRWebGLBinding.createEquirectLayer()")}} for a WebGL opaque texture layer, or
• {{domxref("XRMediaBinding.createEquirectLayer()")}} for an HTML {{HTMLElement("video")}} playback layer.

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

{{InheritanceDiagram}}

Instance properties

Inherits properties from its parent, {{domxref("XRCompositionLayer")}}.

• {{domxref("XREquirectLayer.centralHorizontalAngle")}} {{Experimental_Inline}}
  • : A number indicating the central horizontal angle in radians for the sphere.
• {{domxref("XREquirectLayer.lowerVerticalAngle")}} {{Experimental_Inline}}
  • : A number indicating the lower vertical angle in radians for the sphere.
• {{domxref("XREquirectLayer.radius")}} {{Experimental_Inline}}
  • : A number indicating the radius of the sphere.
• {{domxref("XREquirectLayer.space")}} {{Experimental_Inline}}
  • : An {{domxref("XRSpace")}} representing the layer's spatial relationship with the user's physical environment.
• {{domxref("XREquirectLayer.transform")}} {{Experimental_Inline}}
  • : An {{domxref("XRRigidTransform")}} representing the offset and orientation relative to space.
• {{domxref("XREquirectLayer.upperVerticalAngle")}} {{Experimental_Inline}}
  • : A number indicating the upper vertical angle in radians for the sphere.

Instance methods

Inherits methods from its parents, {{domxref("XRCompositionLayer")}} and {{domxref("EventTarget")}}.

Events

• {{domxref("XREquirectLayer.redraw_event", "redraw")}} {{Experimental_Inline}}
  • : Sent to the XREquirectLayer 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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("XRLayer")}}
• {{domxref("EventTarget")}}
• {{domxref("XRCompositionLayer")}}
• {{domxref("XRCylinderLayer")}}
• {{domxref("XRCubeLayer")}}
• {{domxref("XRQuadLayer")}}
• {{domxref("XRProjectionLayer")}}