Class Canvas

Canvas manager

Hierarchy

Canvas

Constructors

constructor

new Canvas(container): Canvas
Constructor of canvas manager
Parameters
- container: Container
  
  the parent container
Returns Canvas
- Defined in Core/Canvas.ts:65

Properties

`Private` _colorPlugins

_colorPlugins: IContainerPlugin[]

`Private` _context

_context: null | CanvasRenderingContext2D

The particles canvas context

`Private` `Optional` _coverColorStyle

_coverColorStyle?: string

`Private` _generated

_generated: boolean

`Private` `Optional` `Readonly` _mutationObserver

_mutationObserver?: MutationObserver

`Private` `Optional` _originalStyle

_originalStyle?: CSSStyleDeclaration

`Private` _postDrawUpdaters

_postDrawUpdaters: IParticleUpdater[]

`Private` _preDrawUpdaters

_preDrawUpdaters: IParticleUpdater[]

`Private` _resizePlugins

_resizePlugins: IContainerPlugin[]

`Private` `Optional` _trailFill

_trailFill?: ITrailFillData

`Private` `Readonly` container

container: Container

the parent container

`Optional` element

element?: HTMLCanvasElement

The particles canvas

`Optional` resizeFactor

resizeFactor?: IDimension

`Readonly` size

size: IDimension

The particles canvas dimension

Accessors

`Private` _fullScreen

get _fullScreen(): boolean
Returns boolean
- Defined in Core/Canvas.ts:89

Methods

`Private` _applyPostDrawUpdaters

_applyPostDrawUpdaters(particle): void
Parameters
- particle: Particle
Returns void
- Defined in Core/Canvas.ts:432

`Private` _applyPreDrawUpdaters

_applyPreDrawUpdaters(ctx, particle, radius, zOpacity, colorStyles, transform): void
Parameters
- ctx: CanvasRenderingContext2D
- particle: Particle
- radius: number
- zOpacity: number
- colorStyles: IParticleColorStyle
- transform: IParticleTransformValues
Returns void
- Defined in Core/Canvas.ts:438

`Private` _applyResizePlugins

_applyResizePlugins(): void
Returns void
- Defined in Core/Canvas.ts:471

`Private` _getPluginParticleColors

_getPluginParticleColors(particle): (undefined | IHsl)[]
Parameters
- particle: Particle
Returns (undefined | IHsl)[]
- Defined in Core/Canvas.ts:479

`Private` _initCover

_initCover(): void
Returns void
- Defined in Core/Canvas.ts:499

`Private` _initStyle

_initStyle(): void
Returns void
- Defined in Core/Canvas.ts:517

`Private` _initTrail

_initTrail(): Promise<void>
Returns Promise<void>
- Defined in Core/Canvas.ts:548

`Private` _paintBase

_paintBase(baseColor?): void
Parameters
- Optional baseColor: string
Returns void
- Defined in Core/Canvas.ts:595

`Private` _paintImage

_paintImage(image, opacity): void
Parameters
- image: HTMLImageElement
- opacity: number
Returns void
- Defined in Core/Canvas.ts:601

`Private` _repairStyle

_repairStyle(): void
Returns void
- Defined in Core/Canvas.ts:607

`Private` _resetOriginalStyle

_resetOriginalStyle(): void
Returns void
- Defined in Core/Canvas.ts:622

`Private` _setFullScreenStyle

_setFullScreenStyle(): void
Returns void
- Defined in Core/Canvas.ts:638

clear

clear(): void
Clears the canvas content

Returns void
- Defined in Core/Canvas.ts:96

destroy

destroy(): void
Destroying object actions

Returns void
- Defined in Core/Canvas.ts:119

draw

draw<T>(cb): undefined | T
Generic draw method, for drawing stuff on the canvas context
Type Parameters
- T
Parameters
- cb: ((context) => T)
  - - (context): T
    - Parameters
      
      context: CanvasRenderingContext2D
      
      Returns T
Returns undefined | T
- Defined in Core/Canvas.ts:140

drawParticle

drawParticle(particle, delta): void
Draws the specified particle in the canvas
Parameters
- particle: Particle
  
  the particle to draw
- delta: IDelta
  
  the frame delta time values
Returns void
- Defined in Core/Canvas.ts:153

drawParticlePlugin

drawParticlePlugin(plugin, particle, delta): void
Draws stuff using the given plugin, using the given particle
Parameters
- plugin: IContainerPlugin
  
  the plugin to use for drawing stuff
- particle: Particle
  
  the particle used
- delta: IDelta
  
  the frame delta time values
Returns void
- Defined in Core/Canvas.ts:222

drawPlugin

drawPlugin(plugin, delta): void
Draws stuff using the given plugin
Parameters
- plugin: IContainerPlugin
  
  the plugin to use for drawing stuff
- delta: IDelta
  
  the frame delta time values
Returns void
- Defined in Core/Canvas.ts:233

init

init(): Promise<void>
Initializes the canvas element

Returns Promise<void>
- Defined in Core/Canvas.ts:242

initBackground

initBackground(): void
Initializes the canvas background

Returns void
- Defined in Core/Canvas.ts:265

initPlugins

initPlugins(): void
Initializes the plugins needed by canvas

Returns void
- Defined in Core/Canvas.ts:292

initUpdaters

initUpdaters(): void
Initializes the updaters needed by canvas

Returns void
- Defined in Core/Canvas.ts:309

loadCanvas

loadCanvas(canvas): void
Loads the canvas html element
Parameters
- canvas: HTMLCanvasElement
  
  the canvas html element
Returns void
- Defined in Core/Canvas.ts:328

paint

paint(): void
Paints the canvas background

Returns void
- Defined in Core/Canvas.ts:351

resize

resize(): void
Calculates the size of the canvas

Returns void
- Defined in Core/Canvas.ts:368

stop

stop(): void
Returns void
- Defined in Core/Canvas.ts:403

windowResize

windowResize(): Promise<void>
The window resize event handler

Returns Promise<void>
- Defined in Core/Canvas.ts:412