GPUCommandEncoder: label property
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The label
read-only property of the
GPUCommandEncoder
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 GPUDevice.createCommandEncoder()
call, or you can get and set it directly on the GPUCommandEncoder
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 GPUCommandEncoder.label
:
const commandEncoder = device.createCommandEncoder();
commandEncoder.label = "mycommandencoder";
console.log(commandEncoder.label); // "mycommandencoder";
Setting a label via the originating GPUDevice.createCommandEncoder()
call, and then getting it via GPUCommandEncoder.label
:
const commandEncoder = device.createCommandEncoder({
label: "mycommandencoder",
});
console.log(commandEncoder.label); // "mycommandencoder";
Specifications
Specification |
---|
WebGPU # dom-gpuobjectbase-label |
Browser compatibility
BCD tables only load in the browser
See also
- The WebGPU API