Skip to content

Black Hole API

BlackHole

Extends Effect.

Factory Function

typescript
createBlackHole(config?: BlackHoleConfig): Effect<BlackHoleConfig>

Methods

See Effect for the full method reference.


BlackHoleConfig

typescript
interface BlackHoleConfig {
    readonly count?: number;
    readonly speed?: number;
    readonly color?: string;
    readonly size?: number;
    readonly scale?: number;
}
PropertyTypeDefaultDescription
countnumber300Number of particles spiraling inward.
speednumber1Inward spiral speed.
colorstring'#6644ff'Base particle color; shifts to white near the event horizon.
sizenumber2Base particle size in pixels.
scalenumber1Uniform scale multiplier.