PixiJS

Class: AbstractRenderer

AbstractRenderer

The SystemManager is a class that provides functions for managing a set of systems This is a base class, that is generic (no render code or knowledge at all)

new AbstractRenderer (config)

ts:128

Set up a system with a collection of SystemClasses and runners. Systems are attached dynamically to this class when added.

Name Type Description
config RendererConfig

the config for the system manager

Members

failIfMajorPerformanceCaveat boolean static

Should the failIfMajorPerformanceCaveat flag be enabled as a context option used in the isWebGLSupported function. If set to true, a WebGL renderer can fail to be created if the browser thinks there could be performance issues when using WebGL.

In PixiJS v6 this has changed from true to false by default, to allow WebGL to work in as many scenarios as possible. However, some users may have a poor experience, for example, if a user has a gpu or driver version blacklisted by the browser.

If your application requires high performance rendering, you may wish to set this to false. We recommend one of two options if you decide to set this flag to false:

1: Use the Canvas renderer as a fallback in case high performance WebGL is not supported.

2: Call isWebGLSupported (which if found in the utils package) in your code before attempting to create a PixiJS renderer, and show an error message to the user if the function returns false, explaining that their device & browser combination does not support high performance WebGL. This is a much better strategy than trying to create a PixiJS renderer and finding it then fails.

Default Value:
  • false

roundPixels boolean static

Should round pixels be forced when rendering?

Default Value:
  • false

_roundPixels 0 | 1

canvas CANVAS

The canvas element that everything is drawn to.

height number

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

Default Value:
  • 600

lastObjectRendered Container readonly

the last object rendered by the renderer. Useful for other plugins like interaction managers

renderingToScreen boolean readonly

Flag if we are rendering to the screen vs renderTexture

Default Value:
  • true

resolution number

Default resolution / device pixel ratio of the renderer.

Default Value:
  • 1

resolution number

The resolution / device pixel ratio of the renderer.

roundPixels boolean

Whether the renderer will round coordinates to whole pixels when rendering. Can be overridden on a per scene item basis.

screen Rectangle

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

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

width number readonly

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

Default Value:
  • 800

Methods

generateTexture (options) Texture Deprecated`` : since 8.0.0

ts:426
Name Type Description
options GenerateTextureOptions | Container

options or container target to use when generating the texture
Returns:
Type Description
Texture a texture

init (options)

ts:148

Initialize the renderer.

Name Type Description
options Partial<OPTIONS>

The options to use to create the renderer.

render (args, deprecated) void Deprecated`` : since 8.0.0

ts:177
Name Type Attributes Description
args RenderOptions | Container
deprecated {
   renderTexture: any
} 		<optional>

render (options) void

ts:179

Renders the object to its view.

Name Type Attributes Description
options RenderOptions | Container

The options to render with.
options.container

The container to render.
options.target <optional>

The target to render to.

resize (desiredScreenWidth, desiredScreenHeight, resolution) void

ts:233

Resizes the WebGL view to the specified width and height.

Name Type Attributes Description
desiredScreenWidth number

The desired width of the screen.
desiredScreenHeight number

The desired height of the screen.
resolution number <optional>

The resolution / device pixel ratio of the renderer.