PixiJS

Interface: IRenderer

PIXI.IRenderer

Standard Interface for a Pixi renderer.

Properties:
Name Type Description
runners { [key: string]: PIXI.Runner }

a collection of runners defined by the user
autoDensity boolean

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

Background color, alpha and clear behavior
height number

the height of the screen
lastObjectRendered PIXI.IRenderableObject

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

The number of MSAA samples of the renderer.
options PIXI.IRendererOptions

The options passed in to create a new instance of the renderer.
plugins IRendererPlugins

Collection of plugins
rendererLogId string

When logging Pixi to the console, this is the name we will show
renderingToScreen boolean

Flag if we are rendering to the screen vs renderTexture
resolution number

The resolution / device pixel ratio of the renderer.
screen PIXI.Rectangle

Measurements of the screen. (0, 0, screenWidth, screenHeight). Its safe to use as filterArea or hitArea for the whole stage.
type PIXI.RENDERER_TYPE

The type of the renderer.
view VIEW

The canvas element that everything is drawn to.
width number

the width of the screen

Extends

Members

autoDensity boolean readonly

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

background PIXI.BackgroundSystem readonly

Background color, alpha and clear behavior

height number readonly

the height of the screen

lastObjectRendered PIXI.IRenderableObject readonly

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

multisample PIXI.MSAA_QUALITY

The number of MSAA samples of the renderer.

options PIXI.IRendererOptions readonly

The options passed in to create a new instance of the renderer.

plugins IRendererPlugins readonly

Collection of plugins

rendererLogId string readonly

When logging Pixi to the console, this is the name we will show

renderingToScreen boolean readonly

Flag if we are rendering to the screen vs renderTexture

resolution number

The resolution / device pixel ratio of the renderer.

screen PIXI.Rectangle readonly

Measurements of the screen. (0, 0, screenWidth, screenHeight). Its safe to use as filterArea or hitArea for the whole stage.

type PIXI.RENDERER_TYPE readonly

The type of the renderer.

See:

view VIEW readonly

The canvas element that everything is drawn to.

width number readonly

the width of the screen

Inherited Properties

From class PIXI.SystemManager

runners { [key: string]: PIXI.Runner } readonly inherited

a collection of runners defined by the user

Inherited Methods

From class PIXI.SystemManager

addRunners (…runnerIds) void inherited

SystemManager.ts:51

Create a bunch of runners based of a collection of ids

Name Type Description
runnerIds string[]

the runner ids to add

addSystem (ClassRef, name) this inherited

SystemManager.ts:63

Add a new system to the renderer.

Name Type Description
ClassRef ISystemConstructor<R>

Class reference
name string

Property name for system, if not specified will use a static name property on the class itself. This name will be assigned as s property on the Renderer so make sure it doesn't collide with properties on Renderer.
Returns:
Type Description
this Return instance of renderer

destroy () void inherited

SystemManager.ts:140

destroy the all runners and systems. Its apps job to

emitWithCustomOptions (runner, options) void inherited

SystemManager.ts:109

A function that will run a runner and call the runners function but pass in different options to each system based on there name.

E.g. If you have two systems added called systemA and systemB you could call do the following:

system.emitWithCustomOptions(init, {
    systemA: {...optionsForA},
    systemB: {...optionsForB},
});

init would be called on system A passing optionsForA and on system B passing optionsForB.

Name Type Description
runner PIXI.Runner

the runner to target
options Record<string, unknown>

key value options for each system

setup (config) void inherited

SystemManager.ts:26

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

Name Type Description
config ISystemConfig<R>

the config for the system manager