The GPUCompilationInfo
interface of the WebGPU API represents an array of GPUCompilationMessage
objects generated by the GPU shader module compiler to help diagnose problems with shader code.
GPUCompilationInfo
is accessed via GPUShaderModule.getCompilationInfo()
.
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
}
@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;
}
`;
When we compile the shader module, we use getCompilationInfo()
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);
console.log(firstMessage.message);
console.log(firstMessage.type);
}