Back to Content

VRDisplay: getLayers() method

files/en-us/web/api/vrdisplay/getlayers/index.md

latest1.8 KB
Original Source

{{APIRef("WebVR API")}}{{Deprecated_Header}}{{Non-standard_Header}}

The getLayers() method of the {{domxref("VRDisplay")}} interface returns the layers currently being presented by the VRDisplay.

[!NOTE] This method was part of the old WebVR API. It has been superseded by the WebXR Device API.

Syntax

js-nolint
getLayers()

Parameters

None.

Return value

If the {{domxref("VRDisplay")}} is presenting, this method returns an array of the {{domxref("VRLayerInit")}} objects currently being presented (this will currently be one, as {{domxref("VRDisplayCapabilities.maxLayers")}} is currently always 1). If the {{domxref("VRDisplay")}} is not presenting, this method returns an empty array.

Examples

See VRLayerInit for example code.

Specifications

This method was part of the old WebVR API that has been superseded by the WebXR Device API. It is no longer on track to becoming a standard.

Until all browsers have implemented the new WebXR APIs, it is recommended to rely on frameworks, like A-Frame, Babylon.js, or Three.js, or a polyfill, to develop WebXR applications that will work across all browsers. Read Meta's Porting from WebVR to WebXR guide for more information.

Browser compatibility

{{Compat}}

See also