GPURenderBundleEncoder: setVertexBuffer() method
The setVertexBuffer()
method of the GPURenderBundleEncoder
interface sets or unsets the current GPUBuffer
for the given slot that will provide vertex data for subsequent drawing commands.
Syntax
setVertexBuffer(slot, buffer, offset, size)
Parameters
-
slot
-
A number referencing the vertex buffer slot to set the vertex buffer for.
-
buffer
-
A GPUBuffer
representing the buffer containing the vertex data to use for subsequent drawing commands, or null
, in which case any previously-set buffer in the given slot is unset.
offset
Optional
-
A number representing the offset, in bytes, into buffer
where the vertex data begins. If omitted, offset
defaults to 0.
size
Optional
-
A number representing the size, in bytes, of the vertex data contained in buffer
. If omitted, size
defaults to the buffer
's GPUBuffer.size
- offset
.
Return value
Validation
The following criteria must be met when calling setVertexBuffer()
, otherwise a GPUValidationError
is generated and the GPURenderBundleEncoder
becomes invalid:
buffer
's GPUBuffer.usage
contains the GPUBufferUsage.VERTEX
flag.
slot
is less than the GPUDevice
's maxVertexBuffers
limit.
offset
+ size
is less than or equal to the buffer
's GPUBuffer.size
.
offset
is a multiple of 4.
Examples
Set vertex buffer
function recordRenderPass(
passEncoder: GPURenderBundleEncoder | GPURenderPassEncoder
) {
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.
Unset vertex buffer
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.setVertexBuffer(0, null);
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
setVertexBuffer |
113Currently supported on ChromeOS, macOS, and Windows only.
|
113Currently supported on ChromeOS, macOS, and Windows only.
|
previewCurrently supported on Linux and Windows only.
|
No |
99Currently supported on ChromeOS, macOS, and Windows only.
|
No |
No |
No |
No |
No |
No |
No |
unset_vertex_buffer |
115Currently supported on ChromeOS, macOS, and Windows only.
|
115Currently supported on ChromeOS, macOS, and Windows only.
|
No |
No |
101Currently supported on ChromeOS, macOS, and Windows only.
|
No |
No |
No |
No |
No |
No |
No |
See also