Class CanvasImageSequence

Hierarchy

CanvasImageSequence

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CanvasImageSequence(element: HTMLElement, imageSets: Array<CanvasImageSequenceImageSet>, options: CanvasImageSequenceOptions, dpr: number): CanvasImageSequence

- Defined in dom/canvas-image-sequence.ts:752
Parameters
- element: HTMLElement
- imageSets: Array<CanvasImageSequenceImageSet>
- Optional options: CanvasImageSequenceOptions
- Optional dpr: number
Returns CanvasImageSequence

Properties

isPlaying

isPlaying: boolean

lerpAmount

lerpAmount: number = 1

Methods

dispose

dispose(): void

- Defined in dom/canvas-image-sequence.ts:1564
Returns void

flush

flush(): void

- Defined in dom/canvas-image-sequence.ts:1201
Returns void

getActiveImages

getActiveImages(): Array<string>

- Defined in dom/canvas-image-sequence.ts:1053
Returns Array<string>

getHexColorAtPoint

getHexColorAtPoint(coords: Vector): string

- Defined in dom/canvas-image-sequence.ts:1538
Parameters
- coords: Vector
Returns string

getImageSize

getImageSize(): Object

- Defined in dom/canvas-image-sequence.ts:1557
Returns Object

load

load(): Promise<void>

- Defined in dom/canvas-image-sequence.ts:925
Returns Promise<void>

loadNewSet

loadNewSet(imageSets: Array<CanvasImageSequenceImageSet>): void

- Defined in dom/canvas-image-sequence.ts:955
Parameters
- imageSets: Array<CanvasImageSequenceImageSet>
Returns void

makeImage

makeImage(source: string): Promise<HTMLImageElement | null>

- Defined in dom/canvas-image-sequence.ts:1005
Parameters
- source: string
Returns Promise<HTMLImageElement | null>

play

play(from: number, to: number, duration: number): Promise<void>

- Defined in dom/canvas-image-sequence.ts:1509
Parameters
- from: number
- to: number
- duration: number
Returns Promise<void>

Promise A promise that completes when done.

renderByProgress

renderByProgress(n: number, noMultiInterpolate?: boolean): void

- Defined in dom/canvas-image-sequence.ts:1112
Parameters
- n: number
- Default value noMultiInterpolate: boolean = false
Returns void

resize

resize(): void

- Defined in dom/canvas-image-sequence.ts:906
Returns void

setClipInterpolations

setClipInterpolations(config: CanvasImageSequenceClipInterpolationConfig): void

- Defined in dom/canvas-image-sequence.ts:1095
Parameters
- config: CanvasImageSequenceClipInterpolationConfig
Returns void

setMultiInterpolation

setMultiInterpolation(interpolations: Array<rangedProgress>): void

- Defined in dom/canvas-image-sequence.ts:895
Parameters
- interpolations: Array<rangedProgress>
Returns void

setSizingOptions

setSizingOptions(options: CanvasImageSequenceOptions): void

- Defined in dom/canvas-image-sequence.ts:1484
Parameters
- options: CanvasImageSequenceOptions
Returns void

stop

stop(): void

- Defined in dom/canvas-image-sequence.ts:1546
Returns void