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>
@ -330,7 +336,7 @@ You can generate the fnt files using
<div class="param-description">
<p>An alignment of the multiline text (&#39;left&#39;, &#39;center&#39; or &#39;right&#39;)</p>
<p>Alignment for multiline text (&#39;left&#39;, &#39;center&#39; or &#39;right&#39;), does not affect single line text</p>
</div>
@ -849,7 +855,7 @@ You can generate the fnt files using
<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>
@ -951,7 +957,7 @@ You can generate the fnt files using
<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>
@ -981,7 +987,7 @@ You can generate the fnt files using
<div class="param-description">
</div>
@ -1036,7 +1042,7 @@ You can generate the fnt files using
<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>
@ -1047,7 +1053,7 @@ You can generate the fnt files using
</div>
<div class="description">
<p>Returns the Child at the specified index</p>
<p>Returns the child at the specified index</p>
</div>
@ -1122,7 +1128,7 @@ You can generate the fnt files using
<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>
@ -1152,7 +1158,7 @@ You can generate the fnt files using
<div class="param-description">
</div>
@ -1207,7 +1213,7 @@ You can generate the fnt files using
<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>
@ -1237,7 +1243,7 @@ You can generate the fnt files using
<div class="param-description">
</div>
@ -1292,7 +1298,7 @@ You can generate the fnt files using
<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>
@ -1322,7 +1328,7 @@ You can generate the fnt files using
<div class="param-description">
</div>
@ -1377,7 +1383,7 @@ You can generate the fnt files using
<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>
@ -1408,7 +1414,7 @@ for this callback to be fired the mouse must have been pressed down over the dis
<div class="param-description">
</div>
@ -1463,7 +1469,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>
@ -1494,7 +1500,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<div class="param-description">
</div>
@ -1549,7 +1555,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>
@ -1637,7 +1643,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>
@ -1670,7 +1676,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -1787,7 +1793,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
<p>An alignment of the multiline text (&#39;left&#39;, &#39;center&#39; or &#39;right&#39;)</p>
<p>Alignment for multiline text (&#39;left&#39;, &#39;center&#39; or &#39;right&#39;), does not affect single line text</p>
</div>
@ -1944,7 +1950,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>
@ -1974,7 +1980,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -1989,7 +1995,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -2044,7 +2050,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>
@ -2075,7 +2081,7 @@ basically a touch version of click</p>
<div class="param-description">
</div>
@ -2130,7 +2136,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>
@ -2160,7 +2166,7 @@ basically a touch version of click</p>
<div class="param-description">
</div>
@ -2215,7 +2221,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>
@ -2246,7 +2252,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<div class="param-description">
</div>
@ -2301,7 +2307,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>
@ -2312,7 +2318,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>
@ -2331,7 +2337,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<div class="param-description">
</div>
@ -2449,7 +2455,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
</div>
<div class="description">
<p>Updates the transfor of this object</p>
<p>Updates the transform of this object</p>
</div>
@ -2671,7 +2677,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>
@ -2713,7 +2719,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>
@ -2789,7 +2795,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>
@ -2845,7 +2851,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>
@ -2920,7 +2926,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>
@ -3008,7 +3014,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>
@ -3019,7 +3025,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>
@ -3398,7 +3404,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>
@ -3440,7 +3446,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>
@ -3516,7 +3522,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>