ContextQMD
Back to Content

GPUCommandBuffer: label property

files/en-us/web/api/gpucommandbuffer/label/index.md

latest1.2 KB
Original Source

{{APIRef("WebGPU API")}}{{SecureContext_Header}}{{AvailableInWorkers}}

The label read-only property of the {{domxref("GPUCommandBuffer")}} interface is a string providing a label that can be used to identify the object, for example in {{domxref("GPUError")}} messages or console warnings.

This can be set by providing a label property in the descriptor object passed into the originating {{domxref("GPUCommandEncoder.finish()")}} call, or you can get and set it directly on the GPUCommandBuffer object.

Value

A string. If no label value has previously been set, getting the label returns an empty string.

Examples

Setting and getting a label via GPUCommandBuffer.label:

js
const commandBuffer = commandEncoder.finish();
commandBuffer.label = "my_command_buffer";
console.log(commandBuffer.label); // "my_command_buffer"

Setting a label via the originating {{domxref("GPUCommandEncoder.finish()")}} call, and then getting it via GPUCommandBuffer.label:

js
const commandBuffer = commandEncoder.finish({
  label: "my_command_buffer",
});

console.log(commandBuffer.label); // "my_command_buffer"

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also