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 code: pixi/renderers/webgl/WebGLRenderer.js (Line 8)
Public Properties
-
autoResize : boolean
-
Whether the render view should be resized automatically
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 53)
-
blendModeManager : PIXI.WebGLBlendModeManager
-
Manages the blendModes
- Source code: 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 code: pixi/renderers/webgl/WebGLRenderer.js (Line 69)
-
filterManager : PIXI.WebGLFilterManager
-
Manages the filters
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 153)
-
game :PhaserGame
-
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 20)
-
height : number
-
The height of the canvas view
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 89)
-
maskManager : PIXI.WebGLMaskManager
-
Manages the masks using the stencil buffer
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 146)
-
offset :Point
-
- Source code: 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 code: pixi/renderers/webgl/WebGLRenderer.js (Line 61)
-
projection :Point
-
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 118)
-
renderSession : Object
-
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 174)
-
resolution : number
-
The resolution of the renderer
- Default Value
- 1
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 36)
-
shaderManager : PIXI.WebGLShaderManager
-
Deals with managing the shader programs and their attribs
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 132)
-
spriteBatch : PIXI.WebGLSpriteBatch
-
Manages the rendering of sprites
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 139)
-
stencilManager : PIXI.WebGLStencilManager
-
Manages the stencil buffer
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 160)
-
transparent : boolean
-
Whether the render view is transparent
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 45)
-
type : number
-
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 30)
-
view :HTMLCanvasElement
-
The canvas element that everything is drawn to
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 97)
-
width : number
-
The width of the canvas view
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 81)
Public Methods
-
destroy()
-
Removes everything from the renderer (event listeners, spritebatch, etc...)
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 398)
-
initContext()
-
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 204)
-
mapBlendModes()
-
Maps Pixi blend modes to WebGL blend modes.
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 430)
-
render(stage)
-
Renders the stage to its webGL view
Parameters
Name Type Description stageStage the Stage element to be rendered
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 243)
-
renderDisplayObject(displayObject, projection, buffer)
-
Renders a Display Object.
Parameters
Name Type Description displayObjectPIXI.DisplayObject The DisplayObject to render
projectionPoint The projection
bufferArray a standard WebGL buffer
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 278)
-
resize(width, height)
-
Resizes the webGL view to the specified width and height.
Parameters
Name Type Description widthNumber the new width of the webGL view
heightNumber the new height of the webGL view
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 315)
-
updateTexture(texture) → {Boolean}
-
Updates and Creates a WebGL texture for the renderers context.
Parameters
Name Type Description texturePIXI.Texture the texture to update
Returns
Boolean -True if the texture was successfully bound, otherwise false.
- Source code: pixi/renderers/webgl/WebGLRenderer.js (Line 341)