Import
WorkerPool is an addon, and must be imported explicitly, see Installation#Addons.
import { WorkerPool } from 'three/addons/utils/WorkerPool.js';Constructor
new WorkerPool( pool : number )
Constructs a new Worker pool.
| pool |
The size of the pool. Default is |
Classes
- WorkerPool
Properties
.pool : number
The size of the pool.
Default is 4.
.queue : Array.<Object>
A message queue.
.workerCreator : function
A factory function for creating workers.
.workerStatus : number
The current worker status.
.workers : Array.<Worker>
An array of Workers.
.workersResolve : Array.<function()>
An array with resolve functions for messages.
Methods
.dispose()
Terminates all Workers of this pool. Call this method whenever this Worker pool is no longer used in your app.
.postMessage( msg : Object, transfer : Array.<ArrayBuffer> ) : Promise
Post a message to an idle Worker. If no Worker is available, the message is pushed into a message queue for later processing.
| msg |
The message. |
| transfer |
An array with array buffers for data transfer. |
- Returns: A Promise that resolves when the message has been processed.
.setWorkerCreator( workerCreator : function )
Sets a function that is responsible for creating Workers.
| workerCreator |
The worker creator function. |
.setWorkerLimit( pool : number )
Sets the Worker limit
| pool |
The size of the pool. |