WebGLRenderer Class
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 :)
Constructor
WebGLRenderer
-
[width=0] -
[height=0] -
[options]
Parameters:
-
[width=0]Number optionalthe width of the canvas view
-
[height=0]Number optionalthe height of the canvas view
-
[options]Object optionalThe optional renderer parameters
-
[view]HTMLCanvasElement optionalthe canvas to use as a view, optional
-
[transparent=false]Boolean optionalIf the render view is transparent, default false
-
[autoResize=false]Boolean optionalIf the render view is automatically resized, default false
-
[antialias=false]Boolean optionalsets antialias (only applicable in chrome at the moment)
-
[preserveDrawingBuffer=false]Boolean optionalenables drawing buffer preservation, enable this if you need to call toDataUrl on the webgl context
-
[resolution=1]Number optionalthe resolution of the renderer retina would be 2
-
Item Index
Methods
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:
-
stageStagethe Stage element to be rendered
renderDisplayObject
-
displayObject -
projection -
buffer
Renders a Display Object.
Parameters:
-
displayObjectDisplayObjectThe DisplayObject to render
-
projectionPointThe projection
-
bufferArraya standard WebGL buffer
resize
-
width -
height
Resizes the webGL view to the specified width and height.
Parameters:
-
widthNumberthe new width of the webGL view
-
heightNumberthe new height of the webGL view
updateTexture
-
texture
Updates and Creates a WebGL texture for the renderers context.
Parameters:
-
textureTexturethe texture to update
Properties
_contextOptions
Object
private
autoResize
Boolean
Whether the render view should be resized automatically
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.
contextLostBound
Function
contextRestoredBound
Function
height
Number
The height of the canvas view
Default: 600
preserveDrawingBuffer
Boolean
The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.
renderSession
Object
TODO remove
resolution
Number
The resolution of the renderer
Default: 1
transparent
Boolean
Whether the render view is transparent
type
Number
view
HTMLCanvasElement
The canvas element that everything is drawn to
width
Number
The width of the canvas view
Default: 800