GPURenderPassEncoder: Labeleigenschaft

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die schreibgeschützte label-Eigenschaft der GPURenderPassEncoder-Schnittstelle ist ein String, der ein Label zur Verfügung stellt, das zur Identifizierung des Objekts verwendet werden kann, zum Beispiel in GPUError-Meldungen oder Konsolenwarnungen.

Diese kann durch das Bereitstellen einer label-Eigenschaft im Deskriptionsobjekt gesetzt werden, das im ursprünglichen GPUCommandEncoder.beginRenderPass()-Aufruf übergeben wird, oder Sie können sie direkt am GPURenderPassEncoder-Objekt abrufen und setzen.

Wert

Ein String. Wenn zuvor kein Labelwert festgelegt wurde, gibt das Abrufen des Labels einen leeren String zurück.

Beispiele

Ein Label über GPURenderPassEncoder.label setzen und abrufen:

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"

Ein Label über den ursprünglichen GPUCommandEncoder.beginRenderPass()-Aufruf setzen und dann über GPURenderPassEncoder.label abrufen:

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"

Spezifikationen

Specification
WebGPU
# dom-gpuobjectbase-label

Browser-Kompatibilität

Siehe auch