Shader validator

This is a vscode extension allowing syntax highlighting, linting & symbol providing for HLSL / GLSL / WGSL shaders. It is using shader-language-server to lint shaders using common validator API & parse symbols for some code inspection.

Currently, it support some features and languages:

• Syntax Highlighting: Provide improved syntax highlighting for code.
• Diagnostic: Provide errors & warning as user type code.
• Symbol provider: provide goto, completion, hover, signature...
  • Local symbols: Provide all user created symbols (function, constant, types...).
  • Intrinsics symbols: Provide all languages provided intrinsics symbols.
• Regions: Detect inactive regions in code due to preprocessor and grey them out.

Features

Syntax highlighting

This extension provide improved syntax highlighting for HLSL, GLSL & WGSL than the base one in VS code.

Diagnostics

You cant lint your code in real time through this extension:

• GLSL relies on Glslang.
• HLSL relies on DirectX shader compiler on desktop, Glslang on the web (see below).
• WGSL relies on Naga.

Autocompletion

The extension will suggest you symbols from your file and intrinsics as you type.

Signature

View available signatures for your function as you type it.

Hover

View informations relative to a symbol by hovering it.

Goto

Go to your declaration definition by clicking on it.

Inlay hints

Add inlay hints to your function calls.

You can disable this in settings.json (default pressed is Ctrl+Alt)

"editor.inlayHints.enabled": "on"
"editor.inlayHints.enabled": "onUnlessPressed"
"editor.inlayHints.enabled": "off"
"editor.inlayHints.enabled": "offUnlessPressed"

Regions

Grey out inactive regions depending on currently declared preprocessor & filter symbols.

Variants

Swap shader variant on the fly to change regions behaviour & macro definition.

And much more

This extension also support some features such as document symbols, workspace symbols...

Extension Settings

This extension contributes the following settings:

• shader-validator.validate: Enable/disable validation with common API.
• shader-validator.symbols: Enable/disable symbol inspection & providers.
• shader-validator.symbolDiagnostics: Enable/disable symbol provider debug diagnostics.
• shader-validator.severity: Select minimal log severity for linting.
• shader-validator.includes: All custom includes for linting.
• shader-validator.pathRemapping: All virtual paths.
• shader-validator.defines: All custom macros and their values for linting.

HLSL specific settings:

• shader-validator.hlsl.shaderModel: Specify the shader model to target for HLSL
• shader-validator.hlsl.version: Specify the HLSL version
• shader-validator.hlsl.enable16bitTypes: Enable 16 bit types support with HLSL

GLSL specific settings:

• shader-validator.glsl.targetClient: Specify the OpenGL or Vulkan version for GLSL
• shader-validator.glsl.spirvVersion: Specify the SPIRV version to target for GLSL

Platform support

This extension is supported on every platform, but some limitations are to be expected on some:

• Windows: full feature set.
• Linux: full feature set.
• Mac: Rely on WASI version of server, same as web, see web support for limitations.

Web support

This extension run on the web on vscode.dev. It is relying on the WebAssembly Execution engine. Because of this restriction, we can't use dxc on the web as it does not compile to WASI and instead rely on glslang, which is more limited in linting (Only support some basic features of SM 6.0, while DXC support all newly added SM (current 6.8)).

Credits

This extension is based on a heavily modified version of PolyMeilex vscode-wgsl