VRDisplay.requestAnimationFrame()

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 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

JavaScript
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

JavaScript
TBD.

Specifications

Specification Status Comment
WebVR
The definition of 'requestAnimationFrame()' 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

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/vrdisplay/requestanimationframe

API Experimental Method Reference requestAnimationFrame() Virtual Reality VR VRDisplay WebVR