<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Sprite - Pixi.js API</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.8.0pr2/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.8.0pr2/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../logo_small.png" title="Pixi.js API"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.9</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/AssetLoader.html">AssetLoader</a></li>
<li><a href="../classes/BaseTexture.html">BaseTexture</a></li>
<li><a href="../classes/CanvasRenderer.html">CanvasRenderer</a></li>
<li><a href="../classes/DisplayObject.html">DisplayObject</a></li>
<li><a href="../classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
<li><a href="../classes/Point.html">Point</a></li>
<li><a href="../classes/Rectangle.html">Rectangle</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/Texture.html">Texture</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="../modules/PIXI.html">PIXI</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Sprite Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/DisplayObjectContainer.html" class="crosslink">DisplayObjectContainer</a>
</div>
<div class="foundat">
Defined in: <a href="../files/pixi_Sprite.js.html#l10"><code>pixi/Sprite.js:10</code></a>
</div>
Module: <a href="../modules/PIXI.html">PIXI</a>
</div>
<div class="box intro">
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Sprite" class="method item">
<h3 class="name"><code>Sprite</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>texture</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_Sprite.js.html#l10"><code>pixi/Sprite.js:10</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">texture</code>
<span class="type"><a href="../classes/Texture.html" class="crosslink">Texture</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<li class="index-item method inherited">
<a href="#method_addChild">addChild</a>
</li>
<li class="index-item method inherited">
<a href="#method_addChildAt">addChildAt</a>
</li>
<li class="index-item method">
<a href="#method_fromFrame">fromFrame</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_fromImage">fromImage</a>
<span class="flag static">static</span>
</li>
<li class="index-item method inherited">
<a href="#method_removeChild">removeChild</a>
</li>
<li class="index-item method">
<a href="#method_setTexture">setTexture</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property inherited">
<a href="#property_alpha">alpha</a>
</li>
<li class="index-item property">
<a href="#property_anchor">anchor</a>
</li>
<li class="index-item property">
<a href="#property_blendMode">blendMode</a>
</li>
<li class="index-item property inherited">
<a href="#property_children">children</a>
</li>
<li class="index-item property">
<a href="#property_height">height</a>
</li>
<li class="index-item property inherited">
<a href="#property_parent">parent</a>
</li>
<li class="index-item property inherited">
<a href="#property_position">position</a>
</li>
<li class="index-item property inherited">
<a href="#property_rotation">rotation</a>
</li>
<li class="index-item property inherited">
<a href="#property_scale">scale</a>
</li>
<li class="index-item property inherited">
<a href="#property_stage">stage</a>
</li>
<li class="index-item property">
<a href="#property_texture">texture</a>
</li>
<li class="index-item property inherited">
<a href="#property_visible">visible</a>
</li>
<li class="index-item property">
<a href="#property_width">width</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_addChild" class="method item inherited">
<h3 class="name"><code>addChild</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>DisplayObject</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObjectContainer.html#method_addChild">DisplayObjectContainer</a>:
<a href="../files/pixi_DisplayObjectContainer.js.html#l29"><code>pixi/DisplayObjectContainer.js:29</code></a>
</p>
</div>
<div class="description">
<p>Adds a child to the container.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">DisplayObject</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_addChildAt" class="method item inherited">
<h3 class="name"><code>addChildAt</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>DisplayObject</code>
</li>
<li class="arg">
<code>index</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObjectContainer.html#method_addChildAt">DisplayObjectContainer</a>:
<a href="../files/pixi_DisplayObjectContainer.js.html#l51"><code>pixi/DisplayObjectContainer.js:51</code></a>
</p>
</div>
<div class="description">
<p>Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">DisplayObject</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">index</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_fromFrame" class="method item">
<h3 class="name"><code>fromFrame</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>frameId</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Sprite.html" class="crosslink">Sprite</a></span>
</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_Sprite.js.html#l111"><code>pixi/Sprite.js:111</code></a>
</p>
</div>
<div class="description">
<p>Helper function that creates a sprite that will contain a texture from the TextureCache based on tjhe frameId
The frame ids are created when a Texture packer file has been loaded</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">frameId</code>
<span class="type">String</span>
<div class="param-description">
<p>The frame Id of the texture in the cache</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Sprite.html" class="crosslink">Sprite</a></span>:
A new Sprite using a texture from the texture cache matching the frameId
</div>
</div>
</div>
<div id="method_fromImage" class="method item">
<h3 class="name"><code>fromImage</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>The</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Sprite.html" class="crosslink">Sprite</a></span>
</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_Sprite.js.html#l127"><code>pixi/Sprite.js:127</code></a>
</p>
</div>
<div class="description">
<p>Helper function that creates a sprite that will contain a texture based on an image url
If the image is not in the texture cache it will be loaded</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">The</code>
<span class="type">Object</span>
<div class="param-description">
<p>image url of the texture</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Sprite.html" class="crosslink">Sprite</a></span>:
A new Sprite using a texture from the texture cache matching the image id
</div>
</div>
</div>
<div id="method_removeChild" class="method item inherited">
<h3 class="name"><code>removeChild</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>DisplayObject</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObjectContainer.html#method_removeChild">DisplayObjectContainer</a>:
<a href="../files/pixi_DisplayObjectContainer.js.html#l97"><code>pixi/DisplayObjectContainer.js:97</code></a>
</p>
</div>
<div class="description">
<p>Removes a child from the container.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">DisplayObject</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_setTexture" class="method item">
<h3 class="name"><code>setTexture</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>texture</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_Sprite.js.html#l79"><code>pixi/Sprite.js:79</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">texture</code>
<span class="type"><a href="../classes/Texture.html" class="crosslink">Texture</a></span>
<div class="param-description">
<p>The PIXI texture that is displayed by the sprite</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_alpha" class="property item inherited">
<h3 class="name"><code>alpha</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObject.html#property_alpha">DisplayObject</a>:
<a href="../files/pixi_DisplayObject.js.html#l33"><code>pixi/DisplayObject.js:33</code></a>
</p>
</div>
<div class="description">
<p>The opacity of the object.</p>
</div>
</div>
<div id="property_anchor" class="property item">
<h3 class="name"><code>anchor</code></h3>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_Sprite.js.html#l21"><code>pixi/Sprite.js:21</code></a>
</p>
</div>
<div class="description">
<p>The anchor sets the origin point of the texture.
The default is 0,0 this means the textures origin is the top left
Setting than anchor to 0.5,0.5 means the textures origin is centered
Setting the anchor to 1,1 would mean the textures origin points will be the bottom right</p>
</div>
</div>
<div id="property_blendMode" class="property item">
<h3 class="name"><code>blendMode</code></h3>
<span class="type">Uint</span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_Sprite.js.html#l38"><code>pixi/Sprite.js:38</code></a>
</p>
</div>
<div class="description">
<p>The blend mode of sprite.
currently supports PIXI.blendModes.NORMAL and PIXI.blendModes.SCREEN</p>
</div>
</div>
<div id="property_children" class="property item inherited">
<h3 class="name"><code>children</code></h3>
<span class="type">Array</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObjectContainer.html#property_children">DisplayObjectContainer</a>:
<a href="../files/pixi_DisplayObjectContainer.js.html#l16"><code>pixi/DisplayObjectContainer.js:16</code></a>
</p>
</div>
<div class="description">
<p>[read-only] The of children of this container.</p>
</div>
</div>
<div id="property_height" class="property item">
<h3 class="name"><code>height</code></h3>
<span class="type">#Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_Sprite.js.html#l53"><code>pixi/Sprite.js:53</code></a>
</p>
</div>
<div class="description">
<p>The height of the sprite (this is initially set by the texture)</p>
</div>
</div>
<div id="property_parent" class="property item inherited">
<h3 class="name"><code>parent</code></h3>
<span class="type"><a href="../classes/DisplayObjectContainer.html" class="crosslink">DisplayObjectContainer</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObject.html#property_parent">DisplayObject</a>:
<a href="../files/pixi_DisplayObject.js.html#l48"><code>pixi/DisplayObject.js:48</code></a>
</p>
</div>
<div class="description">
<p>[read-only] The display object container that contains this display object.</p>
</div>
</div>
<div id="property_position" class="property item inherited">
<h3 class="name"><code>position</code></h3>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObject.html#property_position">DisplayObject</a>:
<a href="../files/pixi_DisplayObject.js.html#l12"><code>pixi/DisplayObject.js:12</code></a>
</p>
</div>
<div class="description">
<p>The coordinate of the object relative to the local coordinates of the parent.</p>
</div>
</div>
<div id="property_rotation" class="property item inherited">
<h3 class="name"><code>rotation</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObject.html#property_rotation">DisplayObject</a>:
<a href="../files/pixi_DisplayObject.js.html#l26"><code>pixi/DisplayObject.js:26</code></a>
</p>
</div>
<div class="description">
<p>The rotation of the object in radians.</p>
</div>
</div>
<div id="property_scale" class="property item inherited">
<h3 class="name"><code>scale</code></h3>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObject.html#property_scale">DisplayObject</a>:
<a href="../files/pixi_DisplayObject.js.html#l19"><code>pixi/DisplayObject.js:19</code></a>
</p>
</div>
<div class="description">
<p>The scale factor of the object.</p>
</div>
</div>
<div id="property_stage" class="property item inherited">
<h3 class="name"><code>stage</code></h3>
<span class="type"><a href="../classes/Stage.html" class="crosslink">Stage</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObject.html#property_stage">DisplayObject</a>:
<a href="../files/pixi_DisplayObject.js.html#l55"><code>pixi/DisplayObject.js:55</code></a>
</p>
</div>
<div class="description">
<p>[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.</p>
</div>
</div>
<div id="property_texture" class="property item">
<h3 class="name"><code>texture</code></h3>
<span class="type"><a href="../classes/Texture.html" class="crosslink">Texture</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_Sprite.js.html#l31"><code>pixi/Sprite.js:31</code></a>
</p>
</div>
<div class="description">
<p>The texture that the sprite is using</p>
</div>
</div>
<div id="property_visible" class="property item inherited">
<h3 class="name"><code>visible</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DisplayObject.html#property_visible">DisplayObject</a>:
<a href="../files/pixi_DisplayObject.js.html#l40"><code>pixi/DisplayObject.js:40</code></a>
</p>
</div>
<div class="description">
<p>The visibility of the object.</p>
</div>
</div>
<div id="property_width" class="property item">
<h3 class="name"><code>width</code></h3>
<span class="type">#Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_Sprite.js.html#l46"><code>pixi/Sprite.js:46</code></a>
</p>
</div>
<div class="description">
<p>The width of the sprite (this is initially set by the texture)</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</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>
