defineParticleEffect2D
import { defineParticleEffect2D } from "@pibbl/core/particles";Creates an immutable validated effect from one or more named emitters. The returned value contains no clock or mutable population. A mounted component or particle system owns execution.
Emitter capacity, emission sources, shape, initial values, motion modules, over-life appearance, renderer, and optional bounds are compiled once. Invalid or unsupported combinations fail at definition time with the effect, emitter, and property in the diagnostic.
Types: PibblParticleEffect2D,
PibblParticleEffect2DInput,
and PibblParticleEmitter2D.
API details from source
Section titled “API details from source”
Validates and brands a reusable Canvas 2D particle effect while preserving emitter names and parameter types.
defineParticleEffect2D: <const Input extends PibblParticleEffect2DInput>(input: Input) => PibblParticleEffect2D<Input['emitters'][number]['name'], PibblParticleValuesOf<Input extends { readonly parameters: infer Definitions; } ? Extract<Definitions, PibblParticleParameterDefinitions> : undefined>>Related API: defineParticleEffect2D, PibblParticleEffect2DInput, PibblParticleEffect2D, PibblParticleValuesOf, PibblParticleParameterDefinitions.
Parameters
Section titled “Parameters”input— Emitter definitions, parameter declarations, and effect configuration.
Returns
Section titled “Returns”A validated particle effect preserving emitter names and parameter types. See PibblParticleEffect2D , PibblParticleValuesOf , PibblParticleParameterDefinitions .
See also
Section titled “See also”PibblParticleParameterDefinitions
View source — packages/core/src/features/particles/lib/definition.ts:609
Implementation guidance for agents
Section titled “Implementation guidance for agents”Read the Canvas particles companion for ownership, adaptation, failure modes, and verification. Agent start provides the version-selection workflow.
Complete minimal examples
Section titled “Complete minimal examples”- Particle effect configuration: Compose a typed ember emitter from emission, motion, appearance, and bounds. Plain source
Documentation version
Section titled “Documentation version”Documentation built with @pibbl/core 0.0.2, revision 2dccb19. ALPHA — NOT FOR PRODUCTION USE.