Interface ParticlesOptions

interface ParticlesOptions {
    ageRange?: [number, number];
    angleRange?: [number, number];
    forceField?: Vector2D;
    generationRate?: number;
    maxParticles?: number;
    mouseOff?: boolean;
    origin?: [number, number];
    overlay?: boolean;
    rgba?: [number, number, number, number];
    speedRange?: [number, number];
}

Properties

ageRange? angleRange? forceField? generationRate? maxParticles? mouseOff? origin? overlay? rgba? speedRange?

Properties

OptionalageRange

ageRange?: [number, number]

Min and max age of particles in seconds

OptionalangleRange

angleRange?: [number, number]

Min and max angles in radians

Default Value

[-Math.PI, Math.PI]

OptionalforceField

forceField?: Vector2D

Constant force [fx, fy] or a force field texture (Work In Progress)

OptionalgenerationRate

generationRate?: number

Particle generation rate

Default Value

0.5

OptionalmaxParticles

maxParticles?: number

Maximum number of particles

Default Value

100_000

OptionalmouseOff

mouseOff?: boolean

Disable mouse interaction

Default Value

false

Optionalorigin

origin?: [number, number]

Initial origin, will update as per mouse position if mouseOff is not set

Default Value

[0, 0]

Optionaloverlay

overlay?: boolean

Overlay mode

Default Value

false

Optionalrgba

rgba?: [number, number, number, number]

Particle Color

Default Value

[1, 0, 0, 1] -> red

OptionalspeedRange

speedRange?: [number, number]

Speed range [minSpeed, maxSpeed]

Settings

Member Visibility

On This Page

Properties