Interface IRenderer<VIEW>

Standard Interface for a Pixi renderer.

Memberof

PIXI

interface IRenderer<VIEW> {
    autoDensity: boolean;
    background: BackgroundSystem;
    events: EventSystem;
    extract: IExtract;
    height: number;
    lastObjectRendered: IRenderableObject;
    multisample?: MSAA_QUALITY;
    options: IRendererOptions;
    plugins: IRendererPlugins;
    prepare: BasePrepare;
    rendererLogId: string;
    renderingToScreen: boolean;
    resolution: number;
    runners: {
        [key: string]: Runner;
    };
    screen: Rectangle;
    type: RENDERER_TYPE;
    view: VIEW;
    width: number;
    addListener<T>(event, fn, context?): this;
    addRunners(...runnerIds): void;
    addSystem(ClassRef, name): this;
    clear(): void;
    destroy(removeView?): void;
    emit<T>(event, ...args): boolean;
    emitWithCustomOptions(runner, options): void;
    eventNames(): (string | symbol)[];
    generateTexture(displayObject, options?): RenderTexture;
    listenerCount(event): number;
    listeners<T>(event): ((...args) => void)[];
    off<T>(event, fn?, context?, once?): this;
    on<T>(event, fn, context?): this;
    once<T>(event, fn, context?): this;
    removeAllListeners(event?): this;
    removeListener<T>(event, fn?, context?, once?): this;
    render(displayObject, options?): void;
    reset(): void;
    resize(width, height): void;
    setup(config): void;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

autoDensity background events extract height lastObjectRendered multisample? options plugins prepare rendererLogId renderingToScreen resolution runners screen type view width

Methods

addListener addRunners addSystem clear destroy emit emitWithCustomOptions eventNames generateTexture listenerCount listeners off on once removeAllListeners removeListener render reset resize setup

Properties

Readonly autoDensity

autoDensity: boolean

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

Readonly background

background: BackgroundSystem

Background color, alpha and clear behavior

Readonly events

events: EventSystem

Readonly extract

extract: IExtract

Readonly height

height: number

the height of the screen

Readonly lastObjectRendered

lastObjectRendered: IRenderableObject

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

Optional multisample

multisample?: MSAA_QUALITY

The number of MSAA samples of the renderer.

Readonly options

options: IRendererOptions

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

Readonly plugins

plugins: IRendererPlugins

Collection of plugins

Readonly prepare

prepare: BasePrepare

Readonly rendererLogId

rendererLogId: string

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

Readonly renderingToScreen

renderingToScreen: boolean

Flag if we are rendering to the screen vs renderTexture

resolution

resolution: number

The resolution / device pixel ratio of the renderer.

Readonly runners

runners: {
    [key: string]: Runner;
}

a collection of runners defined by the user

Type declaration

Readonly screen

screen: Rectangle

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

Readonly type

type: RENDERER_TYPE

The type of the renderer.

See

PIXI.RENDERER_TYPE

Readonly view

view: VIEW

The canvas element that everything is drawn to.

Readonly width

width: number

the width of the screen

Methods

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

addRunners

  • addRunners(...runnerIds): void

  • Create a bunch of runners based of a collection of ids

    Parameters

    • Rest ...runnerIds: string[]

      the runner ids to add

    Returns void

addSystem

  • addSystem(ClassRef, name): this

  • Add a new system to the renderer.

    Parameters

    • ClassRef: ISystemConstructor<IRenderer<ICanvas>>

      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 this

    Return instance of renderer

clear

  • clear(): void

  • Returns void

destroy

  • destroy(removeView?): void

  • destroy the all runners and systems. Its apps job to

    Parameters

    • Optional removeView: boolean

    Returns void

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Rest ...args: any[]

    Returns boolean

emitWithCustomOptions

  • emitWithCustomOptions(runner, options): void

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

    Parameters

    • runner: Runner<any, any[]>

      the runner to target

    • options: Record<string, unknown>

      key value options for each system

    Returns void

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

generateTexture

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners<T>(event): ((...args) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

    Returns ((...args) => void)[]

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on<T>(event, fn, context?): this

  • Add a listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

render

reset

  • reset(): void

  • Returns void

resize

  • resize(width, height): void

  • Parameters

    • width: number
    • height: number

    Returns void

setup

  • setup(config): void

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

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

autoDensitybackgroundeventsextractheightlastObjectRenderedmultisampleoptionspluginspreparerendererLogIdrenderingToScreenresolutionrunnersscreentypeviewwidthaddListeneraddRunnersaddSystemcleardestroyemitemitWithCustomOptionseventNamesgenerateTexturelistenerCountlistenersoffononceremoveAllListenersremoveListenerrenderresetresizesetup

Generated using TypeDoc