Skip to content

FireEffect

Source: FireEffect.h

FireEffect

class FireEffect
src/light/effects/FireEffect.h:14

Inherits: EffectBase

Fire2012-style heat field: sparks at the base rise and cool through the active palette (heat = palette index, cold at the low end, hottest at the high end); spark count scales with width.

The flame colour comes from the active palette — the Lava palette (black->red->orange->yellow->white) gives the classic look; any palette works (Ocean/Forest turn the flame blue/green).

FireEffect card

Public Attributes

uint8_t cooling = 55

uint8_t sparking = 120

Public Methods

virtual inline constchar * tags() const override : Curated emoji tags for the module picker's chip filter — extras beyond the role chip (which the UI derives from role() on its own).

virtual inline Dim dimensions() const override : Which axes the effect iterates — a claim, not a guarantee about the layer.

virtual inline void defineControls() override : defineControls MUST be idempotent and pure: only controls_.clear() + controls_.addX().

virtual inline void prepare() override : Tier-3 of the control-change split (see onControlChanged above): the module (re)allocates / recomputes whatever derived state it owns — an effect's heap, a Layer's mapping LUT, the Drivers output buffer.

virtual inline void tick() override