Class Canvas

Canvas manager

Hierarchy

Canvas

Constructors

constructor

new Canvas(container: Container): Canvas

- Defined in src/Core/Canvas.ts:44
Constructor of canvas manager

Parameters
- container: Container
  
  the parent container
Returns Canvas

Properties

Private #context

#context: null | <internal>.CanvasRenderingContext2D

The particles canvas context

Private Optional coverColorStyle

coverColorStyle?: string

Optional element

element?: <internal>.HTMLCanvasElement

The particles canvas

Private generatedCanvas

generatedCanvas: boolean

Private Optional originalStyle

originalStyle?: <internal>.CSSStyleDeclaration

Optional resizeFactor

resizeFactor?: IDimension

Readonly size

size: IDimension

The particles canvas dimension

Private Optional trailFillColor

trailFillColor?: IRgba

Methods

clear

clear(): void

- Defined in src/Core/Canvas.ts:116
Clears the canvas content

Returns void

destroy

destroy(): void

- Defined in src/Core/Canvas.ts:86
Returns void

draw

draw<T>(cb: ((context: <internal>.CanvasRenderingContext2D) => T)): undefined | T

- Defined in src/Core/Canvas.ts:316
Type Parameters
- T
Parameters
- cb: ((context: <internal>.CanvasRenderingContext2D) => T)
  - - (context: <internal>.CanvasRenderingContext2D): T
    - Parameters
      - context: <internal>.CanvasRenderingContext2D
      Returns T
Returns undefined | T

drawParticle

drawParticle(particle: Particle, delta: IDelta): void

- Defined in src/Core/Canvas.ts:193
Parameters
- particle: Particle
- delta: IDelta
Returns void

drawParticlePlugin

drawParticlePlugin(plugin: IContainerPlugin, particle: Particle, delta: IDelta): void

- Defined in src/Core/Canvas.ts:286
Parameters
- plugin: IContainerPlugin
- particle: Particle
- delta: IDelta
Returns void

drawPlugin

drawPlugin(plugin: IContainerPlugin, delta: IDelta): void

- Defined in src/Core/Canvas.ts:280
Parameters
- plugin: IContainerPlugin
- delta: IDelta
Returns void

Private getPluginParticleColors

getPluginParticleColors(particle: Particle): (undefined | IHsl)[]

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

init

init(): void

- Defined in src/Core/Canvas.ts:58
Initializes the canvas element

Returns void

initBackground

initBackground(): void

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

Private initCover

initCover(): void

- Defined in src/Core/Canvas.ts:324
Returns void

Private initStyle

initStyle(): void

- Defined in src/Core/Canvas.ts:379
Returns void

Private initTrail

initTrail(): void

- Defined in src/Core/Canvas.ts:342
Returns void

loadCanvas

loadCanvas(canvas: <internal>.HTMLCanvasElement): void

- Defined in src/Core/Canvas.ts:67
Parameters
- canvas: <internal>.HTMLCanvasElement
Returns void

paint

paint(): void

- Defined in src/Core/Canvas.ts:99
Paints the canvas background

Returns void

Private paintBase

paintBase(baseColor?: string): void

- Defined in src/Core/Canvas.ts:422
Parameters
- Optional baseColor: string
Returns void

resize

resize(): void

- Defined in src/Core/Canvas.ts:158
Calculates the size of the canvas

Returns void

windowResize

windowResize(): Promise<void>

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