LesserPanda

Class: SystemRenderer

SystemRenderer

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 :)

new SystemRenderer(system [, width] [, height] [, options])

Parameters:
Name Type Argument Default Description
system string

The name of the system this renderer is for.
width number <optional>
 800

the width of the canvas view
height number <optional>
 600

the height of the canvas view
options object <optional>

The optional renderer parameters

Properties
Name Type Argument Default Description
view HTMLCanvasElement <optional>

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

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

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

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

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

This sets if the CanvasRenderer will clear the canvas or
not before the new render pass.
backgroundColor number <optional>
 0x000000

The background color of the rendered area (shown if not transparent).
roundPixels boolean <optional>
 false

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

Members

autoResize :boolean

Whether the render view should be resized automatically

Type:
  • boolean
Source:

backgroundColor :number

The background color to fill if not transparent

Type:
  • number
Source:

blendModes :object.<string, mixed>

Tracks the blend modes useful for this renderer.

Type:
  • object.<string, mixed>
Source:

clearBeforeRender :boolean

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.

Type:
  • boolean
Source:

height :number

The height of the canvas view

Type:
  • number
Default Value:
  • 600
Source:

preserveDrawingBuffer :boolean

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

Type:
  • boolean
Source:

resolution :number

The resolution of the renderer

Type:
  • number
Default Value:
  • 1
Source:

roundPixels :boolean

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

Type:
  • boolean
Source:

transparent :boolean

Whether the render view is transparent

Type:
  • boolean
Source:

type :number

The type of the renderer.

Type:
  • number
Default Value:
  • RENDERER_TYPE.UNKNOWN
Source:
See:
  • RENDERER_TYPE

view :HTMLCanvasElement

The canvas element that everything is drawn to

Type:
  • HTMLCanvasElement
Source:

width :number

The width of the canvas view

Type:
  • number
Default Value:
  • 800
Source:

Methods

destroy( [removeView])

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

Parameters:
Name Type Argument Default Description
removeView boolean <optional>
 false

Removes the Canvas element from the DOM.
Source:

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: