PIXI. CanvasRenderer

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

Source - pixi/renderers/canvas/CanvasRenderer.js, line 5

Members

autoResize :Boolean

Whether the render view should be resized automatically

Source - pixi/renderers/canvas/CanvasRenderer.js, line 61

CanvasMaskManager :PIXI.CanvasMaskManager

Instance of a PIXI.CanvasMaskManager, handles masking when using the canvas renderer

Source - pixi/renderers/canvas/CanvasRenderer.js, line 118

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.

Source - pixi/renderers/canvas/CanvasRenderer.js, line 41

context :CanvasRenderingContext2D

The canvas 2d context that everything is drawn with

Source - pixi/renderers/canvas/CanvasRenderer.js, line 95

count :Number

Internal var.

Source - pixi/renderers/canvas/CanvasRenderer.js, line 110

game :PhaserGame

Source - pixi/renderers/canvas/CanvasRenderer.js, line 15

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.

Source - pixi/renderers/canvas/CanvasRenderer.js, line 102

renderSession :Object

The render session is just a bunch of parameter used for rendering

Source - pixi/renderers/canvas/CanvasRenderer.js, line 125

resolution :Number

The resolution of the canvas.

Source - pixi/renderers/canvas/CanvasRenderer.js, line 33

transparent :Boolean

Whether the render view is transparent

Source - pixi/renderers/canvas/CanvasRenderer.js, line 53

type :Number

The renderer type.

Source - pixi/renderers/canvas/CanvasRenderer.js, line 25

view :HTMLCanvasElement

The canvas element that everything is drawn to.

Source - pixi/renderers/canvas/CanvasRenderer.js, line 87

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
removeView Boolean <optional>
true

Removes the Canvas element from the DOM.

Source - pixi/renderers/canvas/CanvasRenderer.js, line 195

render(stage)

Renders the Stage to this canvas view

Parameters:
Name Type Description
stage Stage

the Stage element to be rendered

Source - pixi/renderers/canvas/CanvasRenderer.js, line 152

resize(width, height)

Resizes the canvas view to the specified width and height

Parameters:
Name Type Description
width Number

the new width of the canvas view

height Number

the new height of the canvas view

Source - pixi/renderers/canvas/CanvasRenderer.js, line 217
Phaser Copyright © 2012-2016 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.2 on Thu May 19 2016 12:35:48 GMT+0100 (GMT Daylight Time) using the DocStrap template.