Limited availability
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
The label
read-only property of the GPURenderPassEncoder
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.beginRenderPass()
call, or you can get and set it directly on the GPURenderPassEncoder
object.
A string. If no label value has previously been set, getting the label returns an empty string.
ExamplesSetting and getting a label via GPURenderPassEncoder.label
:
const commandEncoder = device.createCommandEncoder();
const renderPassDescriptor = {
colorAttachments: [
{
clearValue: clearColor,
loadOp: "clear",
storeOp: "store",
view: context.getCurrentTexture().createView(),
},
],
};
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
passEncoder.label = "my_render_pass_encoder";
console.log(passEncoder.label); // "my_render_pass_encoder"
Setting a label via the originating GPUCommandEncoder.beginRenderPass()
call, and then getting it via GPURenderPassEncoder.label
:
const commandEncoder = device.createCommandEncoder();
const renderPassDescriptor = {
colorAttachments: [
{
clearValue: clearColor,
loadOp: "clear",
storeOp: "store",
view: context.getCurrentTexture().createView(),
},
],
label: "my_render_pass_encoder",
};
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
console.log(passEncoder.label); // "my_render_pass_encoder"
Specifications Browser compatibility See also
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4