<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>WebGLRenderer - 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>WebGLRenderer Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l7"><code>src/pixi/renderers/webgl/WebGLRenderer.js:7</code></a>
</div>
Module: <a href="../modules/PIXI.html">PIXI</a>
</div>
<div class="box intro">
<p>the WebGLRenderer draws the stage and all its content onto a webGL enabled canvas. This renderer
should be used for browsers that support webGL. This Render works by automatically managing webGLBatch's.
So no need for Sprite Batch's or Sprite Cloud's
Dont forget to add the view to your DOM or you will not see anything :)</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_WebGLRenderer" class="method item">
<h3 class="name"><code>WebGLRenderer</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[width=0]</code>
</li>
<li class="arg">
<code class="optional">[height=0]</code>
</li>
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l7"><code>src/pixi/renderers/webgl/WebGLRenderer.js:7</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 optional">[width=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the width of the canvas view</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[height=0]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the height of the canvas view</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The optional renderer parameters</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[view]</code>
<span class="type">HTMLCanvasElement</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the canvas to use as a view, optional</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[transparent=false]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>If the render view is transparent, default false</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[antialias=false]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>sets antialias (only applicable in chrome at the moment)</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[preserveDrawingBuffer=false]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>enables drawing buffer preservation, enable this if you need to call toDataUrl on the webgl context</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[resolution=1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the resolution of the renderer retina would be 2</p>
</div>
</li>
</ul>
</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 private">
<a href="#method_handleContextLost">handleContextLost</a>
</li>
<li class="index-item method private">
<a href="#method_handleContextRestored">handleContextRestored</a>
</li>
<li class="index-item method">
<a href="#method_render">render</a>
</li>
<li class="index-item method">
<a href="#method_renderDIsplayObject">renderDIsplayObject</a>
</li>
<li class="index-item method">
<a href="#method_resize">resize</a>
</li>
<li class="index-item method">
<a href="#method_updateTexture">updateTexture</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_height">height</a>
</li>
<li class="index-item property">
<a href="#property_preserveDrawingBuffer">preserveDrawingBuffer</a>
</li>
<li class="index-item property">
<a href="#property_resolution">resolution</a>
</li>
<li class="index-item property">
<a href="#property_transparent">transparent</a>
</li>
<li class="index-item property">
<a href="#property_view">view</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_renderers_webgl_WebGLRenderer.js.html#l383"><code>src/pixi/renderers/webgl/WebGLRenderer.js:383</code></a>
</p>
</div>
<div class="description">
<p>Removes everything from the renderer (event listeners, spritebatch, etc...)</p>
</div>
</div>
<div id="method_handleContextLost" class="method item private">
<h3 class="name"><code>handleContextLost</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_renderers_webgl_WebGLRenderer.js.html#l349"><code>src/pixi/renderers/webgl/WebGLRenderer.js:349</code></a>
</p>
</div>
<div class="description">
<p>Handles a lost webgl context</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_handleContextRestored" class="method item private">
<h3 class="name"><code>handleContextRestored</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_renderers_webgl_WebGLRenderer.js.html#l362"><code>src/pixi/renderers/webgl/WebGLRenderer.js:362</code></a>
</p>
</div>
<div class="description">
<p>Handles a restored webgl context</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>
<div class="param-description">
</div>
</li>
</ul>
</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>stage</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l184"><code>src/pixi/renderers/webgl/WebGLRenderer.js:184</code></a>
</p>
</div>
<div class="description">
<p>Renders the stage to its webGL view</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">stage</code>
<span class="type"><a href="../classes/Stage.html" class="crosslink">Stage</a></span>
<div class="param-description">
<p>the Stage element to be rendered</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_renderDIsplayObject" class="method item">
<h3 class="name"><code>renderDIsplayObject</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>displayObject</code>
</li>
<li class="arg">
<code>projection</code>
</li>
<li class="arg">
<code>buffer</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l251"><code>src/pixi/renderers/webgl/WebGLRenderer.js:251</code></a>
</p>
</div>
<div class="description">
<p>Renders a display Object</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">displayObject</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
<p>The DisplayObject to render</p>
</div>
</li>
<li class="param">
<code class="param-name">projection</code>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<div class="param-description">
<p>The projection</p>
</div>
</li>
<li class="param">
<code class="param-name">buffer</code>
<span class="type">Array</span>
<div class="param-description">
<p>a standard WebGL buffer</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_resize" class="method item">
<h3 class="name"><code>resize</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>width</code>
</li>
<li class="arg">
<code>height</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l285"><code>src/pixi/renderers/webgl/WebGLRenderer.js:285</code></a>
</p>
</div>
<div class="description">
<p>resizes the webGL view to the specified width and height</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">width</code>
<span class="type">Number</span>
<div class="param-description">
<p>the new width of the webGL view</p>
</div>
</li>
<li class="param">
<code class="param-name">height</code>
<span class="type">Number</span>
<div class="param-description">
<p>the new height of the webGL view</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_updateTexture" class="method item">
<h3 class="name"><code>updateTexture</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>texture</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l310"><code>src/pixi/renderers/webgl/WebGLRenderer.js:310</code></a>
</p>
</div>
<div class="description">
<p>Updates and Creates a WebGL texture for the renderers context</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">
<p>the texture to render</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<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_renderers_webgl_WebGLRenderer.js.html#l84"><code>src/pixi/renderers/webgl/WebGLRenderer.js:84</code></a>
</p>
</div>
<div class="description">
<p>The height of the canvas view</p>
</div>
<p><strong>Default:</strong> 600</p>
</div>
<div id="property_preserveDrawingBuffer" class="property item">
<h3 class="name"><code>preserveDrawingBuffer</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l67"><code>src/pixi/renderers/webgl/WebGLRenderer.js:67</code></a>
</p>
</div>
<div class="description">
<p>The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.</p>
</div>
</div>
<div id="property_resolution" class="property item">
<h3 class="name"><code>resolution</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l49"><code>src/pixi/renderers/webgl/WebGLRenderer.js:49</code></a>
</p>
</div>
<div class="description">
<p>The resolution of the renderer</p>
</div>
<p><strong>Default:</strong> 1</p>
</div>
<div id="property_transparent" class="property item">
<h3 class="name"><code>transparent</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l59"><code>src/pixi/renderers/webgl/WebGLRenderer.js:59</code></a>
</p>
</div>
<div class="description">
<p>Whether the render view is transparent</p>
</div>
</div>
<div id="property_view" class="property item">
<h3 class="name"><code>view</code></h3>
<span class="type">HTMLCanvasElement</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_renderers_webgl_WebGLRenderer.js.html#l93"><code>src/pixi/renderers/webgl/WebGLRenderer.js:93</code></a>
</p>
</div>
<div class="description">
<p>The canvas element that everything is drawn to</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_renderers_webgl_WebGLRenderer.js.html#l75"><code>src/pixi/renderers/webgl/WebGLRenderer.js:75</code></a>
</p>
</div>
<div class="description">
<p>The width of the canvas view</p>
</div>
<p><strong>Default:</strong> 800</p>
</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>
