VRDisplay: getLayers() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The getLayers() method of the 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

getLayers()

Parameters

None.

Return value

If the VRDisplay is presenting, this method returns an array of the VRLayerInit objects currently being presented (this will currently be one, as VRDisplayCapabilities.maxLayers is currently always 1). If the 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 [1].

Browser compatibility

BCD tables only load in the browser

See also