blob: e8b189357343465785d29a41865a69de95d532f0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
---
title: VRDisplay.requestAnimationFrame()
slug: Web/API/VRDisplay/requestAnimationFrame
translation_of: Web/API/VRDisplay/requestAnimationFrame
---
<div>{{APIRef("WebVR API")}}{{SeeCompatTable}}</div>
<p>The <code><strong>requestAnimationFrame()</strong></code> method of the {{domxref("VRDisplay")}} interface is a special implementation of {{domxref("Window.requestAnimationFrame")}} containing a callback function that will be called every time a new frame of the <code>VRDisplay</code> presentation is rendered:</p>
<ul>
<li>When the <code>VRDisplay</code> is not presenting a scene, this is functionally equivalent to {{domxref("Window.requestAnimationFrame")}}.</li>
<li>When the VRDisplay is presenting, the callback is called at the native refresh rate of the <code>VRDisplay</code>.</li>
</ul>
<h2 id="Syntax">Syntax</h2>
<pre class="brush: js">var handle = vrDisplayInstance.requestAnimationFrame(<em>callback</em>);
</pre>
<h3 id="Parameters">Parameters</h3>
<dl>
<dt>callback</dt>
<dd>A callback function that will be called every time a new frame of the <code>VRDisplay</code> presentation is rendered.</dd>
</dl>
<h3 id="Return_value">Return value</h3>
<p>A long representing the handle of the <code>requestAnimationFrame()</code> call. This can then be passed to a {{domxref("VRDisplay.cancelAnimationFrame()")}} call to unregister the callback.</p>
<h2 id="Examples">Examples</h2>
<pre>TBD.</pre>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('WebVR', '#dom-vrdisplay-requestanimationframe', 'requestAnimationFrame()')}}</td>
<td>{{Spec2('WebVR')}}</td>
<td>Initial definition</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility">Browser compatibility</h2>
{{Compat("api.VRDisplay.requestAnimationFrame")}}
<h2 id="See_also">See also</h2>
<ul>
<li><a href="/en-US/docs/Web/API/WebVR_API">WebVR API homepage</a>.</li>
<li><a href="http://mozvr.com/">MozVr.com</a> — demos, downloads, and other resources from the Mozilla VR team.</li>
</ul>
|