PIXI

Class: SystemRenderer

PIXI. SystemRenderer

The SystemRenderer is the base for a Pixi Renderer. It is extended by the PIXI.CanvasRenderer
and PIXI.WebGLRenderer which can be used for rendering a Pixi scene.

abstractnew PIXI.SystemRenderer(system, width, height, options)

core/renderers/SystemRenderer.js, line 22
Name Type Default Description
system string

The name of the system this renderer is for.
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 / device pixel ratio of the renderer. 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.
backgroundColor number 0x000000 optional

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

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

Extends

  • EventEmitter

Members

backgroundColor

Sets the background color.

Methods

destroy(removeView)

core/renderers/SystemRenderer.js, line 245

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.

generateTexture(displayObject, scaleMode, resolution){PIXI.Texture}

core/renderers/SystemRenderer.js, line 226

Useful function that returns a texture of the display object that can then be used to create sprites
This can be quite useful if your displayObject is complicated and needs to be reused multiple times.

Name Type Description
displayObject PIXI.DisplayObject

The displayObject the object will be generated from
scaleMode number

Should be one of the scaleMode consts
resolution number

The resolution / device pixel ratio of the texture being generated
Returns:
Type Description
PIXI.Texture a texture of the graphics object

resize(width, height)

core/renderers/SystemRenderer.js, line 202

Resizes the canvas view to the specified width and height

Name Type Description
width number

the new width of the canvas view
height number

the new height of the canvas view