Class EffectMedia

A base class that can be listened to, and dispatch events.

Hierarchy (view full)

AsyncMedia
- EffectMedia

Constructors

constructor

new EffectMedia(backingMedia, options?): EffectMedia
Parameters
- backingMedia: BackingMediaSource
- Optionaloptions: EffectMediaOptions
Returns EffectMedia
Overrides AsyncMedia.constructor
- Defined in src/helpers/EffectMedia.ts:26

Properties

`Private`_currentFrame

_currentFrame: null | FastCanvasImageSource = null

`Private`_presentationHash

_presentationHash: number = 0

`Readonly`backingMedia

backingMedia: BackingMediaSource

`Private`ctx

ctx: null | BackingCanvasContext = null

`Private`dirty

dirty: boolean = true

`Private`lastPHashBeforeRemove

lastPHashBeforeRemove: number = 0

`Protected` `Readonly`listeners

listeners: ConcurrentCollection<Listener<BackingMediaEventType>> = ...

`Readonly`resolution

resolution: number

`Readonly`tint

tint: number

`Private`waiting

waiting: boolean = false

`Private` `Readonly`wrapper

wrapper: BackingMediaWrapper

Accessors

currentFrame

get currentFrame(): null | FastCanvasImageSource
Returns null | FastCanvasImageSource
Overrides AsyncMedia.currentFrame
- Defined in src/helpers/EffectMedia.ts:198

height

get height(): number
Returns number
Overrides AsyncMedia.height
- Defined in src/helpers/EffectMedia.ts:91

presentationHash

get presentationHash(): number
Returns number
Overrides AsyncMedia.presentationHash
- Defined in src/helpers/EffectMedia.ts:203

width

get width(): number
Returns number
Overrides AsyncMedia.width
- Defined in src/helpers/EffectMedia.ts:87

Methods

addEventListener

addEventListener(listener): void
Listen to events from this helper. Duplicate listeners allowed.
Parameters
- listener: Listener<BackingMediaEventType>
Returns void
Overrides AsyncMedia.addEventListener
- Defined in src/helpers/EffectMedia.ts:48

`Protected`dispatchEvent

dispatchEvent(event): void
Dispatch an event to all listeners.
Parameters
- event: BackingMediaEventType
Returns void
Inherited from AsyncMedia.dispatchEvent
- Defined in src/helpers/Notifier.ts:46

`Protected`dispatchToListener

dispatchToListener(event, listener): void
Dispatch an event to a specific listener. Listener does not have to be added
Parameters
- event: BackingMediaEventType
- listener: Listener<BackingMediaEventType>
Returns void
Inherited from AsyncMedia.dispatchToListener
- Defined in src/helpers/Notifier.ts:37

`Private`evaluateEffect

evaluateEffect(): void
Returns void
- Defined in src/helpers/EffectMedia.ts:143

`Private`getScratchCtx

getScratchCtx(width, height): BackingCanvasContext
Parameters
- width: number
- height: number
Returns BackingCanvasContext
- Defined in src/helpers/EffectMedia.ts:95

`Private`handleBitmapPromise

handleBitmapPromise(promise): void
Parameters
- promise: Promise<ImageBitmap>
Returns void
- Defined in src/helpers/EffectMedia.ts:131

`Private` `Readonly`onWrapperEvent

onWrapperEvent(ev): void
Parameters
- ev: BackingMediaEventType
Returns void
- Defined in src/helpers/EffectMedia.ts:35

removeEventListener

removeEventListener(listener): boolean
Stop listening to events from this helper. If a duplicate listener is removed, only one is removed.
Parameters
- listener: Listener<BackingMediaEventType>
Returns boolean
True if a listener was removed, false otherwise.
Overrides AsyncMedia.removeEventListener
- Defined in src/helpers/EffectMedia.ts:64

`Private`setCurrentFrame

setCurrentFrame(currentFrame): void
Parameters
- currentFrame: FastCanvasImageSource
Returns void
- Defined in src/helpers/EffectMedia.ts:119

`Static`fromURL

fromURL(url, options?): EffectMedia
Parameters
- url: string
- Optionaloptions: EffectMediaOptions
Returns EffectMedia
- Defined in src/helpers/EffectMedia.ts:75