tsParticles - v4.1.1
    Preparing search index...

    Interface IParticleUpdater

    Particle updater interface for custom particle behavior

    interface IParticleUpdater {
        afterDraw?: (particle: Particle) => void;
        beforeDraw?: (particle: Particle) => void;
        getColorStyles?: (
            particle: Particle,
            context: OffscreenCanvasRenderingContext2D,
            radius: number,
            opacity: number,
        ) => IParticleColorStyle;
        getTransformValues?: (
            particle: Particle,
        ) => Partial<IParticleTransformValues>;
        loadOptions?: (
            options: ParticlesOptions,
            ...sources: (RecursivePartial<IParticlesOptions> | undefined)[],
        ) => void;
        particleDestroyed?: (particle: Particle, override?: boolean) => void;
        preInit?: (particle: Particle) => void;
        reset?: (particle: Particle) => void;
        init(particle: Particle): void;
        isEnabled(particle: Particle): boolean;
        update(particle: Particle, delta: IDelta): void;
    }
    Index

    Properties

    afterDraw? beforeDraw? getColorStyles? getTransformValues? loadOptions? particleDestroyed? preInit? reset?

    Methods

    init isEnabled update

    Properties

    afterDraw?: (particle: Particle) => void

    Called after drawing a particle

    beforeDraw?: (particle: Particle) => void

    Called before drawing a particle

    getColorStyles?: (
        particle: Particle,
        context: OffscreenCanvasRenderingContext2D,
        radius: number,
        opacity: number,
    ) => IParticleColorStyle

    Returns custom color styles for a particle

    getTransformValues?: (particle: Particle) => Partial<IParticleTransformValues>

    Returns custom transform values for a particle

    loadOptions?: (
        options: ParticlesOptions,
        ...sources: (RecursivePartial<IParticlesOptions> | undefined)[],
    ) => void

    Loads particle updater options

    particleDestroyed?: (particle: Particle, override?: boolean) => void

    Called when a particle is destroyed

    preInit?: (particle: Particle) => void

    Called before initialization

    reset?: (particle: Particle) => void

    Resets the updater state for a particle

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods