onSubmittedWorkDone method
The onSubmittedWorkDone()
method of the
GPUQueue interface returns a Promise
that resolves when all the work
submitted to the GPU via this GPUQueue
at the point the method is called
has been processed.
This includes the completion of any GPUBuffer.mapAsync calls made on
GPUBuffer
s used in commands submitted to the queue, before
onSubmittedWorkDone()
is called.
Note: In most cases, you do not need to call onSubmittedWorkDone()
.
You do not need to call it for mapping a buffer. mapAsync
guarantees work submitted
to the queue before calling mapAsync
happens before the mapAsync
returns (see WebGPU spec: section
5.2)
The two use cases for onSubmittedWorkDone
- Waiting for multiple buffer mapping (slow)
// good
await Promise.all([
buffer1.mapAsync(),
buffer2.mapAsync(),
buffer3.mapAsync(),
]);
data1 = buffer1.getMappedRange();
data2 = buffer2.getMappedRange();
data3 = buffer3.getMappedRange();
// works but slow
buffer1.mapAsync();
buffer2.mapAsync();
buffer3.mapAsync();
await device.queue.onSubmittedWorkDone();
data1 = buffer1.getMappedRange();
data2 = buffer2.getMappedRange();
data3 = buffer3.getMappedRange();
The reason the second method is slow is, the implementation may be able to map the buffers before all the submitted work is done. For example, if all the buffers are finished being used, but more work (unrelated to the buffers) is already submitted, then you'll end up waiting longer using the second method than the first.
- Throttling work
If you are doing heavy compute work and you submit too much work at once, the browser may kill your work. You can throttle the work by only submitting more work when the work you've already submitted is done.
Implementation
external JSPromise<JSAny?> onSubmittedWorkDone();