GPURenderBundleEncoder: label property

Secure contextAvailable in workers

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 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:

const renderBundleEncoder = device.createRenderBundleEncoder({
  colorFormats: [presentationFormat],
});

renderBundleEncoder.label = "my_render_bundle_encoder";
console.log(renderBundleEncoder.label); // "my_render_bundle_encoder"

Setting a label via the originating createRenderBundleEncoder() call, and then getting it via GPURenderBundleEncoder.label:

const renderBundleEncoder = device.createRenderBundleEncoder({
  colorFormats: [presentationFormat],
  label: "my_render_bundle_encoder",
});

console.log(renderBundleEncoder.label); // "my_render_bundle_encoder"

Specifications

Browser compatibility

See also

• The WebGPU API