new CanvasRenderer(game)
The CanvasRenderer draws the Stage and all its content onto a 2d canvas. This renderer should be used for browsers that do not support webGL.
Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :)
Parameters:
| Name | Type | Description |
|---|---|---|
game |
PhaserGame | A reference to the Phaser Game instance |
Members
-
autoResize :Boolean
-
Whether the render view should be resized automatically
-
CanvasMaskManager :PIXI.CanvasMaskManager
-
Instance of a PIXI.CanvasMaskManager, handles masking when using the canvas renderer
-
clearBeforeRender :Boolean
-
This sets if the CanvasRenderer will clear the canvas or not before the new render pass.
If the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color.
If the Stage is transparent Pixi will use clearRect to clear the canvas every frame.
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. -
context :CanvasRenderingContext2D
-
The canvas 2d context that everything is drawn with
-
count :Number
-
Internal var.
-
game :PhaserGame
-
height :Number
-
The height of the canvas view
- Default Value:
- 600
- Source - pixi/renderers/canvas/CanvasRenderer.js, line 78
-
refresh :Boolean
-
Boolean flag controlling canvas refresh.
-
renderSession :Object
-
The render session is just a bunch of parameter used for rendering
-
resolution :Number
-
The resolution of the canvas.
-
transparent :Boolean
-
Whether the render view is transparent
-
type :Number
-
The renderer type.
-
view :HTMLCanvasElement
-
The canvas element that everything is drawn to.
-
width :Number
-
The width of the canvas view
- Default Value:
- 800
- Source - pixi/renderers/canvas/CanvasRenderer.js, line 69
Methods
-
destroy(removeView)
-
Removes everything from the renderer and optionally removes the Canvas DOM element.
Parameters:
Name Type Argument Default Description removeViewBoolean <optional>
true Removes the Canvas element from the DOM.
-
render(root)
-
Renders the DisplayObjectContainer, usually the Phaser.Stage, to this canvas view.
Parameters:
Name Type Description rootPhaserStage | PIXIDisplayObjectContainer The root element to be rendered.
-
resize(width, height)
-
Resizes the canvas view to the specified width and height
Parameters:
Name Type Description widthNumber the new width of the canvas view
heightNumber the new height of the canvas view