GPUBindGroup: label property

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The label property of the GPUBindGroup interface provides 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 GPUDevice.createBindGroup() call, or you can get and set it directly on the GPUBindGroup object.

Value

A string. If this has not been previously set as described above, it will be an empty string.

Examples

Setting and getting a label via GPUBindGroup.label:

js

// ...

const bindGroup = device.createBindGroup({
  layout: bindGroupLayout,
  entries: [
    {
      binding: 0,
      resource: {
        buffer: output,
      },
    },
  ],
});

bindGroup.label = "mybindgroup";

console.log(bindGroup.label); // "mybindgroup";

Setting a label via the originating GPUDevice.createBindGroup() call, and then getting it via GPUBindGroup.label:

js

// ...

const bindGroup = device.createBindGroup({
  layout: bindGroupLayout,
  entries: [
    {
      binding: 0,
      resource: {
        buffer: output,
      },
    },
  ],
  label: "mybindgroup",
});

console.log(bindGroup.label); // "mybindgroup";

Specifications

Specification
WebGPU
# dom-gpuobjectbase-label

Browser compatibility

BCD tables only load in the browser

See also