@ujjwalvivek/tinyts
    Preparing search index...

    Interface EmitterConfig

    Configuration options for a particle emitter.

    interface EmitterConfig {
        additive?: boolean;
        angle?: number;
        angularVel?: [number, number];
        count?: number | [number, number];
        damping?: number;
        duration?: number;
        endColor?: string | Color;
        gravity?: Vec2;
        life?: [number, number];
        loop?: boolean;
        onComplete?: () => void;
        onParticleUpdate?: (p: Particle, dt: number) => void;
        pos?: Vec2 | (() => Vec2);
        prewarm?: number;
        rate?: number;
        rotation?: [number, number];
        shape?: ParticleShape;
        size?: [number, number];
        sizeEnd?: [number, number];
        speed?: [number, number];
        spread?: number;
        sprite?: CanvasImageSource | null;
        startColor?: string | Color;
    }
    Index

    Properties

    additive? angle? angularVel? count? damping? duration? endColor? gravity? life? loop? onComplete? onParticleUpdate? pos? prewarm? rate? rotation? shape? size? sizeEnd? speed? spread? sprite? startColor?

    Properties

    additive?: boolean

    Render with additive blending (lighter composite mode).

    angle?: number

    Base emission direction in radians (default 0).

    angularVel?: [number, number]

    Angular velocity range in radians/second.

    count?: number | [number, number]

    Burst count, or [min, max] range.

    damping?: number

    Velocity damping per frame at 60Hz (0-1, default 0.95).

    duration?: number

    How long the emitter runs in seconds (0 = infinite).

    endColor?: string | Color

    End color (particle lerps to this over its life).

    gravity?: Vec2

    Gravity vector in pixels/s^2.

    life?: [number, number]

    Particle lifetime range in seconds.

    loop?: boolean

    When true, duration-based emitters restart on expiry.

    onComplete?: () => void

    Called when emitter is fully done (all particles dead).

    onParticleUpdate?: (p: Particle, dt: number) => void

    Called every frame per live particle.

    pos?: Vec2 | (() => Vec2)

    Static position or getter function for attached emitters.

    prewarm?: number

    Seconds to simulate on addEmitter so continuous effects look filled-in.

    rate?: number

    Particles emitted per second (0 or omit for burst-only).

    rotation?: [number, number]

    Start rotation range in radians.

    shape?: ParticleShape

    Particle shape: 'rect' (default), 'circle', or 'streak' (line along velocity).

    size?: [number, number]

    Start size range in pixels.

    sizeEnd?: [number, number]

    End size range (after lifetime).

    speed?: [number, number]

    Launch speed range in pixels/second.

    spread?: number

    Arc spread from base angle in radians (default 2pi).

    sprite?: CanvasImageSource | null

    Optional sprite for all particles in this emitter.

    startColor?: string | Color

    Start color (hex string or Color).

    Settings

    Member Visibility

    On This Page

    Properties