VFX-JS
    Preparing search index...

    Type Alias ParticleParams

    type ParticleParams = {
        alpha: number;
        alphaDecay: number;
        alphaThreshold: number;
        birthRate: number;
        blend: "add" | "normal";
        color: number;
        colorMix: number;
        count: number;
        emitSpeed: number;
        fadeIn: number;
        fog: number;
        life: number;
        noiseAnimation: number;
        noiseDelay: number;
        noiseScale: number;
        noiseSpeed: number;
        pointSize: number;
        radius: number;
        screenBirthRate: number;
        spawnOnIdle: boolean;
        speedDecay: number;
        srcOpacity: number;
        trailFade: number;
    }
    Index

    Properties

    alpha: number

    Global alpha multiplier on each particle (0..1).

    alphaDecay: number

    Alpha-envelope shape exponent (>1 holds peak alpha longer; <1 sharpens fade).

    alphaThreshold: number

    Reject spawns where src.a is below this.

    birthRate: number

    Particles per second emitted within radius of the mouse while
    the mouse is active.

    blend: "add" | "normal"

    Stamp blend mode. "add" brightens overlaps; "normal" composites
    with premultiplied-alpha over.

    color: number

    Base color blended into particle rgb (hex 0xRRGGBB).

    colorMix: number

    Mix amount between src color (0) and color (1).

    count: number

    Max particles. Capped at construction by the state texture size.

    emitSpeed: number

    Initial outward speed (uv/sec, short-axis-normalized) applied
    to mouse-spawned particles — fades to curl-noise drift over
    noiseDelay. Screen-spawned particles ignore this.

    fadeIn: number

    Fraction of life over which the particle ramps from 0 to peak
    alpha. Small values (≈0.05) keep the radial-emit phase visible;
    larger values (≈0.5) restore the slow fade-in look.

    fog: number

    Depth fog 0..1.

    life: number

    Base lifespan (sec); actual life is jittered per-particle.

    noiseAnimation: number

    Morph rate on the 4th simplex axis (units per second).

    noiseDelay: number

    Fraction of life (0..1) over which motion smoothstep-blends from
    the radial impulse at spawn to the curl-noise field. 0 disables
    the radial phase entirely.

    noiseScale: number

    Approximate swirl size in uv units (larger → bigger swirls).

    noiseSpeed: number

    Curl-noise drift speed (uv/sec, short-axis-normalized) once the
    emit impulse decays.

    pointSize: number

    Particle quad size in element px.

    radius: number

    Spawn radius around the cursor in element px.

    screenBirthRate: number

    Particles per second emitted at uniform-random positions across
    the element. Independent of mouse motion; only gated by visibility
    and the same alpha-rejection as mouse spawns.

    spawnOnIdle: boolean

    Emit even when the mouse is stationary.

    speedDecay: number

    Life-taper curve exponent (>1 holds full speed longer).

    srcOpacity: number

    Source element opacity (0..1) shown beneath the particles.

    trailFade: number

    Per-frame trail decay (0..1). Higher = longer trails.