Documentation
    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: undefined | HTMLCanvasElement

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

    canvasOffscreen: undefined | OffscreenCanvas

    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: 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