PIXI.AbstractRenderer

class AbstractRenderer extends PIXI.utils.EventEmitter

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

Constructor

new PIXI.AbstractRenderer(type: PIXI.RENDERER_TYPE, options: IRendererOptions) → {}

Parameters:
Name	Type	Attributes	Default	Description
type	PIXI.RENDERER_TYPE			The renderer type.
options	IRendererOptions	<optional>		The optional renderer parameters.
options.width	number	<optional>	800	The width of the screen.
options.height	number	<optional>	600	The height of the screen.
options.view	HTMLCanvasElement	<optional>		The canvas to use as a view, optional.
options.useContextAlpha	boolean	<optional>	true	Pass-through value for canvas' context `alpha` property. If you want to set transparency, please use `backgroundAlpha`. This option is for cases where the canvas needs to be opaque, possibly for performance reasons on some older devices.
options.autoDensity	boolean	<optional>	false	Resizes renderer view in CSS pixels to allow for resolutions other than 1.
options.antialias	boolean	<optional>	false	Sets antialias
options.resolution	number	<optional>	PIXI.settings.RESOLUTION	The resolution / device pixel ratio of the renderer.
options.preserveDrawingBuffer	boolean	<optional>	false	Enables drawing buffer preservation, enable this if you need to call toDataUrl on the WebGL context.
options.clearBeforeRender	boolean	<optional>	true	This sets if the renderer will clear the canvas or not before the new render pass.
options.backgroundColor	number	<optional>	0x000000	The background color of the rendered area (shown if not transparent).
options.backgroundAlpha	number	<optional>	1	Value from 0 (fully transparent) to 1 (fully opaque).

Summary

Properties from AbstractRenderer

boolean	autoDensity = --
number	backgroundAlpha
number	backgroundColor
boolean	clearBeforeRender
number	height = 600
object	options
object	plugins
boolean	preserveDrawingBuffer
number	resolution = PIXI.settings.RESOLUTION
PIXI.Rectangle	screen Measurements of the screen. (0, 0, screenWidth, screenHeight).
number	type = PIXI.RENDERER_TYPE.UNKNOWN
boolean	useContextAlpha
HTMLCanvasElement	view
number	width = 800
number	protected _backgroundColor = 0
Array<number>	protected _backgroundColorRgba
string	protected _backgroundColorString = "#000000"
PIXI.DisplayObject	protected _lastObjectRendered = undefined

Methods from AbstractRenderer

this	addSystem(ClassRef: ISystemConstructor, name: string)
void	destroy(removeView: boolean)
PIXI.RenderTexture	generateTexture(displayObject: PIXI.IRenderableObject, options: object)
PIXI.RenderTexture	generateTexture(displayObject: PIXI.IRenderableObject, scaleMode: PIXI.SCALE_MODES, resolution: number, region: PIXI.Rectangle)
void	resize(desiredScreenWidth: number, desiredScreenHeight: number)
void	protected initPlugins(staticMap: object)

Public Properties

autoDensity AbstractRenderer.ts:154

autoDensity: boolean = --

Whether CSS dimensions of canvas view should be resized to screen dimensions automatically.

backgroundAlpha AbstractRenderer.ts:430

backgroundAlpha: number

The background color alpha. Setting this to 0 will make the canvas transparent.

backgroundColor AbstractRenderer.ts:414

backgroundColor: number

The background color to fill if not transparent

clearBeforeRender AbstractRenderer.ts:167

clearBeforeRender: boolean

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

height AbstractRenderer.ts:251

height: number = 600

Same as view.height, actual number of pixels in the canvas by vertical.

options AbstractRenderer.ts:111

options: object

The supplied constructor options.

plugins AbstractRenderer.ts:219

plugins: object

Collection of plugins.

preserveDrawingBuffer AbstractRenderer.ts:160

preserveDrawingBuffer: boolean

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

resolution AbstractRenderer.ts:140

resolution: number = PIXI.settings.RESOLUTION

The resolution / device pixel ratio of the renderer.

screen AbstractRenderer.ts:126

screen: PIXI.Rectangle

Measurements of the screen. (0, 0, screenWidth, screenHeight).

Its safe to use as filterArea or hitArea for the whole stage.

type AbstractRenderer.ts:118

type: number = PIXI.RENDERER_TYPE.UNKNOWN

The type of the renderer.

See: PIXI.RENDERER_TYPE

useContextAlpha AbstractRenderer.ts:147

useContextAlpha: boolean

Pass-thru setting for the canvas' context alpha property. This is typically not something you need to fiddle with. If you want transparency, use backgroundAlpha.

view AbstractRenderer.ts:134

view: HTMLCanvasElement

The canvas element that everything is drawn to.

width AbstractRenderer.ts:240

width: number = 800

Same as view.width, actual number of pixels in the canvas by horizontal.

Protected Properties

_backgroundColor AbstractRenderer.ts:178

protected _backgroundColor: number = 0

The background color as a number.

_backgroundColorRgba AbstractRenderer.ts:185

protected _backgroundColorRgba: Array<number>

The background color as an [R, G, B, A] array.

_backgroundColorString AbstractRenderer.ts:192

protected _backgroundColorString: string = "#000000"

The background color as a string.

_lastObjectRendered AbstractRenderer.ts:212

protected _lastObjectRendered: PIXI.DisplayObject = undefined

The last root object that the renderer tried to render.

Public Methods

addSystem AbstractRenderer.ts:372

addSystem(ClassRef: ISystemConstructor, name: string) → {this}

Adds a new system to the renderer.

Parameters:
Name	Type	Description
ClassRef	ISystemConstructor	Class reference
name	string	Property name for system

Returns:
Type	Description
this	Return instance of renderer

destroy AbstractRenderer.ts:382

destroy(removeView: boolean) → {void}

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

Parameters:
Name	Type	Attributes	Default	Description
removeView	boolean	<optional>	false	Removes the Canvas element from the DOM.

Returns:
Type	Description
void

generateTexture AbstractRenderer.ts:295

generateTexture(displayObject: PIXI.IRenderableObject, options: object) → {PIXI.RenderTexture}

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.

Parameters:
Name	Type	Attributes	Description
displayObject	PIXI.IRenderableObject		The displayObject the object will be generated from.
options	object	<optional>	Generate texture options.
options.scaleMode	PIXI.SCALE_MODES		The scale mode of the texture.
options.resolution	number		The resolution / device pixel ratio of the texture being generated.
options.region	PIXI.Rectangle		The region of the displayObject, that shall be rendered, if no region is specified, defaults to the local bounds of the displayObject.
options.multisample	PIXI.MSAA_QUALITY		The number of samples of the frame buffer.

Returns:
Type	Description
PIXI.RenderTexture	A texture of the graphics object.

generateTexture AbstractRenderer.ts:310

generateTexture(displayObject: PIXI.IRenderableObject, scaleMode: PIXI.SCALE_MODES, resolution: number, region: PIXI.Rectangle) → {PIXI.RenderTexture}

Deprecated: Since 6.1.0

Please use the options argument instead.

Parameters:
Name	Type	Attributes	Description
displayObject	PIXI.IRenderableObject		The displayObject the object will be generated from.
scaleMode	PIXI.SCALE_MODES	<optional>	The scale mode of the texture.
resolution	number	<optional>	The resolution / device pixel ratio of the texture being generated.
region	PIXI.Rectangle	<optional>	The region of the displayObject, that shall be rendered, if no region is specified, defaults to the local bounds of the displayObject.

Returns:
Type	Description
PIXI.RenderTexture	A texture of the graphics object.

resize AbstractRenderer.ts:262

resize(desiredScreenWidth: number, desiredScreenHeight: number) → {void}

Resizes the screen and canvas as close as possible to the specified width and height. Canvas dimensions are multiplied by resolution and rounded to the nearest integers. The new canvas dimensions divided by the resolution become the new screen dimensions.

Parameters:
Name	Type	Description
desiredScreenWidth	number	The desired width of the screen.
desiredScreenHeight	number	The desired height of the screen.

Returns:
Type	Description
void

Protected Methods

initPlugins AbstractRenderer.ts:227

protected initPlugins(staticMap: object) → {void}

Initialize the plugins.

Parameters:
Name	Type	Description
staticMap	object	The dictionary of statically saved plugins.

Returns:
Type	Description
void