Skip to main content

Module: particles/options

Interfaces#

Type aliases#

ApplyFunction#

Ƭ ApplyFunction<T>: (property: T, element: HTMLElement) => void

Type parameters#

Name
T

Type declaration#

▸ (property, element): void

Represents a delegate used by the renderer to apply a certain property to the particle's HTMLElement. Note that this property is generic and does not have to contain the particle itself.

Parameters#
NameType
propertyT
elementHTMLElement
Returns#

void

Defined in#

particles/options/renderOptions.ts:10


ParticleDespawnRule#

Ƭ ParticleDespawnRule: (particle: Particle) => boolean

Type declaration#

▸ (particle): boolean

Represents a rule that decides whether a particle should be despawned or not.

Parameters#
NameType
particleParticle
Returns#

boolean

Defined in#

particles/options/emitterOptions.ts:8

Functions#

getDefaultEmissionOptions#

getDefaultEmissionOptions(): EmissionOptions

Returns the default set of emission options.

Returns#

EmissionOptions

Defined in#

particles/options/emissionOptions.ts:89


getDefaultEmitterOptions#

getDefaultEmitterOptions(): EmitterOptions

Returns the default set of emitter options.

Returns#

EmitterOptions

Defined in#

particles/options/emitterOptions.ts:58


getDefaultRendererOptions#

getDefaultRendererOptions(): RenderOptions

Returns the default set of renderer options.

Returns#

RenderOptions

Defined in#

particles/options/renderOptions.ts:57