ecspresso
    Preparing search index...

    Interface Renderer2DPluginManagedOptions<G>

    Options when letting the plugin create and manage the PixiJS Application

    interface Renderer2DPluginManagedOptions<G extends string = "renderer2d"> {
        app?: undefined;
        background?: ColorSource;
        camera?: boolean;
        container?: string | HTMLElement;
        height?: number;
        pixiInit?: Partial<ApplicationOptions>;
        renderLayers?: string[];
        renderSyncPriority?: number;
        rootContainer?: Container<ContainerChild>;
        screenScale?: ScreenScaleOptions;
        screenSpaceLayers?: string[];
        startLoop?: boolean;
        systemGroup?: G;
        transform?: TransformPluginOptions<"transform">;
        width?: number;
    }

    Type Parameters

    • G extends string = "renderer2d"

    Hierarchy

    • Renderer2DPluginCommonOptions<G>
      • Renderer2DPluginManagedOptions
    Index

    Properties

    app? background? camera? container? height? pixiInit? renderLayers? renderSyncPriority? rootContainer? screenScale? screenSpaceLayers? startLoop? systemGroup? transform? width?

    Properties

    app?: undefined
    background?: ColorSource

    Canvas background color.

    camera?: boolean

    Automatically apply cameraState resource to rootContainer each frame. Requires the camera plugin to be installed. (default: false)

    container?: string | HTMLElement

    Container element to append the canvas to (or CSS selector string). Defaults to document.body. The canvas also auto-resizes to this element unless width/height are set or pixiInit.resizeTo is set explicitly.

    height?: number

    Fixed canvas height. When set (with width), the canvas is fixed-size and the auto-resize default is suppressed.

    pixiInit?: Partial<ApplicationOptions>

    Escape hatch for raw PixiJS ApplicationOptions not otherwise exposed at the top level. Top-level fields (background, width, height) take precedence when both are set.

    renderLayers?: string[]

    Ordered render layer names (back-to-front). Entities with a renderLayer component are placed in the corresponding container.

    renderSyncPriority?: number

    Priority for render sync system (default: 500)

    rootContainer?: Container<ContainerChild>

    Optional custom root container (defaults to app.stage)

    screenScale?: ScreenScaleOptions

    Enforce a logical design resolution with automatic aspect-ratio-aware scaling. When set, systems work in design-resolution coordinate space.

    screenSpaceLayers?: string[]

    Render layers that should not be affected by camera transforms. These layers are placed outside rootContainer so camera zoom/pan/rotation does not apply. Only relevant when camera: true. Layer names listed here must also appear in renderLayers.

    startLoop?: boolean

    When true, wires up pixiApp.ticker to drive ecs.update() automatically (default: true)

    systemGroup?: G

    System group name (default: 'renderer2d')

    transform?: TransformPluginOptions<"transform">

    Options for the included transform plugin

    width?: number

    Fixed canvas width. When set (with height), the canvas is fixed-size and the auto-resize default is suppressed.

    Settings

    Member Visibility

    On This Page

    Properties