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

瀏覽器相容性

另見