new WebGLRenderer(width, height, options)
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 | Argument | Default | Description |
|---|---|---|---|---|
width |
Number |
<optional> |
0 | the width of the canvas view |
height |
Number |
<optional> |
0 | the height of the canvas view |
options |
Object |
<optional> |
The optional renderer parameters |
- 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 70
-
blendModeManager :PIXI.WebGLBlendModeManager
-
Manages the blendModes
-
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 86
-
contextLostBound :function
-
contextRestoredBound :function
-
filterManager :PIXI.WebGLFilterManager
-
Manages the filters
-
height :Number
-
The height of the canvas view
- Default Value:
- 600
- Source - pixi/renderers/webgl/WebGLRenderer.js, line 107
-
maskManager :PIXI.WebGLMaskManager
-
Manages the masks using the stencil buffer
-
offset :Point
-
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 78
-
projection :Point
-
renderSession :Object
-
TODO remove
-
resolution :Number
-
The resolution of the renderer
- Default Value:
- 1
- Source - pixi/renderers/webgl/WebGLRenderer.js, line 51
-
shaderManager :PIXI.WebGLShaderManager
-
Deals with managing the shader programs and their attribs
-
spriteBatch :PIXI.WebGLSpriteBatch
-
Manages the rendering of sprites
-
stencilManager :PIXI.WebGLStencilManager
-
Manages the stencil buffer
-
transparent :Boolean
-
Whether the render view is transparent
- Source - pixi/renderers/webgl/WebGLRenderer.js, line 62
-
type :Number
-
- Source - pixi/renderers/webgl/WebGLRenderer.js, line 45
-
view :HTMLCanvasElement
-
The canvas element that everything is drawn to
-
width :Number
-
The width of the canvas view
- Default Value:
- 800
- Source - pixi/renderers/webgl/WebGLRenderer.js, line 98
Methods
-
destroy()
-
Removes everything from the renderer (event listeners, spritebatch, etc...)
-
initContext()
-
mapBlendModes()
-
Maps Pixi blend modes to WebGL blend modes.
-
render(stage)
-
Renders the stage to its webGL view
Parameters:
Name Type Description stagePIXI.Stage the Stage element to be rendered
-
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
-
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
-
updateTexture(texture)
-
Updates and Creates a WebGL texture for the renderers context.
Parameters:
Name Type Description texturePIXI.Texture the texture to update