Docs updated

This commit is contained in:
Mat Groves 2013-11-02 11:37:42 +00:00
parent a46b74f8ca
commit 6c762fb396
119 changed files with 38715 additions and 9039 deletions

View file

@ -3,11 +3,11 @@
<head>
<meta charset="utf-8">
<title>Texture - Pixi.JS</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="..&#x2F;assets/favicon.png">
<script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;combo?3.8.0&#x2F;build&#x2F;yui&#x2F;yui-min.js"></script>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
@ -15,7 +15,7 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="http:&#x2F;&#x2F;www.goodboydigital.com&#x2F;pixijs&#x2F;logo_small.png" title="Pixi.JS"></h1>
<h1><img src="http://www.goodboydigital.com/pixijs/logo_small.png" title="Pixi.JS"></h1>
</div>
<div class="yui3-u-1-4 version">
@ -41,71 +41,95 @@
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/AssetLoader.html">AssetLoader</a></li>
<li><a href="../classes/AbstractFilter.html">AbstractFilter</a></li>
<li><a href="..&#x2F;classes/BaseTexture.html">BaseTexture</a></li>
<li><a href="../classes/AssetLoader.html">AssetLoader</a></li>
<li><a href="..&#x2F;classes/BitmapFontLoader.html">BitmapFontLoader</a></li>
<li><a href="../classes/BaseTexture.html">BaseTexture</a></li>
<li><a href="..&#x2F;classes/BitmapText.html">BitmapText</a></li>
<li><a href="../classes/BitmapFontLoader.html">BitmapFontLoader</a></li>
<li><a href="..&#x2F;classes/CanvasGraphics.html">CanvasGraphics</a></li>
<li><a href="../classes/BitmapText.html">BitmapText</a></li>
<li><a href="..&#x2F;classes/CanvasRenderer.html">CanvasRenderer</a></li>
<li><a href="../classes/BlurFilter.html">BlurFilter</a></li>
<li><a href="..&#x2F;classes/Circle.html">Circle</a></li>
<li><a href="../classes/CanvasGraphics.html">CanvasGraphics</a></li>
<li><a href="..&#x2F;classes/CustomRenderable.html">CustomRenderable</a></li>
<li><a href="../classes/CanvasRenderer.html">CanvasRenderer</a></li>
<li><a href="..&#x2F;classes/DisplayObject.html">DisplayObject</a></li>
<li><a href="../classes/Circle.html">Circle</a></li>
<li><a href="..&#x2F;classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
<li><a href="../classes/ColorMatrixFilter.html">ColorMatrixFilter</a></li>
<li><a href="..&#x2F;classes/Ellipse.html">Ellipse</a></li>
<li><a href="../classes/CustomRenderable.html">CustomRenderable</a></li>
<li><a href="..&#x2F;classes/Graphics.html">Graphics</a></li>
<li><a href="../classes/DisplacementFilter.html">DisplacementFilter</a></li>
<li><a href="..&#x2F;classes/ImageLoader.html">ImageLoader</a></li>
<li><a href="../classes/DisplayObject.html">DisplayObject</a></li>
<li><a href="..&#x2F;classes/InteractionData.html">InteractionData</a></li>
<li><a href="../classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
<li><a href="..&#x2F;classes/InteractionManager.html">InteractionManager</a></li>
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
<li><a href="..&#x2F;classes/JsonLoader.html">JsonLoader</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
<li><a href="..&#x2F;classes/MovieClip.html">MovieClip</a></li>
<li><a href="../classes/Graphics.html">Graphics</a></li>
<li><a href="..&#x2F;classes/Point.html">Point</a></li>
<li><a href="../classes/GreyFilter.html">GreyFilter</a></li>
<li><a href="..&#x2F;classes/Polygon.html">Polygon</a></li>
<li><a href="../classes/ImageLoader.html">ImageLoader</a></li>
<li><a href="..&#x2F;classes/Rectangle.html">Rectangle</a></li>
<li><a href="../classes/InvertFilter.html">InvertFilter</a></li>
<li><a href="..&#x2F;classes/RenderTexture.html">RenderTexture</a></li>
<li><a href="../classes/JsonLoader.html">JsonLoader</a></li>
<li><a href="..&#x2F;classes/Spine.html">Spine</a></li>
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
<li><a href="..&#x2F;classes/Sprite.html">Sprite</a></li>
<li><a href="../classes/PixelateFilter.html">PixelateFilter</a></li>
<li><a href="..&#x2F;classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
<li><a href="../classes/Point.html">Point</a></li>
<li><a href="..&#x2F;classes/Stage.html">Stage</a></li>
<li><a href="../classes/Polygon.html">Polygon</a></li>
<li><a href="..&#x2F;classes/Text.html">Text</a></li>
<li><a href="../classes/PolyK._convex.html">PolyK._convex</a></li>
<li><a href="..&#x2F;classes/Texture.html">Texture</a></li>
<li><a href="../classes/PolyK._PointInTriangle.html">PolyK._PointInTriangle</a></li>
<li><a href="..&#x2F;classes/TilingSprite.html">TilingSprite</a></li>
<li><a href="../classes/PolyK.AjaxRequest.html">PolyK.AjaxRequest</a></li>
<li><a href="..&#x2F;classes/WebGLBatch.html">WebGLBatch</a></li>
<li><a href="../classes/PolyK.InteractionData.html">PolyK.InteractionData</a></li>
<li><a href="..&#x2F;classes/WebGLRenderer.html">WebGLRenderer</a></li>
<li><a href="../classes/PolyK.InteractionManager.html">PolyK.InteractionManager</a></li>
<li><a href="../classes/Rectangle.html">Rectangle</a></li>
<li><a href="../classes/RenderTexture.html">RenderTexture</a></li>
<li><a href="../classes/SepiaFilter.html">SepiaFilter</a></li>
<li><a href="../classes/Spine.html">Spine</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>
<li><a href="../classes/Text.html">Text</a></li>
<li><a href="../classes/Texture.html">Texture</a></li>
<li><a href="../classes/TilingSprite.html">TilingSprite</a></li>
<li><a href="../classes/WebGLBatch.html">WebGLBatch</a></li>
<li><a href="../classes/WebGLRenderer.html">WebGLRenderer</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="..&#x2F;modules/PIXI.html">PIXI</a></li>
<li><a href="../modules/PIXI.html">PIXI</a></li>
</ul>
</div>
@ -145,16 +169,21 @@
<h1>Texture Class</h1>
<div class="box meta">
<div class="extends">
Extends EventTarget
<div class="uses">
Uses
<ul class="inline commas">
<li><a href="EventTarget.html">EventTarget</a></li>
</ul>
</div>
<div class="foundat">
Defined in: <a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l8"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:8</code></a>
Defined in: <a href="../files/src_pixi_textures_Texture.js.html#l8"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:8</code></a>
</div>
@ -170,7 +199,9 @@
<div class="box intro">
<p>A texture stores the information that represents an image or part of an image. It cannot be added to the display list directly. To do this use PIXI.Sprite. If no frame is provided then the whole image is used</p>
<p>A texture stores the information that represents an image or part of an image. It cannot be added
to the display list directly. To do this use PIXI.Sprite. If no frame is provided then the whole image is used</p>
</div>
@ -191,7 +222,7 @@
<li class="arg">
<code>frmae</code>
<code>frame</code>
</li>
@ -224,7 +255,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l8"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:8</code></a>
<a href="../files/src_pixi_textures_Texture.js.html#l8"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:8</code></a>
</p>
@ -253,7 +284,8 @@
<div class="param-description">
<p>The base texture source to create the texture from</p>
</div>
@ -261,14 +293,15 @@
<li class="param">
<code class="param-name">frmae</code>
<code class="param-name">frame</code>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
<div class="param-description">
<p>The rectangle frame of the texture to show</p>
</div>
@ -308,7 +341,7 @@
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_addTextureToCache">addTextureToCache</a>
@ -317,6 +350,13 @@
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_destroy">destroy</a>
</li>
<li class="index-item method">
@ -332,6 +372,8 @@
<a href="#method_fromFrame">fromFrame</a>
<span class="flag static">static</span>
</li>
@ -342,6 +384,13 @@
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method_onBaseTextureLoaded">onBaseTextureLoaded</a>
</li>
<li class="index-item method">
@ -368,7 +417,7 @@
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<ul class="index-list properties">
<li class="index-item property">
<a href="#property_baseTexture">baseTexture</a>
@ -382,6 +431,13 @@
</li>
<li class="index-item property">
<a href="#property_trim">trim</a>
</li>
</ul>
@ -448,7 +504,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l158"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:158</code></a>
<a href="../files/src_pixi_textures_Texture.js.html#l182"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:182</code></a>
</p>
@ -460,6 +516,7 @@
<div class="description">
<p>Adds a texture to the textureCache.</p>
</div>
@ -493,6 +550,96 @@
<div class="param-description">
<p>the id that the texture will be stored against.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_destroy" class="method item">
<h3 class="name"><code>destroy</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>destroyBase</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l93"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:93</code></a>
</p>
</div>
<div class="description">
<p>Destroys this texture</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">destroyBase</code>
<span class="type">Boolean</span>
<div class="param-description">
<p>Whether to destroy the base texture as well</p>
</div>
@ -556,7 +703,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l142"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:142</code></a>
<a href="../files/src_pixi_textures_Texture.js.html#l166"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:166</code></a>
</p>
@ -568,7 +715,8 @@
<div class="description">
<p>Helper function that returns a texture based on a canvas element
If the canvas is not in the texture cache it will be created and loaded</p>
If the canvas is not in the texture cache it will be created and loaded</p>
</div>
@ -587,6 +735,7 @@
<div class="param-description">
<p>The canvas element source of the texture</p>
</div>
@ -603,7 +752,8 @@
<div class="returns-description">
Texture
<p>Texture</p>
</div>
</div>
@ -643,6 +793,8 @@
<span class="flag static">static</span>
@ -659,7 +811,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l127"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:127</code></a>
<a href="../files/src_pixi_textures_Texture.js.html#l150"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:150</code></a>
</p>
@ -671,7 +823,8 @@
<div class="description">
<p>Helper function that returns a texture based on a frame id
If the frame id is not in the texture cache an error will be thrown</p>
If the frame id is not in the texture cache an error will be thrown</p>
</div>
@ -690,6 +843,7 @@
<div class="param-description">
<p>The frame id of the texture</p>
</div>
@ -706,7 +860,8 @@
<div class="returns-description">
Texture
<p>Texture</p>
</div>
</div>
@ -729,6 +884,12 @@
</li>
<li class="arg">
<code>crossorigin</code>
</li>
</ul><span class="paren">)</span>
</div>
@ -764,7 +925,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l105"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:105</code></a>
<a href="../files/src_pixi_textures_Texture.js.html#l127"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:127</code></a>
</p>
@ -776,7 +937,8 @@
<div class="description">
<p>Helper function that returns a texture based on an image url
If the image is not in the texture cache it will be created and loaded</p>
If the image is not in the texture cache it will be created and loaded</p>
</div>
@ -795,6 +957,23 @@
<div class="param-description">
<p>The image url of the texture</p>
</div>
</li>
<li class="param">
<code class="param-name">crossorigin</code>
<span class="type">Boolean</span>
<div class="param-description">
<p>Whether requests should be treated as crossorigin</p>
</div>
@ -811,13 +990,104 @@
<div class="returns-description">
Texture
<p>Texture</p>
</div>
</div>
</div>
<div id="method_onBaseTextureLoaded" class="method item private">
<h3 class="name"><code>onBaseTextureLoaded</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>event</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l73"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:73</code></a>
</p>
</div>
<div class="description">
<p>Called when the base texture is loaded</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
@ -869,7 +1139,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l171"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:171</code></a>
<a href="../files/src_pixi_textures_Texture.js.html#l195"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:195</code></a>
</p>
@ -881,6 +1151,7 @@
<div class="description">
<p>Remove a texture from the textureCache.</p>
</div>
@ -899,6 +1170,7 @@
<div class="param-description">
<p>the id of the texture to be removed</p>
</div>
@ -917,7 +1189,8 @@
<span class="type"><a href="../classes/Texture.html" class="crosslink">Texture</a></span>:
the texture that was removed
<p>the texture that was removed</p>
</div>
</div>
@ -969,7 +1242,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l83"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:83</code></a>
<a href="../files/src_pixi_textures_Texture.js.html#l104"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:104</code></a>
</p>
@ -981,6 +1254,7 @@
<div class="description">
<p>Specifies the rectangle region of the baseTexture</p>
</div>
@ -998,7 +1272,8 @@
<div class="param-description">
<p>The frame of the texture to set it to</p>
</div>
@ -1045,7 +1320,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l31"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:31</code></a>
<a href="../files/src_pixi_textures_Texture.js.html#l31"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:31</code></a>
</p>
@ -1056,6 +1331,7 @@
<div class="description">
<p>The base texture of this texture</p>
</div>
@ -1068,7 +1344,7 @@
<div id="property_frame" class="property item">
<h3 class="name"><code>frame</code></h3>
<span class="type">#Rectangle</span>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
@ -1089,7 +1365,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_textures_Texture.js.html#l40"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:40</code></a>
<a href="../files/src_pixi_textures_Texture.js.html#l39"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:39</code></a>
</p>
@ -1100,6 +1376,52 @@
<div class="description">
<p>The frame specifies the region of the base texture that this texture uses</p>
</div>
</div>
<div id="property_trim" class="property item">
<h3 class="name"><code>trim</code></h3>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l47"><code>src&#x2F;pixi&#x2F;textures&#x2F;Texture.js:47</code></a>
</p>
</div>
<div class="description">
<p>The trim point</p>
</div>
@ -1125,13 +1447,13 @@
</div>
</div>
</div>
<script src="..&#x2F;assets/vendor/prettify/prettify-min.js"></script>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="..&#x2F;assets/js/yui-prettify.js"></script>
<script src="..&#x2F;assets/../api.js"></script>
<script src="..&#x2F;assets/js/api-filter.js"></script>
<script src="..&#x2F;assets/js/api-list.js"></script>
<script src="..&#x2F;assets/js/api-search.js"></script>
<script src="..&#x2F;assets/js/apidocs.js"></script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>