GPURenderBundleEncoder: finish() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("WebGPU API")}}{{SecureContext_Header}}{{AvailableInWorkers}}
The **finish()** method of the {{domxref("GPURenderBundleEncoder")}} interface completes recording of the current render bundle command sequence, returning a {{domxref("GPURenderBundle")}} object that can be passed into a {{domxref("GPURenderPassEncoder.executeBundles()")}} call to execute those commands in a specific render pass.
Syntax
finish(descriptor)Parameters
descriptor{{optional_inline}}- : An object containing the following properties:
label{{optional_inline}}- : A string providing a label that can be used to identify the object, for example in {{domxref("GPUError")}} messages or console warnings.
Return value
A {{domxref("GPURenderBundle")}} object instance.
Validation
The following criteria must be met when calling **finish()**, otherwise a {{domxref("GPUValidationError")}} is generated and the {{domxref("GPURenderBundleEncoder")}} becomes invalid:
- The {{domxref("GPURenderBundleEncoder")}} is open (i.e., not already ended via a
finish()call). - The debug stack for the current render pass is empty (i.e., no render pass debug group is currently open, as opened by {{domxref("GPURenderBundleEncoder.pushDebugGroup", "pushDebugGroup()")}}).
Examples
const renderBundleEncoder = device.createRenderBundleEncoder({
colorFormats: [presentationFormat],
});
recordRenderPass(renderBundleEncoder);
const renderBundle = renderBundleEncoder.finish();The above snippet is taken from the WebGPU Samples Animometer example.
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- The WebGPU API