VRDisplay.requestPresent()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The requestPresent() method of the VRDisplay interface starts the VRDisplay presenting a scene.

Syntax

vrDisplayInstance.requestPresent(layers).then(function() {
  // Do something after the presentation has begun
});

Parameters

layers
An array of VRLayer objects representing the scene you want to present. At the moment, this can be a minimum of 0 and a maximum of 1.

Return value

A promise that resolves once the presentation has begun.

Note: If VRDisplayCapabilities.canPresent is false, or if the VRLayer array contains more than VRDisplayCapabilities.maxLayers layers, the promise will be rejected.

Note: If the VRDisplay is already presenting when requestPresent() is called, the VRDisplay will update the VRLayer array being presented. If a call to requestPresent() is rejected while the VRDisplay is already presenting, the VRDisplay will end its presentation.

Examples

TBD.

Specifications

Specification Status Comment
WebVR
The definition of 'requestPresent()' in that specification.
Editor's Draft Initial definition

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes) (Yes) No support No support No support
Feature Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support No support (Yes) No support No support No support No support

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills
 Last updated by: chrisdavidmills,