<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Texture - 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="http://www.goodboydigital.com/pixijs/logo_small.png" title="Pixi.js API"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.0</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/InteractionData.html">InteractionData</a></li>
<li><a href="../classes/InteractionManager.html">InteractionManager</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>Texture Class</h1>
<div class="box meta">
<div class="extends">
Extends EventTarget
</div>
<div class="foundat">
Defined in: <a href="../files/pixi_textures_Texture.js.html#l8"><code>pixi/textures/Texture.js:8</code></a>
</div>
Module: <a href="../modules/PIXI.html">PIXI</a>
</div>
<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>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Texture" class="method item">
<h3 class="name"><code>Texture</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>baseTexture</code>
</li>
<li class="arg">
<code>frmae</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_textures_Texture.js.html#l8"><code>pixi/textures/Texture.js:8</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">baseTexture</code>
<span class="type"><a href="../classes/BaseTexture.html" class="crosslink">BaseTexture</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">frmae</code>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</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">
<a href="#method_addTextureToCache">addTextureToCache</a>
</li>
<li class="index-item method">
<a href="#method_fromCanvas">fromCanvas</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_fromFrame">fromFrame</a>
</li>
<li class="index-item method">
<a href="#method_fromImage">fromImage</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_removeTextureFromCache">removeTextureFromCache</a>
</li>
<li class="index-item method">
<a href="#method_setFrame">setFrame</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property">
<a href="#property_baseTexture">baseTexture</a>
</li>
<li class="index-item property">
<a href="#property_frame">frame</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_addTextureToCache" class="method item">
<h3 class="name"><code>addTextureToCache</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>texture</code>
</li>
<li class="arg">
<code>id</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_textures_Texture.js.html#l169"><code>pixi/textures/Texture.js:169</code></a>
</p>
</div>
<div class="description">
<p>Adds a texture to the textureCache.</p>
</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>
<li class="param">
<code class="param-name">id</code>
<span class="type">String</span>
<div class="param-description">
<p>the id that the texture will be stored against.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_fromCanvas" class="method item">
<h3 class="name"><code>fromCanvas</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>canvas</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_textures_Texture.js.html#l138"><code>pixi/textures/Texture.js:138</code></a>
</p>
</div>
<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>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">canvas</code>
<span class="type">Canvas</span>
<div class="param-description">
<p>The canvas element source of the texture</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
Texture
</div>
</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"></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_textures_Texture.js.html#l123"><code>pixi/textures/Texture.js:123</code></a>
</p>
</div>
<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>
</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</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
Texture
</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>imageUrl</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_textures_Texture.js.html#l88"><code>pixi/textures/Texture.js:88</code></a>
</p>
</div>
<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>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">imageUrl</code>
<span class="type">String</span>
<div class="param-description">
<p>The image url of the texture</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
Texture
</div>
</div>
</div>
<div id="method_removeTextureFromCache" class="method item">
<h3 class="name"><code>removeTextureFromCache</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
</ul><span class="paren">)</span>
</div>
<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/pixi_textures_Texture.js.html#l181"><code>pixi/textures/Texture.js:181</code></a>
</p>
</div>
<div class="description">
<p>Remove a texture from the textureCache.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type">String</span>
<div class="param-description">
<p>the id of the texture to be removed</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Texture.html" class="crosslink">Texture</a></span>:
the texture that was removed
</div>
</div>
</div>
<div id="method_setFrame" class="method item">
<h3 class="name"><code>setFrame</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>frame</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_textures_Texture.js.html#l75"><code>pixi/textures/Texture.js:75</code></a>
</p>
</div>
<div class="description">
<p>Specifies the rectangle region of the baseTexture</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">frame</code>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_baseTexture" class="property item">
<h3 class="name"><code>baseTexture</code></h3>
<span class="type"><a href="../classes/BaseTexture.html" class="crosslink">BaseTexture</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_textures_Texture.js.html#l28"><code>pixi/textures/Texture.js:28</code></a>
</p>
</div>
<div class="description">
<p>The base texture of this texture</p>
</div>
</div>
<div id="property_frame" class="property item">
<h3 class="name"><code>frame</code></h3>
<span class="type">#Rectangle</span>
<div class="meta">
<p>
Defined in
<a href="../files/pixi_textures_Texture.js.html#l37"><code>pixi/textures/Texture.js:37</code></a>
</p>
</div>
<div class="description">
<p>The frame specifies the region of the base texture that this texture uses</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>
