<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>WebGLFastSpriteBatch - 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.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/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/AsciiFilter.html">AsciiFilter</a></li> <li><a href="../classes/AssetLoader.html">AssetLoader</a></li> <li><a href="../classes/AtlasLoader.html">AtlasLoader</a></li> <li><a href="../classes/autoDetectRecommendedRenderer.html">autoDetectRecommendedRenderer</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/BlurXFilter.html">BlurXFilter</a></li> <li><a href="../classes/BlurYFilter.html">BlurYFilter</a></li> <li><a href="../classes/CanvasBuffer.html">CanvasBuffer</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/ConvolutionFilter.html">ConvolutionFilter</a></li> <li><a href="../classes/CrossHatchFilter.html">CrossHatchFilter</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/FilterBlock.html">FilterBlock</a></li> <li><a href="../classes/FilterTexture.html">FilterTexture</a></li> <li><a href="../classes/Graphics.html">Graphics</a></li> <li><a href="../classes/GraphicsData.html">GraphicsData</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/NoiseFilter.html">NoiseFilter</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/RGBSplitFilter.html">RGBSplitFilter</a></li> <li><a href="../classes/Rope.html">Rope</a></li> <li><a href="../classes/Rounded Rectangle.html">Rounded Rectangle</a></li> <li><a href="../classes/SepiaFilter.html">SepiaFilter</a></li> <li><a href="../classes/SmartBlurFilter.html">SmartBlurFilter</a></li> <li><a href="../classes/Spine.html">Spine</a></li> <li><a href="../classes/SpineLoader.html">SpineLoader</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/StripShader.html">StripShader</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/TiltShiftXFilter.html">TiltShiftXFilter</a></li> <li><a href="../classes/TiltShiftYFilter.html">TiltShiftYFilter</a></li> <li><a href="../classes/TwistFilter.html">TwistFilter</a></li> <li><a href="../classes/WebGLBlendModeManager.html">WebGLBlendModeManager</a></li> <li><a href="../classes/WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a></li> <li><a href="../classes/WebGLFilterManager.html">WebGLFilterManager</a></li> <li><a href="../classes/WebGLGraphics.html">WebGLGraphics</a></li> <li><a href="../classes/WebGLGraphicsData.html">WebGLGraphicsData</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>WebGLFastSpriteBatch Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l11"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:11</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_WebGLFastSpriteBatch" class="method item"> <h3 class="name"><code>WebGLFastSpriteBatch</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l11"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:11</code></a> </p> </div> <div class="description"> </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_begin">begin</a> </li> <li class="index-item method"> <a href="#method_end">end</a> </li> <li class="index-item method"> <a href="#method_flush">flush</a> </li> <li class="index-item method"> <a href="#method_render">render</a> </li> <li class="index-item method"> <a href="#method_renderSprite">renderSprite</a> </li> <li class="index-item method"> <a href="#method_setContext">setContext</a> </li> <li class="index-item method"> <a href="#method_start">start</a> </li> <li class="index-item method"> <a href="#method_stop">stop</a> </li> </ul> </div> <div class="index-section properties"> <h3>Properties</h3> <ul class="index-list properties"> <li class="index-item property"> <a href="#property_currentBaseTexture">currentBaseTexture</a> </li> <li class="index-item property"> <a href="#property_currentBatchSize">currentBatchSize</a> </li> <li class="index-item property"> <a href="#property_currentBlendMode">currentBlendMode</a> </li> <li class="index-item property"> <a href="#property_drawing">drawing</a> </li> <li class="index-item property"> <a href="#property_indexBuffer">indexBuffer</a> </li> <li class="index-item property"> <a href="#property_indices">indices</a> </li> <li class="index-item property"> <a href="#property_lastIndexCount">lastIndexCount</a> </li> <li class="index-item property"> <a href="#property_matrix">matrix</a> </li> <li class="index-item property"> <a href="#property_maxSize">maxSize</a> </li> <li class="index-item property"> <a href="#property_renderSession">renderSession</a> </li> <li class="index-item property"> <a href="#property_shader">shader</a> </li> <li class="index-item property"> <a href="#property_size">size</a> </li> <li class="index-item property"> <a href="#property_vertexBuffer">vertexBuffer</a> </li> <li class="index-item property"> <a href="#property_vertices">vertices</a> </li> <li class="index-item property"> <a href="#property_vertSize">vertSize</a> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method_begin" class="method item"> <h3 class="name"><code>begin</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>spriteBatch</code> </li> <li class="arg"> <code>renderSession</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l154"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:154</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">spriteBatch</code> <span class="type"><a href="../classes/WebGLSpriteBatch.html" class="crosslink">WebGLSpriteBatch</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">renderSession</code> <span class="type">Object</span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_end" class="method item"> <h3 class="name"><code>end</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l169"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:169</code></a> </p> </div> <div class="description"> </div> </div> <div id="method_flush" class="method item"> <h3 class="name"><code>flush</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l349"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:349</code></a> </p> </div> <div class="description"> </div> </div> <div id="method_render" class="method item"> <h3 class="name"><code>render</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>spriteBatch</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l177"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:177</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">spriteBatch</code> <span class="type"><a href="../classes/WebGLSpriteBatch.html" class="crosslink">WebGLSpriteBatch</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_renderSprite" class="method item"> <h3 class="name"><code>renderSprite</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>sprite</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l208"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:208</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">sprite</code> <span class="type"><a href="../classes/Sprite.html" class="crosslink">Sprite</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_setContext" class="method item"> <h3 class="name"><code>setContext</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>gl</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l130"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:130</code></a> </p> </div> <div class="description"> <p>Sets the WebGL Context.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">gl</code> <span class="type">WebGLContext</span> <div class="param-description"> <p>the current WebGL drawing context</p> </div> </li> </ul> </div> </div> <div id="method_start" class="method item"> <h3 class="name"><code>start</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l397"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:397</code></a> </p> </div> <div class="description"> </div> </div> <div id="method_stop" class="method item"> <h3 class="name"><code>stop</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l389"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:389</code></a> </p> </div> <div class="description"> </div> </div> </div> <div id="properties" class="api-class-tabpanel"> <h2 class="off-left">Properties</h2> <div id="property_currentBaseTexture" class="property item"> <h3 class="name"><code>currentBaseTexture</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_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l95"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:95</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_currentBatchSize" class="property item"> <h3 class="name"><code>currentBatchSize</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l89"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:89</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_currentBlendMode" class="property item"> <h3 class="name"><code>currentBlendMode</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l101"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:101</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_drawing" class="property item"> <h3 class="name"><code>drawing</code></h3> <span class="type">Boolean</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l83"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:83</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_indexBuffer" class="property item"> <h3 class="name"><code>indexBuffer</code></h3> <span class="type">Object</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l61"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:61</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_indices" class="property item"> <h3 class="name"><code>indices</code></h3> <span class="type">Uint16Array</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l48"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:48</code></a> </p> </div> <div class="description"> <p>Index data</p> </div> </div> <div id="property_lastIndexCount" class="property item"> <h3 class="name"><code>lastIndexCount</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l67"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:67</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_matrix" class="property item"> <h3 class="name"><code>matrix</code></h3> <span class="type"><a href="../classes/Matrix.html" class="crosslink">Matrix</a></span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l119"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:119</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_maxSize" class="property item"> <h3 class="name"><code>maxSize</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l23"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:23</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_renderSession" class="property item"> <h3 class="name"><code>renderSession</code></h3> <span class="type">Object</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l107"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:107</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_shader" class="property item"> <h3 class="name"><code>shader</code></h3> <span class="type">Object</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l113"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:113</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_size" class="property item"> <h3 class="name"><code>size</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l29"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:29</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_vertexBuffer" class="property item"> <h3 class="name"><code>vertexBuffer</code></h3> <span class="type">Object</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l55"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:55</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_vertices" class="property item"> <h3 class="name"><code>vertices</code></h3> <span class="type">Float32Array</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l41"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:41</code></a> </p> </div> <div class="description"> <p>Vertex data</p> </div> </div> <div id="property_vertSize" class="property item"> <h3 class="name"><code>vertSize</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_pixi_renderers_webgl_utils_WebGLFastSpriteBatch.js.html#l17"><code>src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js:17</code></a> </p> </div> <div class="description"> </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>