Docs updated

Fixed issue where alpha not being set correctly in canvas spriteBatch
Fixed issue where previous stage events did not get removed correctly
This commit is contained in:
Mat Groves 2014-01-28 00:08:50 +00:00
parent 9dbf8b47c1
commit 847eb6c48e
140 changed files with 12651 additions and 2435 deletions

View file

@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.4.0</em>
<em>API Docs for: 1.4.3</em>
</div>
</div>
<div id="bd" class="yui3-g">
@ -73,6 +73,8 @@
<li><a href="../classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
<li><a href="../classes/DotScreenFilter.html">DotScreenFilter</a></li>
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
@ -91,6 +93,8 @@
<li><a href="../classes/PixelateFilter.html">PixelateFilter</a></li>
<li><a href="../classes/PIXI.PixiFastShader.html">PIXI.PixiFastShader</a></li>
<li><a href="../classes/PIXI.PixiShader.html">PIXI.PixiShader</a></li>
<li><a href="../classes/Point.html">Point</a></li>
@ -115,9 +119,9 @@
<li><a href="../classes/Spine.html">Spine</a></li>
<li><a href="../classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
<li><a href="../classes/Sprite.html">Sprite</a></li>
<li><a href="../classes/Sprite™.html">Sprite™</a></li>
<li><a href="../classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
<li><a href="../classes/Stage.html">Stage</a></li>
@ -127,6 +131,8 @@
<li><a href="../classes/TilingSprite.html">TilingSprite</a></li>
<li><a href="../classes/TwistFilter.html">TwistFilter</a></li>
<li><a href="../classes/WebGLRenderer.html">WebGLRenderer</a></li>
</ul>
@ -208,7 +214,7 @@
<div class="box intro">
<p>The Spine loader is used to load in JSON spine data
To generate the data you need to use <a href="http://esotericsoftware.com/">http://esotericsoftware.com/</a> and export the &quot;JSON&quot; format
To generate the data you need to use <a href="http://esotericsoftware.com/">http://esotericsoftware.com/</a> and export in the &quot;JSON&quot; format
Due to a clash of names You will need to change the extension of the spine file from <em>.json to </em>.anim for it to load
See example 12 (<a href="http://www.goodboydigital.com/pixijs/examples/12/">http://www.goodboydigital.com/pixijs/examples/12/</a>) to see a working example and check out the source
You will need to generate a sprite sheet to accompany the spine data
@ -401,13 +407,6 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
</li>
<li class="index-item method private">
<a href="#method_onJSONLoaded">onJSONLoaded</a>
</li>
<li class="index-item method private">
@ -819,7 +818,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l95"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObjectContainer.js:95</code></a>
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l81"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObjectContainer.js:81</code></a>
</p>
@ -921,7 +920,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l193"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:193</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l188"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:188</code></a>
</p>
@ -951,7 +950,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<div class="param-description">
</div>
@ -1006,7 +1005,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l149"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObjectContainer.js:149</code></a>
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l135"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObjectContainer.js:135</code></a>
</p>
@ -1017,7 +1016,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
</div>
<div class="description">
<p>Returns the Child at the specified index</p>
<p>Returns the child at the specified index</p>
</div>
@ -1147,7 +1146,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l199"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:199</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l194"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:194</code></a>
</p>
@ -1177,7 +1176,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<div class="param-description">
</div>
@ -1232,7 +1231,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l225"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:225</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l220"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:220</code></a>
</p>
@ -1262,7 +1261,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<div class="param-description">
</div>
@ -1317,7 +1316,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l219"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:219</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l214"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:214</code></a>
</p>
@ -1347,7 +1346,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<div class="param-description">
</div>
@ -1402,7 +1401,7 @@ When loaded this class will dispatch a &quot;loaded&quot; event</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l205"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:205</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l200"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:200</code></a>
</p>
@ -1433,7 +1432,7 @@ for this callback to be fired the mouse must have been pressed down over the dis
<div class="param-description">
</div>
@ -1488,7 +1487,7 @@ for this callback to be fired the mouse must have been pressed down over the dis
<a href="../files/src_pixi_display_DisplayObject.js.html#l212"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:212</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l207"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:207</code></a>
</p>
@ -1519,7 +1518,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<div class="param-description">
</div>
@ -1532,63 +1531,6 @@ for this callback to be fired, The touch must have started over the displayObjec
</div>
<div id="method_onJSONLoaded" class="method item private">
<h3 class="name"><code>onJSONLoaded</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_loaders_SpineLoader.js.html#l72"><code>src&#x2F;pixi&#x2F;loaders&#x2F;SpineLoader.js:72</code></a>
</p>
</div>
<div class="description">
<p>Invoke when JSON file is loaded</p>
</div>
</div>
@ -1626,7 +1568,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<a href="../files/src_pixi_loaders_SpineLoader.js.html#l87"><code>src&#x2F;pixi&#x2F;loaders&#x2F;SpineLoader.js:87</code></a>
<a href="../files/src_pixi_loaders_SpineLoader.js.html#l72"><code>src&#x2F;pixi&#x2F;loaders&#x2F;SpineLoader.js:72</code></a>
</p>
@ -1688,7 +1630,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l167"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObjectContainer.js:167</code></a>
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l153"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObjectContainer.js:153</code></a>
</p>
@ -1776,7 +1718,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<a href="../files/src_pixi_display_DisplayObject.js.html#l266"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:266</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l261"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:261</code></a>
</p>
@ -1809,7 +1751,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -1872,7 +1814,7 @@ Instead of using this function you can now simply set the interactive property t
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l123"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObjectContainer.js:123</code></a>
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l109"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObjectContainer.js:109</code></a>
</p>
@ -1902,7 +1844,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -1917,7 +1859,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -1972,7 +1914,7 @@ Instead of using this function you can now simply set the interactive property t
<a href="../files/src_pixi_display_DisplayObject.js.html#l236"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:236</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l231"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:231</code></a>
</p>
@ -2003,7 +1945,7 @@ basically a touch version of click</p>
<div class="param-description">
</div>
@ -2058,7 +2000,7 @@ basically a touch version of click</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l249"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:249</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l244"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:244</code></a>
</p>
@ -2088,7 +2030,7 @@ basically a touch version of click</p>
<div class="param-description">
</div>
@ -2143,7 +2085,7 @@ basically a touch version of click</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l255"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:255</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l250"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:250</code></a>
</p>
@ -2174,7 +2116,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<div class="param-description">
</div>
@ -2229,7 +2171,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l243"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:243</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l238"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:238</code></a>
</p>
@ -2240,7 +2182,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
</div>
<div class="description">
<p>A callback that is used when the user touch&#39;s over the displayObject</p>
<p>A callback that is used when the user touches over the displayObject</p>
</div>
@ -2259,7 +2201,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<div class="param-description">
</div>
@ -2485,7 +2427,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
</div>
<div class="description">
<p>[NYI] Unkown</p>
<p>[NYI] Unknown</p>
</div>
@ -2572,7 +2514,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
</div>
<div class="description">
<p>This is the curser that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true</p>
<p>This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true</p>
</div>
@ -2648,7 +2590,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l340"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:340</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l335"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:335</code></a>
</p>
@ -2704,7 +2646,7 @@ To remove filters simply set this property to &#39;null&#39;</li>
</div>
<div class="description">
<p>The height of the displayObjectContainer, setting this will actually modify the scale to acheive the value set</p>
<p>The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set</p>
</div>
@ -2779,7 +2721,7 @@ Setting it is a neat way of optimising the hitTest function that the interaction
<a href="../files/src_pixi_display_DisplayObject.js.html#l279"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:279</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l274"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:274</code></a>
</p>
@ -2912,7 +2854,7 @@ Setting it is a neat way of optimising the hitTest function that the interaction
<a href="../files/src_pixi_display_DisplayObject.js.html#l320"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:320</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l315"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:315</code></a>
</p>
@ -2923,7 +2865,7 @@ Setting it is a neat way of optimising the hitTest function that the interaction
<div class="description">
<p>Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.
In PIXI a regular mask must be a PIXI.Ggraphics object. This allows for much faster masking in canvas as it utilises shape clipping.
In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.
To remove a mask, set this property to null.</p>
</div>
@ -3347,7 +3289,7 @@ To remove a mask, set this property to null.</p>
</div>
<div class="description">
<p>The width of the displayObjectContainer, setting this will actually modify the scale to acheive the value set</p>
<p>The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set</p>
</div>
@ -3389,7 +3331,7 @@ To remove a mask, set this property to null.</p>
</div>
<div class="description">
<p>[read-only] The multiplied alpha of the displayobject</p>
<p>[read-only] The multiplied alpha of the displayObject</p>
</div>
@ -3465,7 +3407,7 @@ To remove a mask, set this property to null.</p>
<a href="../files/src_pixi_display_DisplayObject.js.html#l299"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:299</code></a>
<a href="../files/src_pixi_display_DisplayObject.js.html#l294"><code>src&#x2F;pixi&#x2F;display&#x2F;DisplayObject.js:294</code></a>
</p>