GPUDevice: label property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Want more support for this feature? Tell us why.

Learn more
See full compatibility

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 GPUDevice interface is a string providing a label that can be used to identify the object, for example in GPUError messages or console warnings.

Value

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

Examples

async function init() {
 if (!navigator.gpu) {
 throw Error("WebGPU not supported.");
 }
 const adapter = await navigator.gpu.requestAdapter();
 if (!adapter) {
 throw Error("Couldn't request WebGPU adapter.");
 }
 // Create a GPUDevice
 const device = await adapter.requestDevice();
 // Set a label
 device.label = "my_label";
 // Get a label
 console.log(device.label);
 // ...
}