<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Texture - pixi.js</title>
<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">
<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"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 2.0.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/AbstractFilter.html">AbstractFilter</a></li>
<li><a href="../classes/AjaxRequest.html">AjaxRequest</a></li>
<li><a href="../classes/AlphaMaskFilter.html">AlphaMaskFilter</a></li>
<li><a href="../classes/AssetLoader.html">AssetLoader</a></li>
<li><a href="../classes/AtlasLoader.html">AtlasLoader</a></li>
<li><a href="../classes/autoDetectRenderer.html">autoDetectRenderer</a></li>
<li><a href="../classes/BaseTexture.html">BaseTexture</a></li>
<li><a href="../classes/BitmapFontLoader.html">BitmapFontLoader</a></li>
<li><a href="../classes/BitmapText.html">BitmapText</a></li>
<li><a href="../classes/BlurFilter.html">BlurFilter</a></li>
<li><a href="../classes/CanvasGraphics.html">CanvasGraphics</a></li>
<li><a href="../classes/CanvasMaskManager.html">CanvasMaskManager</a></li>
<li><a href="../classes/CanvasRenderer.html">CanvasRenderer</a></li>
<li><a href="../classes/CanvasTinter.html">CanvasTinter</a></li>
<li><a href="../classes/Circle.html">Circle</a></li>
<li><a href="../classes/ColorMatrixFilter.html">ColorMatrixFilter</a></li>
<li><a href="../classes/ColorStepFilter.html">ColorStepFilter</a></li>
<li><a href="../classes/ComplexPrimitiveShader.html">ComplexPrimitiveShader</a></li>
<li><a href="../classes/DisplacementFilter.html">DisplacementFilter</a></li>
<li><a href="../classes/DisplayObject.html">DisplayObject</a></li>
<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/Event.html">Event</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
<li><a href="../classes/FilterTexture.html">FilterTexture</a></li>
<li><a href="../classes/getRecommendedRenderer.html">getRecommendedRenderer</a></li>
<li><a href="../classes/Graphics.html">Graphics</a></li>
<li><a href="../classes/GrayFilter.html">GrayFilter</a></li>
<li><a href="../classes/ImageLoader.html">ImageLoader</a></li>
<li><a href="../classes/InteractionData.html">InteractionData</a></li>
<li><a href="../classes/InteractionManager.html">InteractionManager</a></li>
<li><a href="../classes/InvertFilter.html">InvertFilter</a></li>
<li><a href="../classes/JsonLoader.html">JsonLoader</a></li>
<li><a href="../classes/Matrix.html">Matrix</a></li>
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
<li><a href="../classes/NormalMapFilter.html">NormalMapFilter</a></li>
<li><a href="../classes/PixelateFilter.html">PixelateFilter</a></li>
<li><a href="../classes/PixiFastShader.html">PixiFastShader</a></li>
<li><a href="../classes/PixiShader.html">PixiShader</a></li>
<li><a href="../classes/Point.html">Point</a></li>
<li><a href="../classes/Polygon.html">Polygon</a></li>
<li><a href="../classes/PolyK.html">PolyK</a></li>
<li><a href="../classes/PrimitiveShader.html">PrimitiveShader</a></li>
<li><a href="../classes/Rectangle.html">Rectangle</a></li>
<li><a href="../classes/RenderTexture.html">RenderTexture</a></li>
<li><a href="../classes/Rope.html">Rope</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/SpriteBatch.html">SpriteBatch</a></li>
<li><a href="../classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
<li><a href="../classes/Stage.html">Stage</a></li>
<li><a href="../classes/Strip.html">Strip</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/TiltShiftFilter.html">TiltShiftFilter</a></li>
<li><a href="../classes/TwistFilter.html">TwistFilter</a></li>
<li><a href="../classes/WebGLFilterManager.html">WebGLFilterManager</a></li>
<li><a href="../classes/WebGLGraphics.html">WebGLGraphics</a></li>
<li><a href="../classes/WebGLMaskManager.html">WebGLMaskManager</a></li>
<li><a href="../classes/WebGLRenderer.html">WebGLRenderer</a></li>
<li><a href="../classes/WebGLShaderManager.html">WebGLShaderManager</a></li>
<li><a href="../classes/WebGLSpriteBatch.html">WebGLSpriteBatch</a></li>
<li><a href="../classes/WebGLStencilManager.html">WebGLStencilManager</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="uses">
Uses
<ul class="inline commas">
<li><a href="EventTarget.html">EventTarget</a></li>
</ul>
</div>
<div class="foundat">
Defined in: <a href="../files/src_pixi_textures_Texture.js.html#l10"><code>src/pixi/textures/Texture.js:10</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>frame</code>
</li>
<li class="arg">
<code class="optional">[crop]</code>
</li>
<li class="arg">
<code class="optional">[trim]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l10"><code>src/pixi/textures/Texture.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">baseTexture</code>
<span class="type"><a href="../classes/BaseTexture.html" class="crosslink">BaseTexture</a></span>
<div class="param-description">
<p>The base texture source to create the texture from</p>
</div>
</li>
<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">
<p>The rectangle frame of the texture to show</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[crop]</code>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The area of original texture</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[trim]</code>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Trimmed texture rectangle</p>
</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">
<li class="index-item method private">
<a href="#method__updateWebGLuvs">_updateWebGLuvs</a>
</li>
<li class="index-item method">
<a href="#method_addTextureToCache">addTextureToCache</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_destroy">destroy</a>
</li>
<li class="index-item method inherited">
<a href="#method_emit">emit</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>
<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_listeners">listeners</a>
</li>
<li class="index-item method inherited">
<a href="#method_mixin">mixin</a>
</li>
<li class="index-item method inherited">
<a href="#method_off">off</a>
</li>
<li class="index-item method inherited">
<a href="#method_on">on</a>
</li>
<li class="index-item method private">
<a href="#method_onBaseTextureLoaded">onBaseTextureLoaded</a>
</li>
<li class="index-item method inherited">
<a href="#method_once">once</a>
</li>
<li class="index-item method inherited">
<a href="#method_removeAllListeners">removeAllListeners</a>
</li>
<li class="index-item method">
<a href="#method_removeTextureFromCache">removeTextureFromCache</a>
<span class="flag static">static</span>
</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">
<li class="index-item property private">
<a href="#property__uvs">_uvs</a>
</li>
<li class="index-item property">
<a href="#property_baseTexture">baseTexture</a>
</li>
<li class="index-item property">
<a href="#property_crop">crop</a>
</li>
<li class="index-item property">
<a href="#property_frame">frame</a>
</li>
<li class="index-item property">
<a href="#property_height">height</a>
</li>
<li class="index-item property">
<a href="#property_noFrame">noFrame</a>
</li>
<li class="index-item property">
<a href="#property_requiresUpdate">requiresUpdate</a>
</li>
<li class="index-item property">
<a href="#property_trim">trim</a>
</li>
<li class="index-item property">
<a href="#property_valid">valid</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__updateWebGLuvs" class="method item private">
<h3 class="name"><code>_updateWebGLuvs</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l201"><code>src/pixi/textures/Texture.js:201</code></a>
</p>
</div>
<div class="description">
<p>Updates the internal WebGL UV cache.</p>
</div>
</div>
<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>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l288"><code>src/pixi/textures/Texture.js:288</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_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#l150"><code>src/pixi/textures/Texture.js:150</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>
</li>
</ul>
</div>
</div>
<div id="method_emit" class="method item inherited">
<h3 class="name"><code>emit</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>eventName</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_emit">EventTarget</a>:
<a href="../files/src_pixi_utils_EventTarget.js.html#l54"><code>src/pixi/utils/EventTarget.js:54</code></a>
</p>
</div>
<div class="description">
<p>Emit an event to all registered event listeners.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">eventName</code>
<span class="type">String</span>
<div class="param-description">
<p>The name of the event.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
<p>Indication if we've emitted an event.</p>
</div>
</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>
<li class="arg">
<code>scaleMode</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/src_pixi_textures_Texture.js.html#l269"><code>src/pixi/textures/Texture.js:269</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>
<li class="param">
<code class="param-name">scaleMode</code>
<span class="type">Number</span>
<div class="param-description">
<p>Should be one of the PIXI.scaleMode consts</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>Texture</p>
</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>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l253"><code>src/pixi/textures/Texture.js:253</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">
<p>Texture</p>
</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>
<li class="arg">
<code>crossorigin</code>
</li>
<li class="arg">
<code>scaleMode</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/src_pixi_textures_Texture.js.html#l229"><code>src/pixi/textures/Texture.js:229</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>
<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>
</li>
<li class="param">
<code class="param-name">scaleMode</code>
<span class="type">Number</span>
<div class="param-description">
<p>Should be one of the PIXI.scaleMode consts</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>Texture</p>
</div>
</div>
</div>
<div id="method_listeners" class="method item inherited">
<h3 class="name"><code>listeners</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>eventName</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_listeners">EventTarget</a>:
<a href="../files/src_pixi_utils_EventTarget.js.html#l41"><code>src/pixi/utils/EventTarget.js:41</code></a>
</p>
</div>
<div class="description">
<p>Return a list of assigned event listeners.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">eventName</code>
<span class="type">String</span>
<div class="param-description">
<p>The events that should be listed.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
<p>An array of listener functions</p>
</div>
</div>
</div>
<div id="method_mixin" class="method item inherited">
<h3 class="name"><code>mixin</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>object</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_mixin">EventTarget</a>:
<a href="../files/src_pixi_utils_EventTarget.js.html#l34"><code>src/pixi/utils/EventTarget.js:34</code></a>
</p>
</div>
<div class="description">
<p>Mixes in the properties of the EventTarget prototype onto another object</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">object</code>
<span class="type">Object</span>
<div class="param-description">
<p>The obj to mix into</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_off" class="method item inherited">
<h3 class="name"><code>off</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>eventName</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_off">EventTarget</a>:
<a href="../files/src_pixi_utils_EventTarget.js.html#l143"><code>src/pixi/utils/EventTarget.js:143</code></a>
</p>
</div>
<div class="description">
<p>Remove event listeners.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">eventName</code>
<span class="type">String</span>
<div class="param-description">
<p>The event we want to remove.</p>
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>The listener that we need to find.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_on" class="method item inherited">
<h3 class="name"><code>on</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>eventName</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_on">EventTarget</a>:
<a href="../files/src_pixi_utils_EventTarget.js.html#l107"><code>src/pixi/utils/EventTarget.js:107</code></a>
</p>
</div>
<div class="description">
<p>Register a new EventListener for the given event.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">eventName</code>
<span class="type">String</span>
<div class="param-description">
<p>Name of the event.</p>
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">Functon</span>
<div class="param-description">
<p>fn Callback function.</p>
</div>
</li>
</ul>
</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#l131"><code>src/pixi/textures/Texture.js:131</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>
<div id="method_once" class="method item inherited">
<h3 class="name"><code>once</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>eventName</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_once">EventTarget</a>:
<a href="../files/src_pixi_utils_EventTarget.js.html#l124"><code>src/pixi/utils/EventTarget.js:124</code></a>
</p>
</div>
<div class="description">
<p>Add an EventListener that's only called once.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">eventName</code>
<span class="type">String</span>
<div class="param-description">
<p>Name of the event.</p>
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>Callback function.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_removeAllListeners" class="method item inherited">
<h3 class="name"><code>removeAllListeners</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>eventName</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_removeAllListeners">EventTarget</a>:
<a href="../files/src_pixi_utils_EventTarget.js.html#l173"><code>src/pixi/utils/EventTarget.js:173</code></a>
</p>
</div>
<div class="description">
<p>Remove all listeners or only the listeners for the specified event.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">eventName</code>
<span class="type">String</span>
<div class="param-description">
<p>The event you want to remove all listeners for.</p>
</div>
</li>
</ul>
</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>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l301"><code>src/pixi/textures/Texture.js:301</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>:
<p>the texture that was removed</p>
</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/src_pixi_textures_Texture.js.html#l163"><code>src/pixi/textures/Texture.js:163</code></a>
</p>
</div>
<div class="description">
<p>Specifies the region of the baseTexture that this texture will use.</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">
<p>The frame of the texture to set it to</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property__uvs" class="property item private">
<h3 class="name"><code>_uvs</code></h3>
<span class="type">Object</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l83"><code>src/pixi/textures/Texture.js:83</code></a>
</p>
</div>
<div class="description">
<p>The WebGL UV data cache.</p>
</div>
</div>
<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/src_pixi_textures_Texture.js.html#l43"><code>src/pixi/textures/Texture.js:43</code></a>
</p>
</div>
<div class="description">
<p>The base texture that this texture uses.</p>
</div>
</div>
<div id="property_crop" class="property item">
<h3 class="name"><code>crop</code></h3>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l108"><code>src/pixi/textures/Texture.js:108</code></a>
</p>
</div>
<div class="description">
<p>This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,
irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)</p>
</div>
</div>
<div id="property_frame" class="property item">
<h3 class="name"><code>frame</code></h3>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l51"><code>src/pixi/textures/Texture.js:51</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 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/src_pixi_textures_Texture.js.html#l100"><code>src/pixi/textures/Texture.js:100</code></a>
</p>
</div>
<div class="description">
<p>The height of the Texture in pixels.</p>
</div>
</div>
<div id="property_noFrame" class="property item">
<h3 class="name"><code>noFrame</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l24"><code>src/pixi/textures/Texture.js:24</code></a>
</p>
</div>
<div class="description">
<p>Does this Texture have any frame data assigned to it?</p>
</div>
</div>
<div id="property_requiresUpdate" class="property item">
<h3 class="name"><code>requiresUpdate</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l75"><code>src/pixi/textures/Texture.js:75</code></a>
</p>
</div>
<div class="description">
<p>This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)</p>
</div>
</div>
<div id="property_trim" class="property item">
<h3 class="name"><code>trim</code></h3>
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l59"><code>src/pixi/textures/Texture.js:59</code></a>
</p>
</div>
<div class="description">
<p>The trim point</p>
</div>
</div>
<div id="property_valid" class="property item">
<h3 class="name"><code>valid</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_textures_Texture.js.html#l67"><code>src/pixi/textures/Texture.js:67</code></a>
</p>
</div>
<div class="description">
<p>This will let the renderer know if the texture is valid. If its not then it cannot be rendered.</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/src_pixi_textures_Texture.js.html#l92"><code>src/pixi/textures/Texture.js:92</code></a>
</p>
</div>
<div class="description">
<p>The width of the Texture in pixels.</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>
