ecspresso
    Preparing search index...

    Interface Renderer3DPluginManagedOptions<G>

    Options when letting the plugin create and manage Three.js objects.

    interface Renderer3DPluginManagedOptions<G extends string = "renderer3d"> {
        antialias?: boolean;
        background?: ColorRepresentation;
        camera?: undefined;
        cameraOptions?: CameraOptions;
        container?: string | HTMLElement;
        height?: number;
        renderer?: undefined;
        renderSyncPriority?: number;
        scene?: undefined;
        shadows?: boolean;
        startLoop?: boolean;
        systemGroup?: G;
        threeInit?: Partial<WebGLRendererParameters>;
        transform?: Transform3DPluginOptions<"transform3d">;
        width?: number;
    }

    Type Parameters

    • G extends string = "renderer3d"

    Hierarchy

    • Renderer3DPluginCommonOptions<G>
      • Renderer3DPluginManagedOptions
    Index

    Properties

    antialias? background? camera? cameraOptions? container? height? renderer? renderSyncPriority? scene? shadows? startLoop? systemGroup? threeInit? transform? width?

    Properties

    antialias?: boolean

    Enable antialiasing (default: true)

    background?: ColorRepresentation

    Scene background color.

    camera?: undefined
    cameraOptions?: CameraOptions

    Camera configuration

    container?: string | HTMLElement

    Container element to append the canvas to (or CSS selector string). Defaults to document.body.

    height?: number

    Canvas height. When omitted, auto-sizes to container.

    renderer?: undefined
    renderSyncPriority?: number

    Priority for render sync system (default: 500)

    scene?: undefined
    shadows?: boolean

    Enable shadow mapping (default: false)

    startLoop?: boolean

    When true, starts a requestAnimationFrame loop to drive ecs.update() automatically (default: true)

    systemGroup?: G

    System group name (default: 'renderer3d')

    threeInit?: Partial<WebGLRendererParameters>

    Escape hatch for raw WebGLRendererParameters not otherwise exposed.

    transform?: Transform3DPluginOptions<"transform3d">

    Options for the included 3D transform plugin

    width?: number

    Canvas width. When omitted, auto-sizes to container.

    Settings

    Member Visibility

    On This Page

    Properties