CanvasRenderer Class
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. Dont forget to add the view to your DOM or you will not see anything :)
Constructor
CanvasRenderer
-
[width=800] -
[height=600] -
[options]
Parameters:
-
[width=800]Number optionalthe width of the canvas view
-
[height=600]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
-
[resolution=1]Number optionalthe resolution of the renderer retina would be 2
-
[clearBeforeRender=true]Boolean optionalThis sets if the CanvasRenderer will clear the canvas or not before the new render pass.
-
Item Index
Methods
Methods
CanvasBuffer
-
width -
height
Creates a Canvas element of the given size
Parameters:
-
widthNumberthe width for the newly created canvas
-
heightNumberthe height for the newly created canvas
clear
()
private
Clears the canvas that was created by the CanvasBuffer class
render
-
stage
Renders the stage to its canvas view
Parameters:
-
stageStagethe Stage element to be rendered
renderDisplayObject
-
displayObject -
context
Renders a display object
Parameters:
-
displayObjectDisplayObjectThe displayObject to render
-
contextCanvasRenderingContext2Dthe context 2d method of the canvas
resize
-
width -
height
Resizes the canvas view to the specified width and height
Parameters:
-
widthNumberthe new width of the canvas view
-
heightNumberthe new height of the canvas view
resize
-
width -
height
Resizes the canvas that was created by the CanvasBuffer class to the specified width and height
Parameters:
-
widthNumberthe new width of the canvas
-
heightNumberthe new height of the canvas
Properties
CanvasMaskManager
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 2d Context
The canvas 2d context that everything is drawn with
height
Number
The height of the canvas view
Default: 600
renderSession
Object
The render session is just a bunch of parameter used for rendering
transparent
Boolean
Whether the render view is transparent
view
HTMLCanvasElement
The canvas element that everything is drawn to
width
Number
The width of the canvas view
Default: 800