Class GradientUpdater

Gradient updater plugin

Implements

IParticleUpdater

Index

Constructors

Methods

getColorStyles init isEnabled loadOptions update

Constructors

constructor

new GradientUpdater(
pluginManager: PluginManager,
container: Container,
): GradientUpdater
GradientUpdater constructor
Parameters
- pluginManager: PluginManager
  The plugin manager
- container: Container
  The container to handle
Returns GradientUpdater
- Defined in updaters/gradient/src/GradientUpdater.ts:44

Methods

getColorStyles

getColorStyles(
    particle: GradientParticle,
    context: OffscreenCanvasRenderingContext2D,
    radius: number,
    opacity: number,
): IParticleColorStyle
Gets the color styles for the gradient
Parameters
- particle: GradientParticle
  The particle to process
- context: OffscreenCanvasRenderingContext2D
  The rendering context
- radius: number
  The radius
- opacity: number
  The opacity value
Returns IParticleColorStyle
The color styles for the gradient
Implementation of IParticleUpdater.getColorStyles
- Defined in updaters/gradient/src/GradientUpdater.ts:57

init

init(particle: GradientParticle): void
Initializes the particle gradient
Parameters
- particle: GradientParticle
  The particle to process
Returns void
Implementation of IParticleUpdater.init
- Defined in updaters/gradient/src/GradientUpdater.ts:103

isEnabled

isEnabled(particle: GradientParticle): boolean
Checks if gradient animation is enabled
Parameters
- particle: GradientParticle
  The particle to process
Returns boolean
The boolean value
Implementation of IParticleUpdater.isEnabled
- Defined in updaters/gradient/src/GradientUpdater.ts:218

loadOptions

loadOptions(
options: GradientParticlesOptions,
...sources: (RecursivePartial<IGradientParticlesOptions> | undefined)[],
): void
Loads the gradient options
Parameters
- options: GradientParticlesOptions
  The options to handle
- ...sources: (RecursivePartial<IGradientParticlesOptions> | undefined)[]
  The sources
Returns void
Implementation of IParticleUpdater.loadOptions
- Defined in updaters/gradient/src/GradientUpdater.ts:232

update

update(particle: GradientParticle, delta: IDelta): void
Updates particle gradient animation
Parameters
- particle: GradientParticle
  The particle to process
- delta: IDelta
  The delta time
Returns void
Implementation of IParticleUpdater.update
- Defined in updaters/gradient/src/GradientUpdater.ts:258