VRDisplay.requestAnimationFrame

The requestAnimationFrame() method of the VRDisplay interface is a special implementation of Window.requestAnimationFrame containing a callback function that will be called every time a new frame of the VRDisplay presentation is rendered:

• When the VRDisplay is not presenting a scene, this is functionally equivalent to Window.requestAnimationFrame.
• When the VRDisplay is presenting, the callback is called at the native refresh rate of the VRDisplay.

Syntax

var handle = vrDisplayInstance.requestAnimationFrame(callback);

Parameters

callback

A callback function that will be called every time a new frame of the VRDisplay presentation is rendered.

Return value

A long representing the handle of the requestAnimationFrame() call. This can then be passed to a VRDisplay.cancelAnimationFrame() call to unregister the callback.

Examples

TBD.

Specifications

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

Browser compatibility

See also

• WebVR API homepage.
• MozVr.com — demos, downloads, and other resources from the Mozilla VR team.