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>
@ -348,6 +354,13 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
</li>
<li class="index-item method">
<a href="#method_generateTexture">generateTexture</a>
</li>
<li class="index-item method inherited">
@ -493,6 +506,13 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
</li>
<li class="index-item property private">
<a href="#property_cacheAsBitmap">cacheAsBitmap</a>
</li>
<li class="index-item property inherited">
@ -829,7 +849,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<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>
@ -940,7 +960,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<a href="../files/src_pixi_primitives_Graphics.js.html#l144"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:144</code></a>
<a href="../files/src_pixi_primitives_Graphics.js.html#l167"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:167</code></a>
</p>
@ -1036,7 +1056,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<a href="../files/src_pixi_primitives_Graphics.js.html#l235"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:235</code></a>
<a href="../files/src_pixi_primitives_Graphics.js.html#l258"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:258</code></a>
</p>
@ -1098,7 +1118,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<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>
@ -1128,7 +1148,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<div class="param-description">
</div>
@ -1198,7 +1218,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<a href="../files/src_pixi_primitives_Graphics.js.html#l192"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:192</code></a>
<a href="../files/src_pixi_primitives_Graphics.js.html#l215"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:215</code></a>
</p>
@ -1337,7 +1357,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<a href="../files/src_pixi_primitives_Graphics.js.html#l213"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:213</code></a>
<a href="../files/src_pixi_primitives_Graphics.js.html#l236"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:236</code></a>
</p>
@ -1488,7 +1508,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<a href="../files/src_pixi_primitives_Graphics.js.html#l172"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:172</code></a>
<a href="../files/src_pixi_primitives_Graphics.js.html#l195"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:195</code></a>
</p>
@ -1614,7 +1634,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<a href="../files/src_pixi_primitives_Graphics.js.html#l160"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:160</code></a>
<a href="../files/src_pixi_primitives_Graphics.js.html#l183"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:183</code></a>
</p>
@ -1634,6 +1654,80 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
</div>
<div id="method_generateTexture" class="method item">
<h3 class="name"><code>generateTexture</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Texture.html" class="crosslink">Texture</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_primitives_Graphics.js.html#l275"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:275</code></a>
</p>
</div>
<div class="description">
<p>Useful function that returns a texture of the graphics object that can then be used to create sprites
This can be quite useful if your geometry is complicated and needs to be reused multiple times.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Texture.html" class="crosslink">Texture</a></span>:
<p>a texture of the graphics object</p>
</div>
</div>
</div>
@ -1676,7 +1770,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<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>
@ -1687,7 +1781,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
</div>
<div class="description">
<p>Returns the Child at the specified index</p>
<p>Returns the child at the specified index</p>
</div>
@ -1777,7 +1871,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<a href="../files/src_pixi_primitives_Graphics.js.html#l89"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:89</code></a>
<a href="../files/src_pixi_primitives_Graphics.js.html#l112"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:112</code></a>
</p>
@ -1904,7 +1998,7 @@ Complex polys will not be filled. Heres an example of a complex poly: <a href="h
<a href="../files/src_pixi_primitives_Graphics.js.html#l130"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:130</code></a>
<a href="../files/src_pixi_primitives_Graphics.js.html#l153"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:153</code></a>
</p>
@ -2007,7 +2101,7 @@ the current drawing position is then set to (x, y).</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>
@ -2037,7 +2131,7 @@ the current drawing position is then set to (x, y).</p>
<div class="param-description">
</div>
@ -2092,7 +2186,7 @@ the current drawing position is then set to (x, y).</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>
@ -2122,7 +2216,7 @@ the current drawing position is then set to (x, y).</p>
<div class="param-description">
</div>
@ -2177,7 +2271,7 @@ the current drawing position is then set to (x, y).</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>
@ -2207,7 +2301,7 @@ the current drawing position is then set to (x, y).</p>
<div class="param-description">
</div>
@ -2262,7 +2356,7 @@ the current drawing position is then set to (x, y).</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>
@ -2293,7 +2387,7 @@ for this callback to be fired the mouse must have been pressed down over the dis
<div class="param-description">
</div>
@ -2348,7 +2442,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>
@ -2379,7 +2473,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<div class="param-description">
</div>
@ -2443,7 +2537,7 @@ for this callback to be fired, The touch must have started over the displayObjec
<a href="../files/src_pixi_primitives_Graphics.js.html#l111"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:111</code></a>
<a href="../files/src_pixi_primitives_Graphics.js.html#l134"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:134</code></a>
</p>
@ -2545,7 +2639,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>
@ -2633,7 +2727,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>
@ -2666,7 +2760,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -2729,7 +2823,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>
@ -2759,7 +2853,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -2774,7 +2868,7 @@ Instead of using this function you can now simply set the interactive property t
<div class="param-description">
</div>
@ -2829,7 +2923,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>
@ -2860,7 +2954,7 @@ basically a touch version of click</p>
<div class="param-description">
</div>
@ -2915,7 +3009,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>
@ -2945,7 +3039,7 @@ basically a touch version of click</p>
<div class="param-description">
</div>
@ -3000,7 +3094,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>
@ -3031,7 +3125,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<div class="param-description">
</div>
@ -3086,7 +3180,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>
@ -3097,7 +3191,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>
@ -3116,7 +3210,7 @@ for this callback to be fired, The touch must have started over the sprite</p>
<div class="param-description">
</div>
@ -3265,6 +3359,58 @@ for this callback to be fired, The touch must have started over the sprite</p>
</div>
<div id="property_cacheAsBitmap" class="property item private">
<h3 class="name"><code>cacheAsBitmap</code></h3>
<span class="type">Boolean</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_primitives_Graphics.js.html#l80"><code>src&#x2F;pixi&#x2F;primitives&#x2F;Graphics.js:80</code></a>
</p>
</div>
<div class="description">
<p>If cacheAsBitmap is true the graphics object will then be rendered as if it was a sprite.
This is useful if your graphics element does not change often as it will speed up the rendering of the object
It is also usful as the graphics object will always be antialiased because it will be rendered using canvas
Not recommended if you are constanly redrawing the graphics element.</p>
</div>
<p><strong>Default:</strong> false</p>
</div>
@ -3342,7 +3488,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>
@ -3431,7 +3577,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>
@ -3552,7 +3698,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>
@ -3655,7 +3801,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>
@ -3730,7 +3876,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>
@ -3908,7 +4054,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>
@ -3919,7 +4065,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>
@ -4298,7 +4444,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>
@ -4340,7 +4486,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>
@ -4416,7 +4562,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>