Sandstorm API

Sandstorm

Extends Effect.

Factory Function

createSandstorm(config ? : SandstormConfig)

Methods

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

---

SandstormConfig

interface SandstormConfig {
    count?: number;
    wind?: number;
    turbulence?: number;
    color?: string;
    hazeOpacity?: number;
    scale?: number;
}

Property	Type	Default	Description
count	number	300	Number of sand grains. Halved on small screens.
wind	number	1	Horizontal wind strength multiplier.
turbulence	number	1	Chaotic movement intensity.
color	string	'#c2956b'	CSS color string for sand and haze.
hazeOpacity	number	0.15	Opacity of the atmospheric haze overlay (0-1).
scale	number	1	Scales grain sizes proportionally.

---

SandGrain

Internal representation of a sand particle.

type SandGrain = {
    x: number;       // Normalized X position (0-1)
    y: number;       // Normalized Y position (0-1)
    vx: number;      // Horizontal velocity
    vy: number;      // Vertical velocity
    size: number;    // Grain size in pixels
    depth: number;   // Depth layer (0.2-1) for parallax
    opacity: number; // Base opacity (0.3-0.8)
};