OpenBuilds-CONTROL/app/lib/gamepad/doc/classes/AnimFrameUpdateStrategy.html

504 wiersze
10 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>AnimFrameUpdateStrategy - HTML5-JavaScript-Gamepad-Controller-Library</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="HTML5-JavaScript-Gamepad-Controller-Library"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.0.1</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/AnimFrameUpdateStrategy.html">AnimFrameUpdateStrategy</a></li>
<li><a href="../classes/FirefoxPlatform.html">FirefoxPlatform</a></li>
<li><a href="../classes/Gamepad.html">Gamepad</a></li>
<li><a href="../classes/ManualUpdateStrategy.html">ManualUpdateStrategy</a></li>
<li><a href="../classes/WebKitPlatform.html">WebKitPlatform</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Gamepad.html">Gamepad</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>AnimFrameUpdateStrategy Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/gamepad.js.html#l45"><code>gamepad.js:45</code></a>
</div>
Module: <a href="../modules/Gamepad.html">Gamepad</a>
</div>
<div class="box intro">
<p>This strategy uses a timer function to call an update function.
The timer (re)start function can be provided or the strategy reverts to
one of the window.*requestAnimationFrame variants.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_AnimFrameUpdateStrategy" class="method item">
<h3 class="name"><code>AnimFrameUpdateStrategy</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[requestAnimationFrame]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/gamepad.js.html#l45"><code>gamepad.js:45</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[requestAnimationFrame]</code>
<span class="type">Function</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>function to use for timer creation</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_start">start</a>
</li>
<li class="index-item method">
<a href="#method_startTicker">startTicker</a>
</li>
<li class="index-item method">
<a href="#method_tickFunction">tickFunction</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_start" class="method item">
<h3 class="name"><code>start</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>updateFunction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/gamepad.js.html#l82"><code>gamepad.js:82</code></a>
</p>
</div>
<div class="description">
<p>Starts the update strategy using the given function</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">updateFunction</code>
<span class="type">Function</span>
<div class="param-description">
<p>the function to call at each update</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_startTicker" class="method item">
<h3 class="name"><code>startTicker</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/gamepad.js.html#l73"><code>gamepad.js:73</code></a>
</p>
</div>
<div class="description">
<p>(Re)Starts the ticker</p>
</div>
</div>
<div id="method_tickFunction" class="method item">
<h3 class="name"><code>tickFunction</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/gamepad.js.html#l64"><code>gamepad.js:64</code></a>
</p>
</div>
<div class="description">
<p>This method calls the (user) update and restarts itself</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>