GPUComputePipeline: label property
The label property of the GPUComputePipeline 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.createComputePipeline() or GPUDevice.createComputePipelineAsync() call, or you can get and set it directly on the GPUComputePipeline 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 GPUComputePipeline.label:
const computePipeline = device.createComputePipeline({
layout: device.createPipelineLayout({
bindGroupLayouts: [bindGroupLayout],
}),
compute: {
module: shaderModule,
entryPoint: "main",
},
});
computePipeline.label = "mycomputepipeline";
console.log(computePipeline.label);
Setting a label via a GPUDevice.createComputePipeline() call, and then getting it via GPUComputePipeline.label:
const computePipeline = device.createComputePipeline({
layout: device.createPipelineLayout({
bindGroupLayouts: [bindGroupLayout],
}),
compute: {
module: shaderModule,
entryPoint: "main",
},
label: "mycomputepipeline",
});
console.log(computePipeline.label);
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
label |
113Currently supported on ChromeOS, macOS, and Windows only.
|
113Currently supported on ChromeOS, macOS, and Windows only.
|
previewCurrently supported on Linux and Windows only.
|
No |
99Currently supported on ChromeOS, macOS, and Windows only.
|
No |
No |
No |
No |
No |
No |
No |
See also