GPURenderPassEncoder:label 属性

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

注意:此功能在 Web Workers 中可用。

GPURenderPassEncoder 接口的只读属性 label 是一个字符串,用于提供一个可以用来标识对象的标签,例如在 GPUError 消息或控制台警告中。

这可以通过在传递给原始 GPUCommandEncoder.beginRenderPass() 调用的描述符对象中提供一个 label 属性来设置,或者你也可以直接在 GPURenderPassEncoder 对象上获取和设置它。

一个字符串。如果之前没有设置标签值,则获取标签会返回一个空字符串。

示例

通过 GPURenderPassEncoder.label 设置和获取标签

js
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"

通过原始 GPUCommandEncoder.beginRenderPass() 调用设置标签,然后通过 GPURenderPassEncoder.label 获取它

js
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"

规范

规范
WebGPU
# dom-gpuobjectbase-label

浏览器兼容性

另见