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>Rectangle - 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>
@ -150,7 +174,7 @@
<div class="foundat">
Defined in: <a href="..&#x2F;files&#x2F;src_pixi_core_Rectangle.js.html#l5"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:5</code></a>
Defined in: <a href="../files/src_pixi_core_Rectangle.js.html#l5"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:5</code></a>
</div>
@ -167,6 +191,7 @@
<div class="box intro">
<p>the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height.</p>
</div>
@ -232,7 +257,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_core_Rectangle.js.html#l5"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:5</code></a>
<a href="../files/src_pixi_core_Rectangle.js.html#l5"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:5</code></a>
</p>
@ -261,7 +286,8 @@
<div class="param-description">
<p>position of the rectangle</p>
<p>The X coord of the upper-left corner of the rectangle</p>
</div>
@ -276,7 +302,8 @@
<div class="param-description">
<p>position of the rectangle</p>
<p>The Y coord of the upper-left corner of the rectangle</p>
</div>
@ -291,7 +318,8 @@
<div class="param-description">
<p>of the rectangle</p>
<p>The overall width of this rectangle</p>
</div>
@ -306,7 +334,8 @@
<div class="param-description">
<p>of the rectangle</p>
<p>The overall height of this rectangle</p>
</div>
@ -423,7 +452,7 @@
<span class="returns-inline">
<span class="type"></span>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
</span>
@ -450,7 +479,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_core_Rectangle.js.html#l45"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:45</code></a>
<a href="../files/src_pixi_core_Rectangle.js.html#l46"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:46</code></a>
</p>
@ -461,7 +490,8 @@
</div>
<div class="description">
<p>Creates a clone of this Rectangle</p>
</div>
@ -473,7 +503,10 @@
<div class="returns-description">
a copy of the rectangle
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>:
<p>a copy of the rectangle</p>
</div>
</div>
@ -508,7 +541,7 @@
<span class="returns-inline">
<span class="type"></span>
<span class="type">Boolean</span>
</span>
@ -535,7 +568,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_core_Rectangle.js.html#l54"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:54</code></a>
<a href="../files/src_pixi_core_Rectangle.js.html#l57"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:57</code></a>
</p>
@ -546,7 +579,8 @@
</div>
<div class="description">
<p>Checks if the x, and y coords passed to this function are contained within this Rectangle</p>
</div>
@ -565,6 +599,7 @@
<div class="param-description">
<p>The X coord of the point to test</p>
</div>
@ -580,6 +615,7 @@
<div class="param-description">
<p>The Y coord of the point to test</p>
</div>
@ -596,7 +632,10 @@
<div class="returns-description">
if the x/y coords are within this polygon
<span class="type">Boolean</span>:
<p>if the x/y coords are within this Rectangle</p>
</div>
</div>
@ -637,7 +676,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_core_Rectangle.js.html#l37"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:37</code></a>
<a href="../files/src_pixi_core_Rectangle.js.html#l38"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:38</code></a>
</p>
@ -683,7 +722,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_core_Rectangle.js.html#l30"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:30</code></a>
<a href="../files/src_pixi_core_Rectangle.js.html#l31"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:31</code></a>
</p>
@ -729,7 +768,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_core_Rectangle.js.html#l16"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:16</code></a>
<a href="../files/src_pixi_core_Rectangle.js.html#l17"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:17</code></a>
</p>
@ -775,7 +814,7 @@
<a href="..&#x2F;files&#x2F;src_pixi_core_Rectangle.js.html#l23"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:23</code></a>
<a href="../files/src_pixi_core_Rectangle.js.html#l24"><code>src&#x2F;pixi&#x2F;core&#x2F;Rectangle.js:24</code></a>
</p>
@ -813,13 +852,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>