Class WGSLShaderEntity<T>

constructor

• new WGSLShaderEntity<T>(name, props?, action?, w?, h?, startTimeinMs?, durationInMs?): WGSLShaderEntity<T>

• Type Parameters

  • T extends IWGSLShaderProperties

  Parameters

  • name: string
  • Optionalprops: T
  • Optionalaction: ((time: number, shaderRender: WGSLShaderRenderer, properties: IWGSLShaderProperties, sequence?: Sequence, entity?: WGSLShaderEntity<T>) => void)
    • • (time, shaderRender, properties, sequence?, entity?): void

      • Parameters

        • time: number
        • shaderRender: WGSLShaderRenderer
        • properties: IWGSLShaderProperties
        • Optionalsequence: Sequence
        • Optionalentity: WGSLShaderEntity<T>

        Returns void

  • Optionalw: number
  • Optionalh: number
  • OptionalstartTimeinMs: number
  • OptionaldurationInMs: number

  Returns WGSLShaderEntity<T>

Optionalaction

OptionalbarListeners

OptionalbeatListeners

canvas

OptionaldurationInMs

Optionalh

name

Optionalprops

Optionalscene

shaderRenderer

OptionalstartTimeinMs

OptionaltickListeners

OptionaltransitionIn

OptionaltransitionOut

Optionalw

bindToScene

• bindToScene(scene): void

• Parameters

  • scene: Scene

  Returns void

copyToCanvas

• copyToCanvas(targetCanvas, sequence): void

• Copies the entity's canvas to the target canvas.

  Parameters

  • targetCanvas: HTMLCanvasElement

    The target canvas to copy to.
  • sequence: Sequence

  Returns void

onBar

• onBar<T>(listener): this

• Adds an event listener for when a bar is complete.

  Type Parameters

  • T

  Parameters

  • listener: ((ts: number, count: number, propertyBag?: T) => void)

    The function to call when a bar is complete.

    • • (ts, count, propertyBag?): void

      • Parameters

        • ts: number
        • count: number
        • OptionalpropertyBag: T

        Returns void

  Returns this

  The Entity instance for chaining.

onBeat

• onBeat<T>(listener): this

• Adds an event listener for when a beat occurs.

  Type Parameters

  • T

  Parameters

  • listener: ((time: number, count: number, propertyBag?: T) => void)

    The function to call when a beat occurs.

    • • (time, count, propertyBag?): void

      • Parameters

        • time: number
        • count: number
        • OptionalpropertyBag: T

        Returns void

  Returns this

  The Entity instance for chaining.

onTick

• onTick<T>(listener): this

• Adds an event listener for when a tick occurs.

  Type Parameters

  • T

  Parameters

  • listener: ((time: number, count: number, propertyBag?: T) => void)

    The function to call when a tick occurs.

    • • (time, count, propertyBag?): void

      • Parameters

        • time: number
        • count: number
        • OptionalpropertyBag: T

        Returns void

  Returns this

  The Entity instance for chaining.

update

• update(timeStamp): void

• Updates the ShaderEntity by calling the action function (if provided) and then updating the ShaderRenderer.

  Parameters

  • timeStamp: number

    The current timestamp in the animation.

  Returns void