code

wgsl-analyzer

wgsl-analyzer is a language server plugin for the WGSL Shading language.

Features

Currently, wgsl-analyzer supports

• syntax highlighting
• basic autocomplete
• type checking
• go to definition
• basic formatting

If you have any suggestions or bug reports, feel free to open an issue at https://github.com/wgsl-analyzer/wgsl-analyzer/issues.

Configuration

In the wgsl-analyzer section in the vscode settings you can specify the following configuration options:

Custom server path

{
    "wgsl-analyzer.server.path": "~/.cargo/bin/wgsl_analyzer"
}

Custom imports

wgsl-analyzer supports #import directives in the flavour of Bevy Engine's shader preprocessor. You can define custom import snippet in the wgsl-analyzer.customImports section.

If you provide a URL with a http, https or file scheme that resource will be downloaded and used. Keep in mind that this will slow down the LSP startup, so if you notice significant delays (the extension will warn if it took longer than a second) consider replacing resources on the network by file URLs or inline text.

{
    "wgsl-analyzer.customImports": {
        "bevy_pbr::mesh_view_bind_group": "https://raw.githubusercontent.com/bevyengine/bevy/v0.6.0/crates/bevy_pbr/src/render/mesh_view_bind_group.wgsl",
        "bevy_pbr::mesh_struct": "https://raw.githubusercontent.com/bevyengine/bevy/v0.6.0/crates/bevy_pbr/src/render/mesh_struct.wgsl",
    }
}

Preprocessor defines

wgsl-analyzer supports #ifdef, #ifndef, #else, #endif directives in the flavour of Bevy Engine's shader preprocessor.

{
    "wgsl-analyzer.preprocessor.shaderDefs": [
        "VERTEX_TANGENTS"
    ]
}

Diagnostics

wgsl-analyer will support diagnostics for parsing errors, and optionally (by default yes) type errors and naga-reported validation errors. You can also additionally enable diagnostics for naga parsing errors.

{
    "wgsl-analyzer.diagnostics.typeErrors": true,
    "wgsl-analyzer.diagnostics.nagaParsing": false,
    "wgsl-analyzer.diagnostics.nagaValidation": true,
    "wgsl-analyzer.diagnostics.nagaVersion": "0.8", // either "0.8" or "main"
}

Inlay hints

wgsl-analyzer can display read-only virtual text snippets interspersed with code, used to display the inferred types of variable declarations or the names of function parameters at the call site.

{
    "wgsl-analyzer.inlayHints.enabled": true,
    "wgsl-analyzer.inlayHints.typeHints": true,
    "wgsl-analyzer.inlayHints.parameterHints": true,
    "wgsl-analyzer.inlayHints.structLayoutHints": false,
    "wgsl-analyzer.inlayHints.typeVerbosity": "compact",
}

The typeVerbosity argument can be either full, compact or inner, which will correspond to

var x: ref<function, f32, read_write> = 0.0;
var x: ref<f32> = 0.0;
var x: f32 = 0.0;

respectively. For more information, check out references and the "Load Rule" in the WGSL Spec.