Constructs a new canvas worker.
The ID of the worker.
The code that the worker should run. It's common to use a hybrid code module
for as the sandbox application. This means the code of the host and the workers is identical,
they just construct different code path on load/init. In such case, the source can simply be
new URL(import.meta.url)
.
The canvas element to draw to.
The application options.
The canvas element that this worker should handle. This is purely for informational purposes on the host side.
The offscreen canvas that we created for this worker.
The ID of this worker.
Readonly
optionsThe 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.
Readonly
workerThe web worker instance itself.
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Optional
options: boolean | AddEventListenerOptionsDispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Posts a message to the worker.
As messages to workers are posted instead of sent, there is no delivery feedback.
The message to post.
Optional
transfer: Transferable[]The transferables to transfer to the worker with this message.
Removes the event listener in target's event listener list with the same type, callback, and options.
Optional
options: boolean | EventListenerOptions
The canvas worker handles a web worker instance in the canvas sandbox host.
It provides a thin abstraction over the web worker IPC messaging.