GPURenderBundle: label property
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.
Note: This feature is available inWeb Workers.
Thelabel read-only property of theGPURenderBundle interface is a string providing a label that can be used to identify the object, for example inGPUError messages or console warnings.
This can be set by providing alabel property in the descriptor object passed into the originatingGPURenderBundleEncoder.finish() call, or you can get and set it directly on theGPURenderBundle 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 viaGPURenderBundle.label:
const renderBundle = renderBundleEncoder.finish();renderBundle.label = "my_render_bundle";console.log(renderBundle.label); // "my_render_bundle"Setting a label via the originatingGPURenderBundleEncoder.finish() call, and then getting it viaGPURenderBundle.label:
const renderBundle = renderBundleEncoder.finish({ label: "my_render_bundle",});console.log(renderBundle.label); // "my_render_bundle"Specifications
| Specification |
|---|
| WebGPU # dom-gpuobjectbase-label |
Browser compatibility
See also
- TheWebGPU API