GPUCommandBuffer: label property

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

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

This can be set by providing a label property in the descriptor object passed into the originating 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 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

See also