GPURenderBundleEncoder: draw() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The draw()
method of the
GPURenderBundleEncoder
interface draws primitives based on the vertex buffers provided by setVertexBuffer()
.
Note: This method is functionally identical to its equivalent on GPURenderPassEncoder
— draw()
.
Syntax
js
draw(vertexCount)
draw(vertexCount, instanceCount)
draw(vertexCount, instanceCount, firstVertex)
draw(vertexCount, instanceCount, firstVertex, firstInstance)
Parameters
vertexCount
-
A number defining the number of vertices to draw.
instanceCount
Optional-
A number defining the number of instances to draw. If omitted,
instanceCount
defaults to 1. firstVertex
Optional-
A number defining the offset into the vertex buffers, in vertices, to begin drawing from. If omitted,
firstVertex
defaults to 0. firstInstance
Optional-
A number defining the first instance to draw. If omitted,
firstInstance
defaults to 0.
Return value
None (Undefined
).
Examples
js
function recordRenderPass(
passEncoder: GPURenderBundleEncoder | GPURenderPassEncoder // TypeScript
) {
if (settings.dynamicOffsets) {
passEncoder.setPipeline(dynamicPipeline);
} else {
passEncoder.setPipeline(pipeline);
}
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.setBindGroup(0, timeBindGroup);
const dynamicOffsets = [0];
for (let i = 0; i < numTriangles; ++i) {
if (settings.dynamicOffsets) {
dynamicOffsets[0] = i * alignedUniformBytes;
passEncoder.setBindGroup(1, dynamicBindGroup, dynamicOffsets);
} else {
passEncoder.setBindGroup(1, bindGroups[i]);
}
passEncoder.draw(3, 1, 0, 0);
}
}
The above snippet is taken from the WebGPU Samples Animometer example.
Specifications
Specification |
---|
WebGPU # dom-gpurendercommandsmixin-draw |
Browser compatibility
BCD tables only load in the browser
See also
- The WebGPU API