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 (system, options) overrides

AbstractRenderer.ts:81
Name Type Attributes Default Description
system

The name of the system this renderer is for.

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

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

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

destroy (removeView) void

AbstractRenderer.ts:391

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

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

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

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

Initialize the plugins.

Name Type Description
staticMap object

The dictionary of statically saved plugins.