Skip to content

Caustics API

Caustics

Extends Effect.

Factory Function

typescript
createCaustics(config?: CausticsConfig): Effect<CausticsConfig>

Methods

See Effect for the full method reference.


CausticsConfig

typescript
interface CausticsConfig {
    readonly speed?: number;
    readonly scale?: number;
    readonly resolution?: number;
    readonly intensity?: number;
    readonly color?: string;
}
PropertyTypeDefaultDescription
speednumber1Animation speed multiplier.
scalenumber1Scales all sizes proportionally.
resolutionnumber4Pixel step size for rendering.
intensitynumber0.7Brightness of the caustic lines (0–1).
colorstring'#4488cc'Base tint color for the caustic pattern.