Class GLSLShaderEntity<T>

Type Parameters

Implements

Constructors

constructor

Properties

action? barListeners? beatListeners? canvas durationInMs? h? name props? scene? shaderRenderer startTimeinMs? tickListeners? transitionIn? transitionOut? w?

Methods

addPostProcessor bindToScene copyToCanvas onBar onBeat onTick update

Constructors

constructor

Properties

Optionalaction

action?: ((time: number, shaderRender: GLSLShaderRenderer, properties: IGLSLShaderProperties, sequence?: Sequence, entity?: GLSLShaderEntity<T>) => void)

An optional action function to be called before rendering the shaders.

OptionalbarListeners

barListeners?: ((time: number, count: number, propertyBag: T) => void)[] = []

OptionalbeatListeners

beatListeners?: ((time: number, count: number, propertyBag: T) => void)[] = []

canvas

canvas: HTMLCanvasElement

OptionaldurationInMs

durationInMs?: number

Optionalh

h?: number

The height of the entity's canvas.

name

name: string

The key or identifier for the entity.

Optionalprops

props?: T

The properties for the entity, including shader code and render buffers.

Optionalscene

scene?: Scene

shaderRenderer

shaderRenderer: GLSLShaderRenderer

OptionalstartTimeinMs

startTimeinMs?: number

OptionaltickListeners

tickListeners?: ((time: number, count: number, propertyBag: T) => void)[] = []

OptionaltransitionIn

transitionIn?: ((ctx: CanvasRenderingContext2D, progress: number) => void)

OptionaltransitionOut

transitionOut?: ((ctx: CanvasRenderingContext2D, progress: number) => void)

Optionalw

w?: number

The width of the entity's canvas.

Methods

addPostProcessor

  • addPostProcessor(processor): void

  • Adds a post-processing function to the entity.

    Parameters

    • processor: ((ctx: CanvasRenderingContext2D, sequence: Sequence) => void)

      The post-processing function to add.

        • (ctx, sequence): void

        • Parameters

          • ctx: CanvasRenderingContext2D
          • sequence: Sequence

          Returns void

    Returns void

bindToScene

copyToCanvas

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods