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>
@ -799,7 +805,7 @@
<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>
@ -901,7 +907,7 @@
<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>
@ -931,7 +937,7 @@
<div class="param-description">
</div>
@ -986,7 +992,7 @@
<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>
@ -997,7 +1003,7 @@
</div>
<div class="description">
<p>Returns the Child at the specified index</p>
<p>Returns the child at the specified index</p>
</div>
@ -1069,7 +1075,7 @@
<a href="../files/src_pixi_display_Stage.js.html#l124"><code>src&#x2F;pixi&#x2F;display&#x2F;Stage.js:124</code></a>
<a href="../files/src_pixi_display_Stage.js.html#l119"><code>src&#x2F;pixi&#x2F;display&#x2F;Stage.js:119</code></a>
</p>
@ -1145,7 +1151,7 @@
<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>
@ -1175,7 +1181,7 @@
<div class="param-description">
</div>
@ -1230,7 +1236,7 @@
<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>
@ -1260,7 +1266,7 @@
<div class="param-description">
</div>
@ -1315,7 +1321,7 @@
<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>
@ -1345,7 +1351,7 @@
<div class="param-description">
</div>
@ -1400,7 +1406,7 @@
<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>
@ -1431,7 +1437,7 @@ for this callback to be fired the mouse must have been pressed down over the dis
<div class="param-description">
</div>
@ -1486,7 +1492,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>
@ -1517,7 +1523,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<div class="param-description">
</div>
@ -1572,7 +1578,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>
@ -1661,7 +1667,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<a href="../files/src_pixi_display_Stage.js.html#l108"><code>src&#x2F;pixi&#x2F;display&#x2F;Stage.js:108</code></a>
<a href="../files/src_pixi_display_Stage.js.html#l103"><code>src&#x2F;pixi&#x2F;display&#x2F;Stage.js:103</code></a>
</p>
@ -1751,7 +1757,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<a href="../files/src_pixi_display_Stage.js.html#l70"><code>src&#x2F;pixi&#x2F;display&#x2F;Stage.js:70</code></a>
<a href="../files/src_pixi_display_Stage.js.html#l66"><code>src&#x2F;pixi&#x2F;display&#x2F;Stage.js:66</code></a>
</p>
@ -1763,7 +1769,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<div class="description">
<p>Sets another DOM element which can receive mouse/touch interactions instead of the default Canvas element.
This is useful for when you have other DOM elements ontop of the Canvas element.</p>
This is useful for when you have other DOM elements on top of the Canvas element.</p>
</div>
@ -1840,7 +1846,7 @@ This is useful for when you have other DOM elements ontop of the Canvas element.
<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>
@ -1873,7 +1879,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -1936,7 +1942,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>
@ -1966,7 +1972,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -1981,7 +1987,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -2036,7 +2042,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>
@ -2067,7 +2073,7 @@ basically a touch version of click</p>
<div class="param-description">
</div>
@ -2122,7 +2128,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>
@ -2152,7 +2158,7 @@ basically a touch version of click</p>
<div class="param-description">
</div>
@ -2207,7 +2213,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>
@ -2238,7 +2244,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<div class="param-description">
</div>
@ -2293,7 +2299,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>
@ -2304,7 +2310,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>
@ -2323,7 +2329,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<div class="param-description">
</div>
@ -2549,7 +2555,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>
@ -2591,7 +2597,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>
@ -2714,7 +2720,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>
@ -2770,7 +2776,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>
@ -2979,7 +2985,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>
@ -2990,7 +2996,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>
@ -3369,7 +3375,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>
@ -3411,7 +3417,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>
@ -3490,7 +3496,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>