effect-motion
API Referenceeffect-motionNamespacesParticlesInterfaces

Simulate

Advance a `ParticleField` for `duration`, running its per-frame step

Interface: Simulate()

Defined in: packages/motion/src/particles/simulate.ts:154

Advance a ParticleField for duration, running its per-frame step (emit, integrate, kill) once per frame and arriving at the phaser once per frame — O(1) on the barrier regardless of live particle count.

Dual: simulate(field, duration, emission) or field.pipe(simulate(duration, emission)). The emission is constrained by how the field was created: a Particles.emitter(...) takes { burst } or { rate }, a Particles.field(...) takes { fill }. Resolves with the field so calls chain.

Call Signature

Simulate(
   field,
   duration,
emission): Effect<EmitterField, never, Runner>;

Defined in: packages/motion/src/particles/simulate.ts:156

Advance a ParticleField for duration, running its per-frame step (emit, integrate, kill) once per frame and arriving at the phaser once per frame — O(1) on the barrier regardless of live particle count.

Dual: simulate(field, duration, emission) or field.pipe(simulate(duration, emission)). The emission is constrained by how the field was created: a Particles.emitter(...) takes { burst } or { rate }, a Particles.field(...) takes { fill }. Resolves with the field so calls chain.

Parameters

ParameterType
fieldEmitterField
durationInput
emissionEmitterEmission

Returns

Effect<EmitterField, never, Runner>

Call Signature

Simulate(
   field,
   duration,
emission): Effect<FloatField, never, Runner>;

Defined in: packages/motion/src/particles/simulate.ts:161

Advance a ParticleField for duration, running its per-frame step (emit, integrate, kill) once per frame and arriving at the phaser once per frame — O(1) on the barrier regardless of live particle count.

Dual: simulate(field, duration, emission) or field.pipe(simulate(duration, emission)). The emission is constrained by how the field was created: a Particles.emitter(...) takes { burst } or { rate }, a Particles.field(...) takes { fill }. Resolves with the field so calls chain.

Parameters

ParameterType
fieldFloatField
durationInput
emissionFillEmission

Returns

Effect<FloatField, never, Runner>

Call Signature

Simulate(duration, emission): (field) => Effect<EmitterField, never, Runner>;

Defined in: packages/motion/src/particles/simulate.ts:167

Advance a ParticleField for duration, running its per-frame step (emit, integrate, kill) once per frame and arriving at the phaser once per frame — O(1) on the barrier regardless of live particle count.

Dual: simulate(field, duration, emission) or field.pipe(simulate(duration, emission)). The emission is constrained by how the field was created: a Particles.emitter(...) takes { burst } or { rate }, a Particles.field(...) takes { fill }. Resolves with the field so calls chain.

Parameters

ParameterType
durationInput
emissionEmitterEmission

Returns

(field) => Effect<EmitterField, never, Runner>

Call Signature

Simulate(duration, emission): (field) => Effect<FloatField, never, Runner>;

Defined in: packages/motion/src/particles/simulate.ts:171

Advance a ParticleField for duration, running its per-frame step (emit, integrate, kill) once per frame and arriving at the phaser once per frame — O(1) on the barrier regardless of live particle count.

Dual: simulate(field, duration, emission) or field.pipe(simulate(duration, emission)). The emission is constrained by how the field was created: a Particles.emitter(...) takes { burst } or { rate }, a Particles.field(...) takes { fill }. Resolves with the field so calls chain.

Parameters

ParameterType
durationInput
emissionFillEmission

Returns

(field) => Effect<FloatField, never, Runner>

On this page