GPUCommandEncoder: finish() method

Secure contextAvailable in workers

The finish() method of the GPUCommandEncoder interface completes recording of the command sequence encoded on this GPUCommandEncoder, returning a corresponding GPUCommandBuffer.

Syntax

finish()
finish(descriptor)

Parameters

• descriptor Optional
  • : An object that can contain the following properties:
    • label Optional
      • : A string providing a label for the returned GPUCommandBuffer that can be used to identify it, for example in GPUError messages or console warnings.

Return value

A GPUCommandBuffer object instance.

Validation

The following criteria must be met when calling finish(), otherwise a GPUValidationError is generated and the GPUCommandEncoder becomes invalid:

• There are no active debug groups (i.e., started via pushDebugGroup()).
• The GPUCommandEncoder is in an open state — this means that:
  • There are no child GPUComputePassEncoder or GPURenderPassEncoders active that have not been ended (by calling end()).
  • The GPUCommandEncoder has not already had finish() called on it (in which case it cannot be used to encode any more commands).

Examples

// …

const commandBuffer = commandEncoder.finish();
device.queue.submit([commandBuffer]);

// …

Specifications

Browser compatibility

See also

• The WebGPU API