Emitter

Coordinate one emitter’s playback, CPU slot metadata, and GPU simulation. Particle state stays in GPU textures; CPU metadata controls birth admission and expiration without readbacks. The renderer owns the GL context.

Constructors

Constructor

new Emitter(context, definition, sharedModifiers?, effectTransform?): Emitter

Parameters

Returns

Emitter

Properties

capacity

readonly capacity: number

effectTransform

readonly effectTransform: EffectTransform

emitting

emitting: boolean = true

Gate new births without pausing the simulation or resetting playback.

Accessors

birthTexture

Get Signature

get birthTexture(): WebGLTexture

Borrowed birth-data texture for renderer adapters: three RGBA bands.

Returns

WebGLTexture

configuration

Get Signature

get configuration(): { capacity: number; duration: number; durationSpread: number; emission: { rate: number | { points: { tangent: number; time: number; value: number; }[]; }; rateSpread: number; shape: { type: "point"; } | { diameter: number | { points: { tangent: number; time: number; value: number; }[]; }; diameterSpread: number; type: "circle"; } | { height: number | { points: { tangent: number; time: number; value: number; }[]; }; heightSpread: number; type: "box"; width: number | { points: { tangent: number; time: number; value: number; }[]; }; widthSpread: number; } | { height: number | { points: { tangent: number; time: number; value: number; }[]; }; heightSpread: number; type: "cone2d"; width: number | { points: { tangent: number; time: number; value: number; }[]; }; widthSpread: number; }; }; id: string; inheritVelocity: number; initial: { alpha: number | { points: { tangent: number; time: number; value: number; }[]; }; alphaSpread: number; angularVelocity: number | { points: { tangent: number; time: number; value: number; }[]; }; angularVelocitySpread: number; blue: number | { points: { tangent: number; time: number; value: number; }[]; }; blueSpread: number; direction: number; green: number | { points: { tangent: number; time: number; value: number; }[]; }; greenSpread: number; lifetime: number | { points: { tangent: number; time: number; value: number; }[]; }; lifetimeSpread: number; red: number | { points: { tangent: number; time: number; value: number; }[]; }; redSpread: number; rotation: number | { points: { tangent: number; time: number; value: number; }[]; }; rotationSpread: number; size: number | { points: { tangent: number; time: number; value: number; }[]; }; sizeSpread: number; speed: number | { points: { tangent: number; time: number; value: number; }[]; }; speedSpread: number; spread: number; stretchX: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchXSpread: number; stretchY: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchYSpread: number; }; modifiers: ({ magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; rotation: number; spread: number; type: "acceleration"; } | { magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; rotation: number; spread: number; type: "drag"; useDirection: boolean; } | { magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; maxDistance: number; spread: number; type: "radial"; x: number; y: number; } | { magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; maxDistance: number; rotation: number; spread: number; type: "vortex"; x: number; y: number; })[]; orientation: "default" | "initial-direction" | "movement-direction" | "angular-velocity"; overLifetime: { alpha: number | { points: { tangent: number; time: number; value: number; }[]; }; angularVelocity: number | { points: { tangent: number; time: number; value: number; }[]; }; blue: number | { points: { tangent: number; time: number; value: number; }[]; }; green: number | { points: { tangent: number; time: number; value: number; }[]; }; red: number | { points: { tangent: number; time: number; value: number; }[]; }; rotation: number | { points: { tangent: number; time: number; value: number; }[]; }; scale: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchX: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchY: number | { points: { tangent: number; time: number; value: number; }[]; }; }; playMode: "once" | "loop"; position: { x: number; y: number; }; rendering: { blendMode: "normal" | "add" | "multiply" | "screen"; tint?: { alpha: number; blue: number; green: number; red: number; }; }; rotation: number; scale: number; seed: number; space: "world" | "local"; startDelay: number; startDelaySpread: number; startOffset: number; stretchWithVelocity: boolean; }

Owned snapshot for serialization or explicit recreation.

Returns

{ capacity: number; duration: number; durationSpread: number; emission: { rate: number | { points: { tangent: number; time: number; value: number; }[]; }; rateSpread: number; shape: { type: "point"; } | { diameter: number | { points: { tangent: number; time: number; value: number; }[]; }; diameterSpread: number; type: "circle"; } | { height: number | { points: { tangent: number; time: number; value: number; }[]; }; heightSpread: number; type: "box"; width: number | { points: { tangent: number; time: number; value: number; }[]; }; widthSpread: number; } | { height: number | { points: { tangent: number; time: number; value: number; }[]; }; heightSpread: number; type: "cone2d"; width: number | { points: { tangent: number; time: number; value: number; }[]; }; widthSpread: number; }; }; id: string; inheritVelocity: number; initial: { alpha: number | { points: { tangent: number; time: number; value: number; }[]; }; alphaSpread: number; angularVelocity: number | { points: { tangent: number; time: number; value: number; }[]; }; angularVelocitySpread: number; blue: number | { points: { tangent: number; time: number; value: number; }[]; }; blueSpread: number; direction: number; green: number | { points: { tangent: number; time: number; value: number; }[]; }; greenSpread: number; lifetime: number | { points: { tangent: number; time: number; value: number; }[]; }; lifetimeSpread: number; red: number | { points: { tangent: number; time: number; value: number; }[]; }; redSpread: number; rotation: number | { points: { tangent: number; time: number; value: number; }[]; }; rotationSpread: number; size: number | { points: { tangent: number; time: number; value: number; }[]; }; sizeSpread: number; speed: number | { points: { tangent: number; time: number; value: number; }[]; }; speedSpread: number; spread: number; stretchX: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchXSpread: number; stretchY: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchYSpread: number; }; modifiers: ({ magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; rotation: number; spread: number; type: "acceleration"; } | { magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; rotation: number; spread: number; type: "drag"; useDirection: boolean; } | { magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; maxDistance: number; spread: number; type: "radial"; x: number; y: number; } | { magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; maxDistance: number; rotation: number; spread: number; type: "vortex"; x: number; y: number; })[]; orientation: "default" | "initial-direction" | "movement-direction" | "angular-velocity"; overLifetime: { alpha: number | { points: { tangent: number; time: number; value: number; }[]; }; angularVelocity: number | { points: { tangent: number; time: number; value: number; }[]; }; blue: number | { points: { tangent: number; time: number; value: number; }[]; }; green: number | { points: { tangent: number; time: number; value: number; }[]; }; red: number | { points: { tangent: number; time: number; value: number; }[]; }; rotation: number | { points: { tangent: number; time: number; value: number; }[]; }; scale: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchX: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchY: number | { points: { tangent: number; time: number; value: number; }[]; }; }; playMode: "once" | "loop"; position: { x: number; y: number; }; rendering: { blendMode: "normal" | "add" | "multiply" | "screen"; tint?: { alpha: number; blue: number; green: number; red: number; }; }; rotation: number; scale: number; seed: number; space: "world" | "local"; startDelay: number; startDelaySpread: number; startOffset: number; stretchWithVelocity: boolean; }

capacity

capacity: number

duration

duration: number

durationSpread

durationSpread: number

emission

emission: { rate: number | { points: { tangent: number; time: number; value: number; }[]; }; rateSpread: number; shape: { type: "point"; } | { diameter: number | { points: { tangent: number; time: number; value: number; }[]; }; diameterSpread: number; type: "circle"; } | { height: number | { points: { tangent: number; time: number; value: number; }[]; }; heightSpread: number; type: "box"; width: number | { points: { tangent: number; time: number; value: number; }[]; }; widthSpread: number; } | { height: number | { points: { tangent: number; time: number; value: number; }[]; }; heightSpread: number; type: "cone2d"; width: number | { points: { tangent: number; time: number; value: number; }[]; }; widthSpread: number; }; } = emissionSchema

emission.rate

rate: number | { points: { tangent: number; time: number; value: number; }[]; } = emissionRateSchema

emission.rateSpread

rateSpread: number

emission.shape

shape: { type: "point"; } | { diameter: number | { points: { tangent: number; time: number; value: number; }[]; }; diameterSpread: number; type: "circle"; } | { height: number | { points: { tangent: number; time: number; value: number; }[]; }; heightSpread: number; type: "box"; width: number | { points: { tangent: number; time: number; value: number; }[]; }; widthSpread: number; } | { height: number | { points: { tangent: number; time: number; value: number; }[]; }; heightSpread: number; type: "cone2d"; width: number | { points: { tangent: number; time: number; value: number; }[]; }; widthSpread: number; } = emissionShapeSchema

id

id: string = emitterIdSchema

inheritVelocity

inheritVelocity: number

initial

initial: { alpha: number | { points: { tangent: number; time: number; value: number; }[]; }; alphaSpread: number; angularVelocity: number | { points: { tangent: number; time: number; value: number; }[]; }; angularVelocitySpread: number; blue: number | { points: { tangent: number; time: number; value: number; }[]; }; blueSpread: number; direction: number; green: number | { points: { tangent: number; time: number; value: number; }[]; }; greenSpread: number; lifetime: number | { points: { tangent: number; time: number; value: number; }[]; }; lifetimeSpread: number; red: number | { points: { tangent: number; time: number; value: number; }[]; }; redSpread: number; rotation: number | { points: { tangent: number; time: number; value: number; }[]; }; rotationSpread: number; size: number | { points: { tangent: number; time: number; value: number; }[]; }; sizeSpread: number; speed: number | { points: { tangent: number; time: number; value: number; }[]; }; speedSpread: number; spread: number; stretchX: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchXSpread: number; stretchY: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchYSpread: number; } = initialPropertiesSchema

initial.alpha

alpha: number | { points: { tangent: number; time: number; value: number; }[]; }

initial.alphaSpread

alphaSpread: number

initial.angularVelocity

angularVelocity: number | { points: { tangent: number; time: number; value: number; }[]; }

initial.angularVelocitySpread

angularVelocitySpread: number

initial.blue

blue: number | { points: { tangent: number; time: number; value: number; }[]; }

initial.blueSpread

blueSpread: number

initial.direction

direction: number

initial.green

green: number | { points: { tangent: number; time: number; value: number; }[]; }

initial.greenSpread

greenSpread: number

initial.lifetime

lifetime: number | { points: { tangent: number; time: number; value: number; }[]; } = scalarPropertySchema

initial.lifetimeSpread

lifetimeSpread: number

initial.red

red: number | { points: { tangent: number; time: number; value: number; }[]; }

initial.redSpread

redSpread: number

initial.rotation

rotation: number | { points: { tangent: number; time: number; value: number; }[]; }

initial.rotationSpread

rotationSpread: number

initial.size

size: number | { points: { tangent: number; time: number; value: number; }[]; }

initial.sizeSpread

sizeSpread: number

initial.speed

speed: number | { points: { tangent: number; time: number; value: number; }[]; } = scalarPropertySchema

initial.speedSpread

speedSpread: number

initial.spread

spread: number

initial.stretchX

stretchX: number | { points: { tangent: number; time: number; value: number; }[]; }

initial.stretchXSpread

stretchXSpread: number

initial.stretchY

stretchY: number | { points: { tangent: number; time: number; value: number; }[]; }

initial.stretchYSpread

stretchYSpread: number

modifiers

modifiers: ({ magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; rotation: number; spread: number; type: "acceleration"; } | { magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; rotation: number; spread: number; type: "drag"; useDirection: boolean; } | { magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; maxDistance: number; spread: number; type: "radial"; x: number; y: number; } | { magnitude: number | { points: { tangent: number; time: number; value: number; }[]; }; maxDistance: number; rotation: number; spread: number; type: "vortex"; x: number; y: number; })[]

orientation

orientation: "default" | "initial-direction" | "movement-direction" | "angular-velocity"

overLifetime

overLifetime: { alpha: number | { points: { tangent: number; time: number; value: number; }[]; }; angularVelocity: number | { points: { tangent: number; time: number; value: number; }[]; }; blue: number | { points: { tangent: number; time: number; value: number; }[]; }; green: number | { points: { tangent: number; time: number; value: number; }[]; }; red: number | { points: { tangent: number; time: number; value: number; }[]; }; rotation: number | { points: { tangent: number; time: number; value: number; }[]; }; scale: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchX: number | { points: { tangent: number; time: number; value: number; }[]; }; stretchY: number | { points: { tangent: number; time: number; value: number; }[]; }; } = overLifetimeSchema

overLifetime.alpha

alpha: number | { points: { tangent: number; time: number; value: number; }[]; }

overLifetime.angularVelocity

angularVelocity: number | { points: { tangent: number; time: number; value: number; }[]; }

overLifetime.blue

blue: number | { points: { tangent: number; time: number; value: number; }[]; }

overLifetime.green

green: number | { points: { tangent: number; time: number; value: number; }[]; }

overLifetime.red

red: number | { points: { tangent: number; time: number; value: number; }[]; }

overLifetime.rotation

rotation: number | { points: { tangent: number; time: number; value: number; }[]; }

overLifetime.scale

scale: number | { points: { tangent: number; time: number; value: number; }[]; }

overLifetime.stretchX

stretchX: number | { points: { tangent: number; time: number; value: number; }[]; }

overLifetime.stretchY

stretchY: number | { points: { tangent: number; time: number; value: number; }[]; }

playMode

playMode: "once" | "loop"

position

position: { x: number; y: number; }

position.x

x: number

position.y

y: number

rendering

rendering: { blendMode: "normal" | "add" | "multiply" | "screen"; tint?: { alpha: number; blue: number; green: number; red: number; }; } = renderingSchema

rendering.blendMode

blendMode: "normal" | "add" | "multiply" | "screen"

rendering.tint?

optional tint?: { alpha: number; blue: number; green: number; red: number; }

rendering.tint.alpha

alpha: number

rendering.tint.blue

blue: number

rendering.tint.green

green: number

rendering.tint.red

red: number

rotation

rotation: number

scale

scale: number

seed

seed: number

space

space: "world" | "local"

startDelay

startDelay: number

startDelaySpread

startDelaySpread: number

startOffset

startOffset: number

stretchWithVelocity

stretchWithVelocity: boolean

gl

Get Signature

get gl(): WebGL2RenderingContext

Returns

WebGL2RenderingContext

id

Get Signature

get id(): string

Returns

string

initialized

Get Signature

get initialized(): boolean

Returns

boolean

isEmitting

Get Signature

get isEmitting(): boolean

Emission eligibility at the current clock, before any pending prewarm.

Returns

boolean

particleCount

Get Signature

get particleCount(): number

Number of living particles tracked on the CPU; no GPU readback.

Returns

number

rotation

Get Signature

get rotation(): number

Emitter rotation in counterclockwise degrees.

Returns

number

Set Signature

set rotation(value): void

Parameters

Returns

void

rows

Get Signature

get rows(): number

Rows in each of the five particle-state bands.

Returns

number

scale

Get Signature

get scale(): number

Uniform emitter scale; independent of particle size curves.

Returns

number

Set Signature

set scale(value): void

Parameters

Returns

void

space

Get Signature

get space(): "world" | "local"

Returns

"world" | "local"

state

Get Signature

get state(): EmitterState

Returns

EmitterState

stretchWithVelocity

Get Signature

get stretchWithVelocity(): boolean

Whether Y stretch follows the current simulation speed.

Returns

boolean

texture

Get Signature

get texture(): WebGLTexture

Borrowed changing-state texture for renderer adapters: two RGBA bands.

Returns

WebGLTexture

width

Get Signature

get width(): number

Texture columns; finalized against device limits when initialized.

Returns

number

worldHandedness

Get Signature

get worldHandedness(): -1 | 1

Returns

-1 | 1

worldRotation

Get Signature

get worldRotation(): number

Returns

number

worldScale

Get Signature

get worldScale(): number

Returns

number

worldX

Get Signature

get worldX(): number

Returns

number

worldY

Get Signature

get worldY(): number

Returns

number

x

Get Signature

get x(): number

Emitter origin in effect coordinates; rotation and scale apply around this point.

Returns

number

Set Signature

set x(value): void

Parameters

Returns

void

y

Get Signature

get y(): number

Returns

number

Set Signature

set y(value): void

Parameters

Returns

void

Methods

clear()

clear(): void

Stop emission and remove all particles immediately.

Returns

void

destroy()

destroy(): void

Release owned resources once, leaving the shared WebGL context alive.

Returns

void

initialize()

initialize(context): void

Attach the renderer’s context once. CPU controls are usable before attachment.

Parameters

Returns

void

onStateChange()

onStateChange(listener): () => void

Subscribe to queued lifecycle transitions; returns an unsubscribe function.

Parameters

Returns

() => void

play()

play(): void

Restart from the initial state, including delay, seed and prewarm.

Returns

void

reset()

reset(): void

Clear particles and restore the initial clock and seed; preserve the emitting gate.

Returns

void

retire()

retire(): void

Finish the current cycle, then drain existing particles.

Returns

void

setParameters()

setParameters(patch): void

Apply a validated patch atomically, rebuilding only affected sampled data.

Parameters

Returns

void

stop()

stop(__namedParameters?): void

Stop spawning; existing particles drain unless clear is requested.

Parameters

Returns

void

update()

update(seconds): void

Advance by 0–0.1 seconds. The first positive step runs pending prewarm first. Before initialize(), updates leave playback paused without accumulating time. Zero-time updates initialize GPU output without advancing particle ages. State notifications are delivered after the simulation work completes.

Parameters

Returns

void