847eb6c48e
Fixed issue where alpha not being set correctly in canvas spriteBatch Fixed issue where previous stage events did not get removed correctly
891 lines
20 KiB
HTML
891 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>BaseTexture - 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: 1.4.3</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/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/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/CanvasRenderer.html">CanvasRenderer</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/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/EventTarget.html">EventTarget</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/InvertFilter.html">InvertFilter</a></li>
|
|
|
|
<li><a href="../classes/JsonLoader.html">JsonLoader</a></li>
|
|
|
|
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
|
|
|
|
<li><a href="../classes/PixelateFilter.html">PixelateFilter</a></li>
|
|
|
|
<li><a href="../classes/PIXI.PixiFastShader.html">PIXI.PixiFastShader</a></li>
|
|
|
|
<li><a href="../classes/PIXI.PixiShader.html">PIXI.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._convex.html">PolyK._convex</a></li>
|
|
|
|
<li><a href="../classes/PolyK._PointInTriangle.html">PolyK._PointInTriangle</a></li>
|
|
|
|
<li><a href="../classes/PolyK.AjaxRequest.html">PolyK.AjaxRequest</a></li>
|
|
|
|
<li><a href="../classes/PolyK.InteractionData.html">PolyK.InteractionData</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/TwistFilter.html">TwistFilter</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>BaseTexture 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_BaseTexture.js.html#l11"><code>src/pixi/textures/BaseTexture.js:11</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. All textures have a base texture</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="constructor">
|
|
<h2>Constructor</h2>
|
|
<div id="method_BaseTexture" class="method item">
|
|
<h3 class="name"><code>BaseTexture</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>source</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Defined in
|
|
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_textures_BaseTexture.js.html#l11"><code>src/pixi/textures/BaseTexture.js:11</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">source</code>
|
|
<span class="type">String</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>the source object (image or canvas)</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">
|
|
<a href="#method_destroy">destroy</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method_destroy">destroy</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method_fromImage">fromImage</a>
|
|
|
|
|
|
<span class="flag static">static</span>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="index-section properties">
|
|
<h3>Properties</h3>
|
|
|
|
<ul class="index-list properties">
|
|
|
|
<li class="index-item property">
|
|
<a href="#property_hasLoaded">hasLoaded</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property">
|
|
<a href="#property_height">height</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property">
|
|
<a href="#property_scaleMode">scaleMode</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property">
|
|
<a href="#property_source">source</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_destroy" class="method item">
|
|
<h3 class="name"><code>destroy</code></h3>
|
|
|
|
|
|
<span class="paren">()</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Defined in
|
|
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_textures_BaseTexture.js.html#l117"><code>src/pixi/textures/BaseTexture.js:117</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Destroys this base texture</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_destroy" class="method item">
|
|
<h3 class="name"><code>destroy</code></h3>
|
|
|
|
|
|
<span class="paren">()</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Defined in
|
|
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_textures_BaseTexture.js.html#l135"><code>src/pixi/textures/BaseTexture.js:135</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
</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/src_pixi_textures_BaseTexture.js.html#l148"><code>src/pixi/textures/BaseTexture.js:148</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Helper function that returns a base texture based on an image url
|
|
If the image is not in the base 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">
|
|
|
|
|
|
<p>BaseTexture</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="properties" class="api-class-tabpanel">
|
|
<h2 class="off-left">Properties</h2>
|
|
|
|
|
|
<div id="property_hasLoaded" class="property item">
|
|
<h3 class="name"><code>hasLoaded</code></h3>
|
|
<span class="type">Boolean</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Defined in
|
|
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_textures_BaseTexture.js.html#l49"><code>src/pixi/textures/BaseTexture.js:49</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>[read-only] Describes if the base texture has loaded or not</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_BaseTexture.js.html#l32"><code>src/pixi/textures/BaseTexture.js:32</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>[read-only] The height of the base texture set when the image has loaded</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_scaleMode" class="property item">
|
|
<h3 class="name"><code>scaleMode</code></h3>
|
|
<span class="type">PIXI.scaleModes</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Defined in
|
|
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_textures_BaseTexture.js.html#l41"><code>src/pixi/textures/BaseTexture.js:41</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The scale mode to apply when scaling this texture</p>
|
|
|
|
</div>
|
|
|
|
|
|
<p><strong>Default:</strong> PIXI.scaleModes.LINEAR</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_source" class="property item">
|
|
<h3 class="name"><code>source</code></h3>
|
|
<span class="type">Image</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Defined in
|
|
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_textures_BaseTexture.js.html#l58"><code>src/pixi/textures/BaseTexture.js:58</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The source that is loaded to create the texture</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_BaseTexture.js.html#l23"><code>src/pixi/textures/BaseTexture.js:23</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>[read-only] The width of the base texture set when the image has loaded</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>
|