GPUCompilationInfo
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
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()
.
Instance properties
messages
Experimental Read only-
An array of
GPUCompilationMessage
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
}
@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); // 9
console.log(firstMessage.message); // "expected ')' for function declaration"
console.log(firstMessage.type); // "error"
// ...
}
Specifications
Specification |
---|
WebGPU # gpucompilationinfo |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | server | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GPUCompilationInfo | |||||||||||||
messages |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Partial support
- Partial support
- In development. Supported in a pre-release version.
- In development. Supported in a pre-release version.
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.
See also
- The WebGPU API