Rapid Render API
    Preparing search index...

    Interface IParticleOptions

    interface IParticleOptions {
        animation: IParticleAnimation;
        emitRadius?: number;
        emitRate?: number;
        emitRect?: { height: number; width: number };
        emitShape?: ParticleShape;
        emitTime?: number;
        life: number | [number, number];
        localSpace?: boolean;
        maxParticles?: number;
        origin?: Vec2;
        shader?: CustomGlShader;
        texture: Texture;
    }
    Index

    Properties

    animation emitRadius? emitRate? emitRect? emitShape? emitTime? life localSpace? maxParticles? origin? shader? texture

    Properties

    animation: IParticleAnimation

    Animation / per-attribute configuration.

    emitRadius?: number

    Radius used when emitShape === CIRCLE.

    emitRate?: number

    Particles emitted per second (continuous) or per interval (when emitTime > 0).

    emitRect?: { height: number; width: number }

    Dimensions used when emitShape === RECT.

    emitShape?: ParticleShape

    Emit shape.

    emitTime?: number

    If > 0, particles are emitted in bursts every emitTime seconds rather than continuously.

    life: number | [number, number]

    Particle lifetime in seconds, or a [min, max] range.

    localSpace?: boolean

    Whether particles are positioned relative to the emitter (default: true).

    maxParticles?: number

    Maximum simultaneous particles (default: unlimited).

    origin?: Vec2
    shader?: CustomGlShader
    texture: Texture

    Texture(s) to pick from. Pass a weighted tuple [Texture, weight][] for weighted random.

    Settings

    Member Visibility

    On This Page

    Properties