Skip to content
particulab logo particulab logo Documentation | particulab

ParticleSystem

export default class ParticleSystem

Constructors

Section titled “Constructors”
constructor(canvas: HTMLCanvasElement, options: ParticleSystemOptions)
Section titled “constructor(canvas: HTMLCanvasElement, options: ParticleSystemOptions)”

Constructs a new instance of the ParticleSystem class.

Properties

Section titled “Properties”
acceleration : VectorInterval
Section titled “acceleration : VectorInterval”
amount : number
Section titled “amount : number”

The number of particles rendered by the system.

colors : (RGBA | HEX)[]
Section titled “colors : (RGBA | HEX)[]”
life : Interval
Section titled “life : Interval”
opacity : Interval
Section titled “opacity : Interval”
particles : Map<string, Particle>
Section titled “particles : Map<string, Particle>”
size : Interval
Section titled “size : Interval”
shapes : Shape[]
Section titled “shapes : Shape[]”
velocity : VectorInterval
Section titled “velocity : VectorInterval”

Methods

Section titled “Methods”
init() : void
Section titled “init() : void”

Starts the particle system rendering process.

stop() : void
Section titled “stop() : void”

Stops the particle system update process. Previously rendered particles will still show on screen.

clear() : void
Section titled “clear() : void”

Removes all particles on screen.