wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-07-26 13:27:43 +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.Color.html
+85 -45
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>
@@ -573,7 +613,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-120">line 120</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-127">line 127</a>
</li></ul></dd>
@@ -714,7 +754,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-277">line 277</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-291">line 291</a>
</li></ul></dd>
@@ -855,7 +895,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-288">line 288</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-303">line 303</a>
</li></ul></dd>
@@ -996,7 +1036,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-321">line 321</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-339">line 339</a>
</li></ul></dd>
@@ -1183,7 +1223,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-28">line 28</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-29">line 29</a>
</li></ul></dd>
@@ -1535,7 +1575,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-64">line 64</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-68">line 68</a>
</li></ul></dd>
@@ -1676,7 +1716,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-310">line 310</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-327">line 327</a>
</li></ul></dd>
@@ -1735,9 +1775,9 @@ RGB format information and HSL information. Each section starts on a newline, 3
<div class="description">
<p>Returns a random color value between black and white</p>
<p>&lt;p&gt;Set the min value to start each channel from the given offset.&lt;/p&gt;
&lt;p&gt;Set the max value to restrict the maximum color used per channel&lt;/p&gt;</p>
<p>Returns a random color value between black and white
Set the min value to start each channel from the given offset.
Set the max value to restrict the maximum color used per channel.</p>
</div>
@@ -1865,7 +1905,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-206">line 206</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-217">line 217</a>
</li></ul></dd>
@@ -2006,7 +2046,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-299">line 299</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-315">line 315</a>
</li></ul></dd>
@@ -2066,7 +2106,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<div class="description">
<p>Return the component parts of a color as an Object with the properties alpha, red, green, blue</p>
<p>&lt;p&gt;Alpha will only be set if it exist in the given color (0xAARRGGBB)&lt;/p&gt;</p>
<p>Alpha will only be set if it exist in the given color (0xAARRGGBB)</p>
</div>
@@ -2148,7 +2188,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-240">line 240</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-252">line 252</a>
</li></ul></dd>
@@ -2289,7 +2329,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-260">line 260</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-273">line 273</a>
</li></ul></dd>
@@ -2340,7 +2380,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt>
<h4 class="name" id="hexToRGB"><span class="type-signature">&lt;static> </span>hexToRGB<span class="signature">(h)</span><span class="type-signature"> &rarr; {object}</span></h4>
<h4 class="name" id="hexToRGB"><span class="type-signature">&lt;static> </span>hexToRGB<span class="signature">(h)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
@@ -2348,7 +2388,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<div class="description">
<p>Converts the given hex string into an object containing the RGB values.</p>
<p>Converts the given hex string into an integer color value.</p>
</div>
@@ -2430,7 +2470,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-41">line 41</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-43">line 43</a>
</li></ul></dd>
@@ -2455,7 +2495,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<div class="param-desc">
<p>An object with 3 properties: r,g and b.</p>
<p>The rgb color value.</p>
</div>
@@ -2466,7 +2506,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
</dt>
<dd>
<span class="param-type">object</span>
<span class="param-type">number</span>
</dd>
@@ -2539,7 +2579,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The first color value.</p></td>
</tr>
@@ -2562,7 +2602,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The second color value.</p></td>
</tr>
@@ -2585,7 +2625,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The number of steps to run the interpolation over.</p></td>
</tr>
@@ -2608,7 +2648,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.</p></td>
</tr>
@@ -2631,7 +2671,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The alpha of the returned color.</p></td>
</tr>
@@ -2663,7 +2703,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-137">line 137</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-145">line 145</a>
</li></ul></dd>
@@ -2772,7 +2812,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The first color value.</p></td>
</tr>
@@ -2795,7 +2835,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The red color value, between 0 and 0xFF (255).</p></td>
</tr>
@@ -2818,7 +2858,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The green color value, between 0 and 0xFF (255).</p></td>
</tr>
@@ -2841,7 +2881,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The blue color value, between 0 and 0xFF (255).</p></td>
</tr>
@@ -2864,7 +2904,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The number of steps to run the interpolation over.</p></td>
</tr>
@@ -2887,7 +2927,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.</p></td>
</tr>
@@ -2919,7 +2959,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-161">line 161</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-170">line 170</a>
</li></ul></dd>
@@ -3028,7 +3068,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The red color value, between 0 and 0xFF (255).</p></td>
</tr>
@@ -3051,7 +3091,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The green color value, between 0 and 0xFF (255).</p></td>
</tr>
@@ -3074,7 +3114,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The blue color value, between 0 and 0xFF (255).</p></td>
</tr>
@@ -3097,7 +3137,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The red color value, between 0 and 0xFF (255).</p></td>
</tr>
@@ -3120,7 +3160,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The green color value, between 0 and 0xFF (255).</p></td>
</tr>
@@ -3143,7 +3183,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The blue color value, between 0 and 0xFF (255).</p></td>
</tr>
@@ -3166,7 +3206,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The number of steps to run the interpolation over.</p></td>
</tr>
@@ -3189,7 +3229,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.</p></td>
</tr>
@@ -3221,7 +3261,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-183">line 183</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-193">line 193</a>
</li></ul></dd>
@@ -3362,7 +3402,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-90">line 90</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-95">line 95</a>
</li></ul></dd>
@@ -3503,7 +3543,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-105">line 105</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-111">line 111</a>
</li></ul></dd>
@@ -3577,7 +3617,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<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>