wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-12 12:20:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation.

Browse Source
This commit is contained in:
photonstorm
2013-11-28 15:57:09 +00:00
parent 8da9b67c18
commit f22159e257
193 changed files with 68905 additions and 93104 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Phaser.Device.html
+510 -50
View File
@@ -54,6 +54,10 @@
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li>
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
@@ -138,6 +142,10 @@
<a href="Phaser.Events.html">Events</a>
</li>
<li>
<a href="Phaser.Filter.html">Filter</a>
</li>
<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
@@ -302,6 +310,26 @@
<a href="Phaser.Text.html">Text</a>
</li>
<li>
<a href="Phaser.Tile.html">Tile</a>
</li>
<li>
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li>
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li>
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li>
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
@@ -310,6 +338,10 @@
<a href="Phaser.Time.html">Time</a>
</li>
<li>
<a href="Phaser.Timer.html">Timer</a>
</li>
<li>
<a href="Phaser.Touch.html">Touch</a>
</li>
@@ -356,6 +388,14 @@
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
</li>
<li>
<a href="global.html#render">render</a>
</li>
<li>
<a href="global.html#renderXY">renderXY</a>
</li>
<li>
<a href="global.html#right">right</a>
</li>
@@ -570,7 +610,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-41">line 41</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-47">line 47</a>
</li></ul></dd>
@@ -643,7 +683,7 @@
<td class="description last"><p>Is running in arora?</p></td>
<td class="description last"><p>Set to true if running in Arora.</p></td>
</tr>
@@ -675,7 +715,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-135">line 135</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-147">line 147</a>
</li></ul></dd>
@@ -780,7 +820,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-198">line 198</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-215">line 215</a>
</li></ul></dd>
@@ -885,7 +925,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-73">line 73</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-79">line 79</a>
</li></ul></dd>
@@ -958,7 +998,7 @@
<td class="description last"><p>Is running in chrome?</p></td>
<td class="description last"><p>Set to true if running in Chrome.</p></td>
</tr>
@@ -990,7 +1030,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-141">line 141</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-153">line 153</a>
</li></ul></dd>
@@ -1095,7 +1135,112 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-47">line 47</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-53">line 53</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="cocoonJS"><span class="type-signature"></span>cocoonJS<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cocoonJS</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Is the game running under CocoonJS?</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-41">line 41</a>
</li></ul></dd>
@@ -1200,7 +1345,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-121">line 121</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-127">line 127</a>
</li></ul></dd>
@@ -1378,7 +1523,7 @@
<td class="description last"><p>Is running in epiphany?</p></td>
<td class="description last"><p>Set to true if running in Epiphany.</p></td>
</tr>
@@ -1410,7 +1555,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-147">line 147</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-159">line 159</a>
</li></ul></dd>
@@ -1515,7 +1660,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-79">line 79</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-85">line 85</a>
</li></ul></dd>
@@ -1620,7 +1765,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-85">line 85</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-91">line 91</a>
</li></ul></dd>
@@ -1693,7 +1838,7 @@
<td class="description last"><p>Is running in firefox?</p></td>
<td class="description last"><p>Set to true if running in Firefox.</p></td>
</tr>
@@ -1725,7 +1870,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-153">line 153</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-165">line 165</a>
</li></ul></dd>
@@ -1798,7 +1943,7 @@
<td class="description last"><p>Is running in ie?</p></td>
<td class="description last"><p>Set to true if running in Internet Explorer.</p></td>
</tr>
@@ -1830,7 +1975,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-159">line 159</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-171">line 171</a>
</li></ul></dd>
@@ -1903,7 +2048,7 @@
<td class="description last"><p>Version of ie?</p></td>
<td class="description last"><p>If running in Internet Explorer this will contain the major version number.</p></td>
</tr>
@@ -1935,7 +2080,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-165">line 165</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-177">line 177</a>
</li></ul></dd>
@@ -2145,7 +2290,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-260">line 260</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-278">line 278</a>
</li></ul></dd>
@@ -2250,7 +2395,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-248">line 248</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-266">line 266</a>
</li></ul></dd>
@@ -2355,7 +2500,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-254">line 254</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-272">line 272</a>
</li></ul></dd>
@@ -2460,7 +2605,112 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-53">line 53</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-59">line 59</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="littleEndian"><span class="type-signature"></span>littleEndian<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>littleEndian</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Is the device big or little endian? (only detected if the browser supports TypedArrays)</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-290">line 290</a>
</li></ul></dd>
@@ -2565,7 +2815,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-91">line 91</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-97">line 97</a>
</li></ul></dd>
@@ -2674,7 +2924,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-234">line 234</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-252">line 252</a>
</li></ul></dd>
@@ -2779,7 +3029,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-59">line 59</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-65">line 65</a>
</li></ul></dd>
@@ -2852,7 +3102,7 @@
<td class="description last"><p>Is running in midori?</p></td>
<td class="description last"><p>Set to true if running in Midori.</p></td>
</tr>
@@ -2884,7 +3134,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-177">line 177</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-189">line 189</a>
</li></ul></dd>
@@ -2957,7 +3207,7 @@
<td class="description last"><p>Is running in mobileSafari?</p></td>
<td class="description last"><p>Set to true if running in Mobile Safari.</p></td>
</tr>
@@ -2989,7 +3239,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-171">line 171</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-183">line 183</a>
</li></ul></dd>
@@ -3094,7 +3344,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-222">line 222</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-239">line 239</a>
</li></ul></dd>
@@ -3199,7 +3449,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-115">line 115</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-121">line 121</a>
</li></ul></dd>
@@ -3304,7 +3554,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-210">line 210</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-227">line 227</a>
</li></ul></dd>
@@ -3377,7 +3627,7 @@
<td class="description last"><p>Is running in opera?</p></td>
<td class="description last"><p>Set to true if running in Opera.</p></td>
</tr>
@@ -3409,7 +3659,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-183">line 183</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-195">line 195</a>
</li></ul></dd>
@@ -3514,7 +3764,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-216">line 216</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-233">line 233</a>
</li></ul></dd>
@@ -3728,7 +3978,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-266">line 266</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-284">line 284</a>
</li></ul></dd>
@@ -3833,7 +4083,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-127">line 127</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-133">line 133</a>
</li></ul></dd>
@@ -3906,7 +4156,7 @@
<td class="description last"><p>Is running in safari?</p></td>
<td class="description last"><p>Set to true if running in Safari.</p></td>
</tr>
@@ -3938,7 +4188,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-189">line 189</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-201">line 201</a>
</li></ul></dd>
@@ -4043,7 +4293,112 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-109">line 109</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-115">line 115</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="typedArray"><span class="type-signature"></span>typedArray<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>typedArray</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Does the browser support TypedArrays?</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-139">line 139</a>
</li></ul></dd>
@@ -4148,7 +4503,112 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-228">line 228</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-245">line 245</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="webApp"><span class="type-signature"></span>webApp<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>webApp</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Set to true if running as a WebApp, i.e. within a WebView</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-207">line 207</a>
</li></ul></dd>
@@ -4253,7 +4713,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-204">line 204</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-221">line 221</a>
</li></ul></dd>
@@ -4358,7 +4818,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-97">line 97</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-103">line 103</a>
</li></ul></dd>
@@ -4463,7 +4923,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-240">line 240</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-258">line 258</a>
</li></ul></dd>
@@ -4568,7 +5028,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-65">line 65</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-71">line 71</a>
</li></ul></dd>
@@ -4673,7 +5133,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-103">line 103</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-109">line 109</a>
</li></ul></dd>
@@ -4787,7 +5247,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-481">line 481</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-520">line 520</a>
</li></ul></dd>
@@ -4879,7 +5339,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-514">line 514</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-553">line 553</a>
</li></ul></dd>
@@ -4953,7 +5413,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Thu Nov 07 2013 06:07:35 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>