GPURenderPassEncoder:label 属性

实验性:这是一个 实验性技术
在生产环境中使用之前,请仔细查看 浏览器兼容性表

安全上下文:此功能仅在 安全上下文(HTTPS)中可用,在某些或所有 支持的浏览器 中。

label 属性是 GPURenderPassEncoder 接口的只读属性,它是一个字符串,用于提供可用于识别对象的标签,例如在 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 = "myrenderpassencoder";

console.log(passEncoder.label); // "myrenderpassencoder"

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

js
const commandEncoder = device.createCommandEncoder();

const renderPassDescriptor = {
  colorAttachments: [
    {
      clearValue: clearColor,
      loadOp: "clear",
      storeOp: "store",
      view: context.getCurrentTexture().createView(),
    },
  ],
  label: "myrenderpassencoder",
};

const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

console.log(passEncoder.label); // "myrenderpassencoder"

规范

规范
WebGPU
# dom-gpuobjectbase-label

浏览器兼容性

BCD 表格仅在浏览器中加载

另请参阅