PIXI

Class: CanvasRenderer

PIXI. CanvasRenderer

new PIXI.CanvasRenderer(width, height, options)

core/renderers/canvas/CanvasRenderer.js, line 26

The CanvasRenderer draws the scene 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 :)

Name Type Default Description
width number 800 optional

the width of the canvas view
height number 600 optional

the height of the canvas view
options object optional

The optional renderer parameters

Name Type Default Description
view HTMLCanvasElement optional

the canvas to use as a view, optional
transparent boolean false optional

If the render view is transparent, default false
autoResize boolean false optional

If the render view is automatically resized, default false
antialias boolean false optional

sets antialias (only applicable in chrome at the moment)
resolution number 1 optional

the resolution of the renderer retina would be 2
clearBeforeRender boolean true optional

This sets if the CanvasRenderer will clear the canvas or
not before the new render pass.
roundPixels boolean false optional

If true Pixi will Math.floor() x/y values when rendering, stopping pixel interpolation.

Extends

Members

autoResizeboolean

Whether the render view should be resized automatically

backgroundColornumber

The background color to fill if not transparent

blendModesobject.<string, mixed>

Tracks the blend modes useful for this renderer.

clearBeforeRenderboolean

This sets if the CanvasRenderer will clear the canvas or not before the new render pass.
If the scene is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color.
If the scene 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.

contextCanvasRenderingContext2D

The canvas 2d context that everything is drawn with.

heightnumber

The height of the canvas view

Default Value:
  • 600

maskManagerPIXI.CanvasMaskManager

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

preserveDrawingBufferboolean

The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.

refreshboolean

Boolean flag controlling canvas refresh.

resolutionnumber

The resolution of the renderer

Default Value:
  • 1

roundPixelsboolean

If true Pixi will Math.floor() x/y values when rendering, stopping pixel interpolation.
Handy for crisp pixel art and speed on legacy devices.

smoothPropertystring

The canvas property used to set the canvas smoothing property.

transparentboolean

Whether the render view is transparent

typenumber

The type of the renderer.

Default Value:
  • PIXI.RENDERER_TYPE.UNKNOWN
See:

viewHTMLCanvasElement

The canvas element that everything is drawn to

widthnumber

The width of the canvas view

Default Value:
  • 800

Methods

destroy(removeView)

core/renderers/canvas/CanvasRenderer.js, line 162

Removes everything from the renderer and optionally removes the Canvas DOM element.

Name Type Default Description
removeView boolean false optional

Removes the Canvas element from the DOM.

render(object)

core/renderers/canvas/CanvasRenderer.js, line 112

Renders the object to this canvas view

Name Type Description
object PIXI.DisplayObject

the object to be rendered

resize(w, h)

core/renderers/canvas/CanvasRenderer.js, line 200
Name Type Description
w number
h number