@oliversalzburg/js-utils - v0.5.0
    Preparing search index...

    Class CanvasWorker<TApplicationOptions>

    The canvas worker handles a web worker instance in the canvas sandbox host.

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

    Type Parameters

    Hierarchy

    Index

    Constructors

    Properties

    canvas: HTMLCanvasElement | undefined

    The canvas element that this worker should handle. This is purely for informational purposes on the host side.

    canvasOffscreen: OffscreenCanvas | undefined

    The offscreen canvas that we created for this worker.

    id: string

    The ID of this worker.

    The application options for the worker.

    These are usually very similar, if not identical, to the host application options. Workers just usually get a different viewport assigned to them, correlating with the canvas element in the DOM that they draw to.

    workerInstance: Worker

    The web worker instance itself.

    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: EventListenerOrEventListenerObject | null
      • 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. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

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

      Returns void