@newkrok/three-particles - v2.1.0
    Preparing search index...

    Type Alias ParticleSystem

    Represents a particle system instance, providing methods to control and manage its lifecycle.

    const particleSystem: ParticleSystem = {
      instance: new THREE.Points(geometry, material),
      resumeEmitter: () => { /* resume logic * / },
      pauseEmitter: () => { /* pause logic * / },
      dispose: () => { /* cleanup logic * / },
    };

    particleSystem.pauseEmitter(); // Stop particle emission
    particleSystem.resumeEmitter(); // Resume particle emission
    particleSystem.dispose(); // Cleanup the particle system
    type ParticleSystem = {
        dispose: () => void;
        instance: THREE.Points | Gyroscope;
        pauseEmitter: () => void;
        resumeEmitter: () => void;
    }
    Index

    Properties

    dispose instance pauseEmitter resumeEmitter

    Properties

    dispose: () => void

    Disposes of the particle system, cleaning up resources to free memory.

    instance: THREE.Points | Gyroscope

    The underlying Three.js Points object or a Gyroscope used for particle rendering.

    pauseEmitter: () => void

    Pauses the particle emitter, stopping any new particles from being emitted.

    resumeEmitter: () => void

    Resumes the particle emitter, allowing particles to be emitted again.

    Settings

    Member Visibility

    On This Page

    Properties