Documentation
    Preparing search index...

    Class CanvasWorkerInstance<TCanvas, TApplicationOptions, TKernel>

    The canvas worker instance handles a web worker instance in worker instance itself, and handles a feedback channel to the host application.

    It provides a thin abstraction over the web worker IPC messaging.

    // Construct inside of worker from global scope and rendering kernel class.
    const worker = new CanvasWorkerInstance(self, RenderKernel);
    // Listen to custom events (messages) you send from the host.
    worker.addEventListener("fade", () => worker.renderKernel?.fadeOut());

    Type Parameters

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    canvas id offscreenCanvas offscreenContext renderKernel renderLoop self

    Methods

    addEventListener dispatchEvent postMessage reconfigure removeEventListener render start

    Constructors

    Properties

    canvas: undefined | TCanvas

    The canvas element we're presenting to.

    id: string

    The ID of the worker.

    offscreenCanvas: undefined | OffscreenCanvas

    The offscreen canvas we're rendering to.

    offscreenContext: undefined | OffscreenCanvasRenderingContext2D

    Our rendering context to draw to.

    renderKernel: undefined | TKernel

    The rendering kernel, which produces frames, and renders them to our offscreen canvas.

    renderLoop: undefined | RenderLoop

    Manages frame rendering timing.

    self: typeof globalThis

    The global scope of the worker.

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods