GPUCommandEncoder: clearBuffer() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("WebGPU API")}}{{SecureContext_Header}}{{AvailableInWorkers}}
The **clearBuffer()** method of the {{domxref("GPUCommandEncoder")}} interface encodes a command that fills a region of a {{domxref("GPUBuffer")}} with zeroes.
Syntax
js-nolint
clearBuffer(buffer)
clearBuffer(buffer, offset)
clearBuffer(buffer, offset, size)Parameters
buffer- : A {{domxref("GPUBuffer")}} object representing the buffer to clear.
offset{{optional_inline}}- : A number representing the offset, in bytes, from the start of the
bufferto the sub-region to clear. If omitted,offsetdefaults to 0. size{{optional_inline}}- : A number representing the size, in bytes, of the sub-region to clear. If omitted,
sizedefaults to thebuffersize -offset.
Return value
None ({{jsxref("undefined")}}).
Validation
The following criteria must be met when calling **clearBuffer()**, otherwise a {{domxref("GPUValidationError")}} is generated and the {{domxref("GPUCommandEncoder")}} becomes invalid:
- The
buffer's {{domxref("GPUBuffer.usage")}} includes theGPUBufferUsage.COPY_DSTflag. offsetandsizeare both multiples of 4.- The
buffer's {{domxref("GPUBuffer.size")}} is greater than or equal tooffset+size.
Examples
js
// …
const buffer = device.createBuffer({
size: 1000,
usage: GPUBufferUsage.MAP_READ | GPUBufferUsage.COPY_DST,
});
// Later on
const commandBuffer = device.createCommandEncoder();
commandEncoder.clearBuffer(buffer);
// …Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- The WebGPU API