WebGPU API
The executeBundles() method of the
GPURenderPassEncoder interface executes commands previously recorded into the referenced GPURenderBundles, as part of this render pass.
[!NOTE] After calling
executeBundles()the currently set vertex buffers, index buffers, bind groups, and pipeline are all cleared, even if no bundles are actually executed.
Syntax
executeBundles(bundles)
Parameters
bundles- : An array of GPURenderBundle objects, containing the pre-recorded commands to execute.
Return value
None (undefined).
Validation
The following criteria must be met when calling executeBundles(), otherwise a GPUValidationError is generated and the GPURenderPassEncoder becomes invalid.
For each GPURenderBundle:
- If the render pass's
depthReadOnlyproperty (as specified in the descriptor of the originating GPUCommandEncoder.beginRenderPass() call) istrue, then the bundle'sdepthReadOnlyproperty (as specified in the descriptor of the GPUDevice.createRenderBundleEncoder() call that created the originating GPURenderBundleEncoder) is alsotrue. - If the render pass's
stencilReadOnlyproperty (as specified in the descriptor of the originating GPUCommandEncoder.beginRenderPass() call) istrue, then the bundle'sstencilReadOnlyproperty (as specified in the descriptor of the GPUDevice.createRenderBundleEncoder() call that created the originating GPURenderBundleEncoder) is alsotrue. - The layout of the render pipeline specified in GPURenderPassEncoder.setPipeline() (as defined in the descriptor of the originating GPUDevice.createRenderPipeline() call) equals the layout of the render bundle pipeline specified in GPURenderBundleEncoder.setPipeline().
Examples
In the WebGPU Samples Animometer example, a lot of like operations are done on many different objects simultaneously. executeBundles() is used to reuse the work on multiple render passes to improve performance. Study the example code listing for the full context.
// …
return function doDraw(timestamp) {
if (startTime === undefined) {
startTime = timestamp;
}
uniformTime[0] = (timestamp - startTime) / 1000;
device.queue.writeBuffer(uniformBuffer, timeOffset, uniformTime.buffer);
renderPassDescriptor.colorAttachments[0].view = context
.getCurrentTexture()
.createView();
const commandEncoder = device.createCommandEncoder();
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
if (settings.renderBundles) {
passEncoder.executeBundles([renderBundle]);
} else {
recordRenderPass(passEncoder);
}
passEncoder.end();
device.queue.submit([commandEncoder.finish()]);
};
// …
Specifications
Browser compatibility
See also
- The WebGPU API
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
