GPUCompilationInfo

Limited availability

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

Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.

Note: This feature is available inWeb Workers.

TheGPUCompilationInfo interface of theWebGPU API represents an array ofGPUCompilationMessage objects generated by the GPU shader module compiler to help diagnose problems with shader code.

GPUCompilationInfo is accessed viaGPUShaderModule.getCompilationInfo().

Instance properties

messagesRead only: An array ofGPUCompilationMessage objects, each one containing the details of an individual shader compilation message. Messages can be informational, warnings, or errors.

Examples

In the example below, we have deliberately left a parenthesis out of a function declaration in our shader code:

const shaders = `struct VertexOut {  @builtin(position) position : vec4f,  @location(0) color : vec4f}@vertexfn vertex_main(@location(0) position: vec4f,               @location(1) color: vec4f -> VertexOut{  var output : VertexOut;  output.position = position;  output.color = color;  return output;}@fragmentfn fragment_main(fragData: VertexOut) -> @location(0) vec4f{  return fragData.color;}`;

When we compile the shader module, we usegetCompilationInfo() to grab some information about the resulting error:

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"  // …}