PIXI. WebGLRenderer

new WebGLRenderer(game)

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 webGLBatchs. So no need for Sprite Batches or Sprite Clouds. Don't forget to add the view to your DOM or you will not see anything :)

Parameters:
Name Type Description
game PhaserGame

A reference to the Phaser Game instance

Source - pixi/renderers/webgl/WebGLRenderer.js, line 8

Members

autoResize :Boolean

Whether the render view should be resized automatically

Source - pixi/renderers/webgl/WebGLRenderer.js, line 53

blendModeManager :PIXI.WebGLBlendModeManager

Manages the blendModes

Source - pixi/renderers/webgl/WebGLRenderer.js, line 167

clearBeforeRender :Boolean

This sets if the WebGLRenderer will clear the context texture or not before the new render pass. If true: If the Stage is NOT transparent, Pixi will clear to alpha (0, 0, 0, 0). If the Stage is transparent, Pixi will clear to the target Stage's background color. Disable this by setting this to false. For example: if your game has a canvas filling background image, you often don't need this set.

Source - pixi/renderers/webgl/WebGLRenderer.js, line 69

filterManager :PIXI.WebGLFilterManager

Manages the filters

Source - pixi/renderers/webgl/WebGLRenderer.js, line 153

game :PhaserGame

Source - pixi/renderers/webgl/WebGLRenderer.js, line 20

height :Number

The height of the canvas view

Source - pixi/renderers/webgl/WebGLRenderer.js, line 89

maskManager :PIXI.WebGLMaskManager

Manages the masks using the stencil buffer

Source - pixi/renderers/webgl/WebGLRenderer.js, line 146

offset :Point

Source - pixi/renderers/webgl/WebGLRenderer.js, line 124

preserveDrawingBuffer :Boolean

The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.

Source - pixi/renderers/webgl/WebGLRenderer.js, line 61

projection :Point

Source - pixi/renderers/webgl/WebGLRenderer.js, line 118

renderSession :Object

Source - pixi/renderers/webgl/WebGLRenderer.js, line 174

resolution :Number

The resolution of the renderer

Default Value:
  • 1
Source - pixi/renderers/webgl/WebGLRenderer.js, line 36

shaderManager :PIXI.WebGLShaderManager

Deals with managing the shader programs and their attribs

Source - pixi/renderers/webgl/WebGLRenderer.js, line 132

spriteBatch :PIXI.WebGLSpriteBatch

Manages the rendering of sprites

Source - pixi/renderers/webgl/WebGLRenderer.js, line 139

stencilManager :PIXI.WebGLStencilManager

Manages the stencil buffer

Source - pixi/renderers/webgl/WebGLRenderer.js, line 160

transparent :Boolean

Whether the render view is transparent

Source - pixi/renderers/webgl/WebGLRenderer.js, line 45

type :Number

Source - pixi/renderers/webgl/WebGLRenderer.js, line 30

view :HTMLCanvasElement

The canvas element that everything is drawn to

Source - pixi/renderers/webgl/WebGLRenderer.js, line 97

width :Number

The width of the canvas view

Source - pixi/renderers/webgl/WebGLRenderer.js, line 81

Methods

destroy()

Removes everything from the renderer (event listeners, spritebatch, etc...)

Source - pixi/renderers/webgl/WebGLRenderer.js, line 398

initContext()

Source - pixi/renderers/webgl/WebGLRenderer.js, line 204

mapBlendModes()

Maps Pixi blend modes to WebGL blend modes.

Source - pixi/renderers/webgl/WebGLRenderer.js, line 430

render(stage)

Renders the stage to its webGL view

Parameters:
Name Type Description
stage Stage

the Stage element to be rendered

Source - pixi/renderers/webgl/WebGLRenderer.js, line 243

renderDisplayObject(displayObject, projection, buffer)

Renders a Display Object.

Parameters:
Name Type Description
displayObject PIXI.DisplayObject

The DisplayObject to render

projection Point

The projection

buffer Array

a standard WebGL buffer

Source - pixi/renderers/webgl/WebGLRenderer.js, line 278

resize(width, height)

Resizes the webGL view to the specified width and height.

Parameters:
Name Type Description
width Number

the new width of the webGL view

height Number

the new height of the webGL view

Source - pixi/renderers/webgl/WebGLRenderer.js, line 315

updateTexture(texture) → {Boolean}

Updates and Creates a WebGL texture for the renderers context.

Parameters:
Name Type Description
texture PIXI.Texture

the texture to update

Returns:
Boolean -

True if the texture was successfully bound, otherwise false.

Source - pixi/renderers/webgl/WebGLRenderer.js, line 341
Phaser Copyright © 2012-2015 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.2 on Thu Feb 18 2016 14:41:11 GMT+0000 (GMT Standard Time) using the DocStrap template.