GPUShaderModule: getCompilationInfo()-Methode

Limited availability

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

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

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 getCompilationInfo()-Methode der GPUShaderModule-Schnittstelle gibt ein Promise zurück, das mit einem GPUCompilationInfo-Objekt erfüllt wird, welches Nachrichten enthält, die während der Kompilierung des GPUShaderModule erzeugt wurden.

Syntax

js
getCompilationInfo()

Parameter

Keine.

Rückgabewert

Ein Promise, das mit einem GPUCompilationInfo-Objekt erfüllt wird.

GPUCompilationInfo enthält eine messages-Eigenschaft, die ein Array von GPUCompilationMessage-Objekten beinhaltet, von denen jedes die Details einer individuellen Kompilierungsmeldung enthält.

Beispiele

Im folgenden Beispiel haben wir absichtlich eine Klammer aus einer Funktionsdeklaration in unserem Shader-Code weggelassen:

js
const shaders = `
struct VertexOut {
  @builtin(position) position : vec4f,
  @location(0) color : vec4f
}

@vertex
fn vertex_main(@location(0) position: vec4f,
               @location(1) color: vec4f -> VertexOut
{
  var output : VertexOut;
  output.position = position;
  output.color = color;
  return output;
}

@fragment
fn fragment_main(fragData: VertexOut) -> @location(0) vec4f
{
  return fragData.color;
}
`;

Beim Kompilieren des Shader-Moduls verwenden wir getCompilationInfo(), um Informationen über den resultierenden Fehler zu erhalten:

js
async function init() {
  // ...

  const shaderModule = device.createShaderModule({
    code: shaders,
  });

  const shaderInfo = await shaderModule.getCompilationInfo();
  const firstMessage = shaderInfo.messages[0];

  console.log(firstMessage.lineNum); // 9
  console.log(firstMessage.message); // "expected ')' for function declaration"
  console.log(firstMessage.type); // "error"

  // ...
}

Spezifikationen

Specification
WebGPU
# dom-gpushadermodule-getcompilationinfo

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch