Class FluidEffect

Stable Fluid as a single Effect. Mutate params directly for runtime
tweaks; tracked sim state is owned by the effect and reset on dispose.

Implements

Effect

Index

Constructors

Properties

Methods

dispose init render

Constructors

constructor

new FluidEffect(initial?: Partial<FluidParams>): FluidEffect
Parameters
- initial: Partial<FluidParams> = {}
Returns FluidEffect
- Defined in effects/src/fluid.ts:287

Properties

params

params: FluidParams

Methods

dispose

dispose(): void
Returns void
Implementation of Effect.dispose
- Defined in effects/src/fluid.ts:453

init

init(ctx: EffectContext): void
Parameters
- ctx: EffectContext
Returns void
Implementation of Effect.init
- Defined in effects/src/fluid.ts:291

render

render(ctx: EffectContext): void
Render phase. Omit to make this effect transparent in the chain.
Parameters
- ctx: EffectContext
Returns void
Implementation of Effect.render
- Defined in effects/src/fluid.ts:311