PixiJS

Class: AbstractRenderer

PIXI.AbstractRenderer

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.

new PIXI.AbstractRenderer (type, options) overrides

AbstractRenderer.ts:144
Name Type Attributes Default Description
type

The renderer type.
options PIXI.IRendererOptions <optional>

The optional renderer parameters.
options.antialias boolean <optional>
 false

WebGL Only. Whether to enable anti-aliasing. This may affect performance.
options.autoDensity boolean <optional>
 false

Whether the CSS dimensions of the renderer's view should be resized automatically.
options.backgroundAlpha number <optional>
 1

Transparency of the background color, value from 0 (fully transparent) to 1 (fully opaque).
options.backgroundColor number <optional>
 0x000000

The background color used to clear the canvas. It accepts hex numbers (e.g. 0xff0000).
options.clearBeforeRender boolean <optional>
 true

Whether to clear the canvas before new render passes.
options.context PIXI.IRenderingContext <optional>

WebGL Only. User-provided WebGL rendering context object.
options.height number <optional>
 600

The height of the renderer's view.
options.powerPreference string <optional>

WebGL Only. A hint indicating what configuration of GPU is suitable for the WebGL context, can be 'default', 'high-performance' or 'low-power'. Setting to 'high-performance' will prioritize rendering performance over power consumption, while setting to 'low-power' will prioritize power saving over rendering performance.
options.premultipliedAlpha boolean <optional>
 true

WebGL Only. Whether the compositor will assume the drawing buffer contains colors with premultiplied alpha.
options.preserveDrawingBuffer boolean <optional>
 false

WebGL Only. Whether to enable drawing buffer preservation. If enabled, the drawing buffer will preserve its value until cleared or overwritten. Enable this if you need to call toDataUrl on the WebGL context.
options.resolution number <optional>
 PIXI.settings.RESOLUTION

The resolution / device pixel ratio of the renderer.
options.transparent boolean <optional>

Deprecated since 6.0.0, Use backgroundAlpha instead.
true sets backgroundAlpha to 0, false sets backgroundAlpha to 1.
options.useContextAlpha boolean | 'notMultiplied' <optional>
 true

Pass-through value for canvas' context attribute alpha. This option is for cases where the canvas needs to be opaque, possibly for performance reasons on some older devices. If you want to set transparency, please use backgroundAlpha.
WebGL Only: When set to 'notMultiplied', the canvas' context attribute alpha will be set to true and premultipliedAlpha will be to false.
options.view HTMLCanvasElement <optional>
 null

The canvas to use as the view. If omitted, a new canvas will be created.
options.width number <optional>
 800

The width of the renderer's view.

Extends

Members

autoDensity boolean

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

Default Value:
  • --

backgroundAlpha number

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

backgroundColor number

The background color to fill if not transparent

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 number readonly

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

Default Value:
  • 600

options object readonly

The supplied constructor options.

plugins object readonly

Collection of plugins.

preserveDrawingBuffer boolean

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

resolution number

The resolution / device pixel ratio of the renderer.

Default Value:
  • PIXI.settings.RESOLUTION

screen PIXI.Rectangle

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

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

type number

The type of the renderer.

Default Value:
  • PIXI.RENDERER_TYPE.UNKNOWN
See:

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 HTMLCanvasElement

The canvas element that everything is drawn to.

width number readonly

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

Default Value:
  • 800

_backgroundColor number protected

The background color as a number.

Default Value:
  • 0

_backgroundColorRgba Array<number> protected

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

_backgroundColorString string protected

The background color as a string.

Default Value:
  • "#000000"

_lastObjectRendered PIXI.DisplayObject protected

The last root object that the renderer tried to render.

Default Value:
  • undefined

Methods

addSystem (ClassRef, name) this abstract

AbstractRenderer.ts:451

Adds a new system to the renderer.

Name Type Description
ClassRef ISystemConstructor

Class reference
name string

Property name for system
Returns:
Type Description
this Return instance of renderer

destroy (removeView) void

AbstractRenderer.ts:461

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

Name Type Attributes Default Description
removeView boolean <optional>
 false

Removes the Canvas element from the DOM.

generateTexture (displayObject, options) PIXI.RenderTexture overrides

AbstractRenderer.ts:374

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 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 (displayObject, scaleMode, resolution, region) PIXI.RenderTexture Deprecated`` : Since 6.1.0

AbstractRenderer.ts:389

Please use the options argument instead.

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 (desiredScreenWidth, desiredScreenHeight) void

AbstractRenderer.ts:341

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.

Name Type Description
desiredScreenWidth number

The desired width of the screen.
desiredScreenHeight number

The desired height of the screen.

initPlugins (staticMap) void protected

AbstractRenderer.ts:306

Initialize the plugins.

Name Type Description
staticMap object

The dictionary of statically saved plugins.