Skip to content

Firepit API

Firepit

Extends Effect.

Factory Function

typescript
createFirepit(config?: FirepitConfig)

Methods

See Effect for the full method reference: mount(), start(), pause(), resume(), configure(), withFade(), and destroy().


FirepitConfig

typescript
interface FirepitConfig {
    embers?: number;
    flameWidth?: number;
    flameHeight?: number;
    intensity?: number;
    scale?: number;
}
PropertyTypeDefaultDescription
embersnumber60Maximum number of ember particles. Halved on small screens.
flameWidthnumber0.4Flame width as fraction of canvas width.
flameHeightnumber0.35Flame height as fraction of canvas height.
intensitynumber1Overall brightness and spawn rate multiplier.
scalenumber1Scales ember sizes proportionally.