GPUComputePassEncoder: label property
The label
read-only property of the GPUComputePassEncoder
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.beginComputePass()
call, or you can get and set it directly on the GPUComputePassEncoder
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 GPUComputePassEncoder.label
:
const commandEncoder = device.createCommandEncoder();
const passEncoder = commandEncoder.beginComputePass();
passEncoder.label = "mycomputepassencoder";
console.log(passEncoder.label);
Setting a label via the originating GPUCommandEncoder.beginComputePass()
call, and then getting it via GPUComputePassEncoder.label
:
const commandEncoder = device.createCommandEncoder();
const passEncoder = commandEncoder.beginComputePass({
label: "mycomputepassencoder",
});
console.log(passEncoder.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