Class TwinkleUpdater

Twinkle updater plugin

Implements

IParticleUpdater

Index

Constructors

Methods

getColorStyles init isEnabled loadOptions update

Constructors

constructor

new TwinkleUpdater(
pluginManager: PluginManager,
container: Container,
): TwinkleUpdater
TwinkleUpdater constructor
Parameters
- pluginManager: PluginManager
  The plugin manager
- container: Container
  The container to handle
Returns TwinkleUpdater
- Defined in TwinkleUpdater.ts:29

Methods

getColorStyles

getColorStyles(
    particle: Particle,
    _context: OffscreenCanvasRenderingContext2D,
    _radius: number,
    opacity: number,
): IParticleColorStyle
Gets the twinkle color styles
Parameters
- particle: Particle
  The particle to process
- _context: OffscreenCanvasRenderingContext2D
  The rendering context
- _radius: number
  The radius
- opacity: number
  The opacity value
Returns IParticleColorStyle
The color styles
Implementation of IParticleUpdater.getColorStyles
- Defined in TwinkleUpdater.ts:42

init

init(): void
Initializes the twinkle (no-op)

Returns void
Implementation of IParticleUpdater.init
- Defined in TwinkleUpdater.ts:90

isEnabled

isEnabled(particle: TwinkeParticle): boolean
Checks if twinkle is enabled
Parameters
- particle: TwinkeParticle
  The particle to process
Returns boolean
The boolean value
Implementation of IParticleUpdater.isEnabled
- Defined in TwinkleUpdater.ts:99

loadOptions

loadOptions(
options: TwinkleParticlesOptions,
...sources: (RecursivePartial<ITwinkleParticlesOptions> | undefined)[],
): void
Loads the twinkle options
Parameters
- options: TwinkleParticlesOptions
  The options to handle
- ...sources: (RecursivePartial<ITwinkleParticlesOptions> | undefined)[]
  The sources
Returns void
Implementation of IParticleUpdater.loadOptions
- Defined in TwinkleUpdater.ts:115

update

update(): void
Updates the twinkle (no-op)

Returns void
Implementation of IParticleUpdater.update
- Defined in TwinkleUpdater.ts:123