Skip to content

Plasma API

Plasma

Extends Effect.

Factory Function

typescript
createPlasma(config?: PlasmaConfig)

Methods

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


PlasmaConfig

typescript
interface PlasmaConfig {
    speed?: number;
    scale?: number;
    resolution?: number;
    palette?: PlasmaColor[];
}
PropertyTypeDefaultDescription
speednumber1Animation speed multiplier.
scalenumber1Pattern scale factor. Higher values create larger patterns.
resolutionnumber4Pixel block size for rendering. Higher is faster but chunkier.
palettePlasmaColor[]Cyan, magenta, yellow, blue, greenArray of colors to interpolate between.

PlasmaColor

Color definition used in the palette.

typescript
type PlasmaColor = {
    r: number;  // Red channel (0-255)
    g: number;  // Green channel (0-255)
    b: number;  // Blue channel (0-255)
};