GPUShaderModule: label property

Secure contextAvailable in workers

The label property of the GPUShaderModule 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 createShaderModule() call, or you can get and set it directly on the GPUShaderModule 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 GPUShaderModule.label:

// …

const shaderModule = device.createShaderModule({
  code: shaders,
});

shaderModule.label = "my_shader";

console.log(shaderModule.label); // "my_shader"

Setting a label via the originating createShaderModule() call, and then getting it via GPUShaderModule.label:

// …

const shaderModule = device.createShaderModule({
  code: shaders,
  label: "my_shader",
});

console.log(shaderModule.label); // "my_shader"

Specifications

Browser compatibility

See also

• The WebGPU API