WebGPU API
The clearBuffer() method of the
GPUCommandEncoder interface encodes a command that fills a region of a GPUBuffer with zeroes.
Syntax
clearBuffer(buffer)
clearBuffer(buffer, offset)
clearBuffer(buffer, offset, size)
Parameters
buffer- : A GPUBuffer object representing the buffer to clear.
offset- : A number representing the offset, in bytes, from the start of the
bufferto the sub-region to clear. If omitted,offsetdefaults to 0.
- : A number representing the offset, in bytes, from the start of the
size- : A number representing the size, in bytes, of the sub-region to clear. If omitted,
sizedefaults to thebuffersize -offset.
- : A number representing the size, in bytes, of the sub-region to clear. If omitted,
Return value
None (undefined).
Validation
The following criteria must be met when calling clearBuffer(), otherwise a GPUValidationError is generated and the GPUCommandEncoder becomes invalid:
- The
buffer's GPUBuffer.usage includes theGPUBufferUsage.COPY_DSTflag. offsetandsizeare both multiples of 4.- The
buffer's GPUBuffer.size is greater than or equal tooffset+size.
Examples
// …
const buffer = device.createBuffer({
size: 1000,
usage: GPUBufferUsage.MAP_READ | GPUBufferUsage.COPY_DST,
});
// Later on
const commandBuffer = device.createCommandEncoder();
commandEncoder.clearBuffer(buffer);
// …
Specifications
Browser compatibility
See also
- The WebGPU API
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
