Class Canvas

Hierarchy

Canvas

Constructors

constructor

new Canvas(container): Canvas
Parameters
- container: Container
Returns Canvas
- Defined in engine/dist/types/Core/Canvas.d.ts:21

Properties

`Private` `Readonly` _applyPostDrawUpdaters

_applyPostDrawUpdaters: any

`Private` `Readonly` _applyPreDrawUpdaters

_applyPreDrawUpdaters: any

`Private` `Readonly` _applyResizePlugins

_applyResizePlugins: any

`Private` _colorPlugins

_colorPlugins: any

`Private` _context

_context: any

`Private` `Optional` _coverColorStyle

_coverColorStyle?: any

`Private` _generated

_generated: any

`Private` `Readonly` _getPluginParticleColors

_getPluginParticleColors: any

`Private` `Readonly` _initCover

_initCover: any

`Private` `Readonly` _initStyle

_initStyle: any

`Private` `Readonly` _initTrail

_initTrail: any

`Private` `Optional` `Readonly` _mutationObserver

_mutationObserver?: any

`Private` `Optional` _originalStyle

_originalStyle?: any

`Private` `Readonly` _paintBase

_paintBase: any

`Private` `Readonly` _paintImage

_paintImage: any

`Private` _postDrawUpdaters

_postDrawUpdaters: any

`Private` _preDrawUpdaters

_preDrawUpdaters: any

`Private` `Readonly` _repairStyle

_repairStyle: any

`Private` `Readonly` _resetOriginalStyle

_resetOriginalStyle: any

`Private` _resizePlugins

_resizePlugins: any

`Private` `Readonly` _safeMutationObserver

_safeMutationObserver: any

`Private` `Readonly` _setFullScreenStyle

_setFullScreenStyle: any

`Private` `Optional` _trailFill

_trailFill?: any

`Private` `Readonly` container

container: any

`Optional` element

element?: HTMLCanvasElement

`Optional` resizeFactor

resizeFactor?: IDimension

`Readonly` size

size: IDimension

Accessors

`Private` _fullScreen

get _fullScreen(): any
Returns any
- Defined in engine/dist/types/Core/Canvas.d.ts:22

Methods

clear

clear(): void
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:23

destroy

destroy(): void
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:24

draw

draw<T>(cb): undefined | T
Type Parameters
- T
Parameters
- cb: ((context) => T)
  - - (context): T
    - Parameters
      
      context: CanvasRenderingContext2D
      
      Returns T
Returns undefined | T
- Defined in engine/dist/types/Core/Canvas.d.ts:25

drawParticle

drawParticle(particle, delta): void
Parameters
- particle: Particle
- delta: IDelta
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:26

drawParticlePlugin

drawParticlePlugin(plugin, particle, delta): void
Parameters
- plugin: IContainerPlugin
- particle: Particle
- delta: IDelta
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:27

drawPlugin

drawPlugin(plugin, delta): void
Parameters
- plugin: IContainerPlugin
- delta: IDelta
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:28

init

init(): Promise<void>
Returns Promise<void>
- Defined in engine/dist/types/Core/Canvas.d.ts:29

initBackground

initBackground(): void
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:30

initPlugins

initPlugins(): void
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:31

initUpdaters

initUpdaters(): void
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:32

loadCanvas

loadCanvas(canvas): void
Parameters
- canvas: HTMLCanvasElement
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:33

paint

paint(): void
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:34

resize

resize(): boolean
Returns boolean
- Defined in engine/dist/types/Core/Canvas.d.ts:35

stop

stop(): void
Returns void
- Defined in engine/dist/types/Core/Canvas.d.ts:36

windowResize

windowResize(): Promise<void>
Returns Promise<void>
- Defined in engine/dist/types/Core/Canvas.d.ts:37

Class Canvas

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

container: Container

Returns Canvas

Properties

Private Readonly _applyPostDrawUpdaters

Private Readonly _applyPreDrawUpdaters

Private Readonly _applyResizePlugins

Private _colorPlugins

Private _context

Private Optional _coverColorStyle

Private _generated

Private Readonly _getPluginParticleColors

Private Readonly _initCover

Private Readonly _initStyle

Private Readonly _initTrail

Private Optional Readonly _mutationObserver

Private Optional _originalStyle

Private Readonly _paintBase

Private Readonly _paintImage

Private _postDrawUpdaters

Private _preDrawUpdaters

Private Readonly _repairStyle

Private Readonly _resetOriginalStyle

Private _resizePlugins

Private Readonly _safeMutationObserver

Private Readonly _setFullScreenStyle

Private Optional _trailFill

Private Readonly container

Optional element

Optional resizeFactor

Readonly size

Accessors

Private _fullScreen

Returns any

Methods

clear

Returns void

destroy

Returns void

draw

Type Parameters

T

Parameters

cb: ((context) => T)

Parameters

context: CanvasRenderingContext2D

Returns T

Returns undefined | T

drawParticle

Parameters

particle: Particle

delta: IDelta

Returns void

drawParticlePlugin

Parameters

plugin: IContainerPlugin

particle: Particle

delta: IDelta

Returns void

drawPlugin

Parameters

plugin: IContainerPlugin

delta: IDelta

Returns void

init

Returns Promise<void>

initBackground

Returns void

initPlugins

Returns void

initUpdaters

`Private` `Readonly` _applyPostDrawUpdaters

`Private` `Readonly` _applyPreDrawUpdaters

`Private` `Readonly` _applyResizePlugins

`Private` _colorPlugins

`Private` _context

`Private` `Optional` _coverColorStyle

`Private` _generated

`Private` `Readonly` _getPluginParticleColors

`Private` `Readonly` _initCover

`Private` `Readonly` _initStyle

`Private` `Readonly` _initTrail

`Private` `Optional` `Readonly` _mutationObserver

`Private` `Optional` _originalStyle

`Private` `Readonly` _paintBase

`Private` `Readonly` _paintImage

`Private` _postDrawUpdaters

`Private` _preDrawUpdaters

`Private` `Readonly` _repairStyle

`Private` `Readonly` _resetOriginalStyle

`Private` _resizePlugins

`Private` `Readonly` _safeMutationObserver

`Private` `Readonly` _setFullScreenStyle

`Private` `Optional` _trailFill

`Private` `Readonly` container

`Optional` element

`Optional` resizeFactor

`Readonly` size

`Private` _fullScreen