<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>WebGLSpriteBatch - 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.5.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/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/FilterTexture.html">FilterTexture</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/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/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/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>
</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>WebGLSpriteBatch Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/src_pixi_renderers_webgl_utils_WebGLSpriteBatch.js.html#l11"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.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_WebGLSpriteBatch" class="method item private">
<h3 class="name"><code>WebGLSpriteBatch</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>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_utils_WebGLSpriteBatch.js.html#l11"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.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">gl</code>
<span class="type">WebGLContext</span>
<div class="param-description">
<p>the current WebGL drawing context</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_begin">begin</a>
</li>
<li class="index-item method">
<a href="#method_destroy">destroy</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_renderTilingSprite">renderTilingSprite</a>
</li>
<li class="index-item method">
<a href="#method_setBlendMode">setBlendMode</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_indices">indices</a>
</li>
<li class="index-item property">
<a href="#property_size">size</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>renderSession</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_utils_WebGLSpriteBatch.js.html#l108"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:108</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">renderSession</code>
<span class="type">RenderSession</span>
<div class="param-description">
<p>the RenderSession</p>
</div>
</li>
</ul>
</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_renderers_webgl_utils_WebGLSpriteBatch.js.html#l477"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:477</code></a>
</p>
</div>
<div class="description">
<p>Destroys the SpriteBatch</p>
</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_WebGLSpriteBatch.js.html#l122"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:122</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_WebGLSpriteBatch.js.html#l376"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:376</code></a>
</p>
</div>
<div class="description">
<p>Renders the content and empties the current batch</p>
</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>sprite</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_utils_WebGLSpriteBatch.js.html#l132"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:132</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">
<p>the sprite to render when using this spritebatch</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_renderTilingSprite" class="method item">
<h3 class="name"><code>renderTilingSprite</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_WebGLSpriteBatch.js.html#l251"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:251</code></a>
</p>
</div>
<div class="description">
<p>Renders a tilingSprite using the spriteBatch</p>
</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/TilingSprite.html" class="crosslink">TilingSprite</a></span>
<div class="param-description">
<p>the tilingSprite to render</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_setBlendMode" class="method item">
<h3 class="name"><code>setBlendMode</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>blendMode</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_utils_WebGLSpriteBatch.js.html#l461"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:461</code></a>
</p>
</div>
<div class="description">
<p>Sets-up the given blendMode from WebGL's point of view</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">blendMode</code>
<span class="type">Number</span>
<div class="param-description">
<p>the blendMode, should be a Pixi const, such as PIXI.BlendModes.ADD</p>
</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_WebGLSpriteBatch.js.html#l81"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:81</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">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_WebGLSpriteBatch.js.html#l428"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:428</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_WebGLSpriteBatch.js.html#l418"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:418</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_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_WebGLSpriteBatch.js.html#l53"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:53</code></a>
</p>
</div>
<div class="description">
<p>Holds the indices</p>
</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_WebGLSpriteBatch.js.html#l30"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:30</code></a>
</p>
</div>
<div class="description">
<p>The number of images in the SpriteBatch before it flushes</p>
</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_WebGLSpriteBatch.js.html#l44"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:44</code></a>
</p>
</div>
<div class="description">
<p>Holds the vertices</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_WebGLSpriteBatch.js.html#l22"><code>src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:22</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>
