GPURenderBundleEncoder: label property
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The label
read-only property of the
GPURenderBundleEncoder
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.createRenderBundleEncoder()
call, or you can get and set it directly on the GPURenderBundleEncoder
object.
Note: This property is functionally identical to its equivalent on GPURenderPassEncoder
— label
.
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 GPURenderBundleEncoder.label
:
js
const renderBundleEncoder = device.createRenderBundleEncoder({
colorFormats: [presentationFormat],
});
renderBundleEncoder.label = "myrenderbundleencoder";
console.log(renderBundleEncoder.label); // "myrenderbundleencoder"
Setting a label via the originating GPUDevice.createRenderBundleEncoder()
call, and then getting it via GPURenderBundleEncoder.label
:
js
const renderBundleEncoder = device.createRenderBundleEncoder({
colorFormats: [presentationFormat],
label: "myrenderbundleencoder",
});
console.log(renderBundleEncoder.label); // "myrenderbundleencoder"
Specifications
Specification |
---|
WebGPU # dom-gpuobjectbase-label |
Browser compatibility
BCD tables only load in the browser
See also
- The WebGPU API