|
1 | 1 | # Shader validator |
2 | 2 |
|
| 3 | +[](https://www.rust-lang.org/) |
3 | 4 | [](https://github.com/antaalt/shader-validator/issues) |
4 | 5 | [](https://github.com/antaalt/shader-sense/issues) |
5 | 6 | [](https://marketplace.visualstudio.com/items?itemName=antaalt.shader-validator) |
6 | 7 | [](https://open-vsx.org/extension/antaalt/shader-validator) |
7 | 8 |
|
8 | | -This is a vscode extension allowing syntax highlighting, linting & symbol providing for HLSL / GLSL / WGSL shaders. It is using [shader-language-server](https://github.com/antaalt/shader-sense/tree/main/shader-language-server) to lint shaders using common validator API & parse symbols for some code inspection. |
| 9 | +This is a vscode extension allowing syntax highlighting, linting & symbol providing for HLSL / GLSL / WGSL shaders. It is using [shader-language-server](https://github.com/antaalt/shader-sense/tree/main/shader-language-server), a shader language server written in Rust to lint shaders using common validator API & parse symbols for some code inspection. |
| 10 | + |
| 11 | +It is mostly intended to be used with big shader codebase used in production by providing interesting features such as region selection and a shader variant entry point selection for quickly switching between two entry point context with decent performances. This make it also quite reliable for small shader codebase. |
9 | 12 |
|
10 | 13 | Currently, it support some features and languages: |
11 | 14 |
|
12 | 15 | - **[Syntax Highlighting](#syntax-highlighting)**: Improved syntax highlighting for code. |
13 | 16 | - **[Diagnostic](#diagnostics)**: Highlight errors & warning as user type code. |
14 | | -- **[goto](#goto)**: Go to a symbol definition |
15 | | -- **[completion](#autocompletion)**: Suggest completion items |
16 | | -- **[hover](#hover)**: Add tooltip when hovering symbols |
17 | | -- **[signature](#signature)**: Help when selecting a signature |
18 | | -- **[inlay hints](#inlay-hints)**: Add hints to function calls |
| 17 | +- **[Goto](#goto)**: Go to a symbol definition. |
| 18 | +- **[Completion](#autocompletion)**: Suggest completion items. |
| 19 | +- **[Hover](#hover)**: Add tooltip when hovering symbols. |
| 20 | +- **[Signature](#signature)**: Provide signatures when completing a function. |
| 21 | +- **[Inlay hints](#inlay-hints)**: Add hints to function calls. |
19 | 22 | - **[Variant](#variants)**: Define multiple shader variant entry point & quickly switch between them. |
20 | 23 | - **[Regions](#regions)**: Detect inactive regions in code due to preprocessor and grey them out. |
21 | 24 |
|
@@ -73,13 +76,13 @@ Add inlay hints to your function calls. |
73 | 76 |
|
74 | 77 |  |
75 | 78 |
|
76 | | -You can disable this in settings.json (default pressed is Ctrl+Alt) |
77 | | -```json |
78 | | -"editor.inlayHints.enabled": "on" |
79 | | -"editor.inlayHints.enabled": "onUnlessPressed" |
80 | | -"editor.inlayHints.enabled": "off" |
81 | | -"editor.inlayHints.enabled": "offUnlessPressed" |
82 | | -``` |
| 79 | +> You can disable this in settings.json (default pressed is Ctrl+Alt) |
| 80 | +> ```json |
| 81 | +> "editor.inlayHints.enabled": "on" |
| 82 | +> "editor.inlayHints.enabled": "onUnlessPressed" |
| 83 | +> "editor.inlayHints.enabled": "off" |
| 84 | +> "editor.inlayHints.enabled": "offUnlessPressed" |
| 85 | +> ``` |
83 | 86 |
|
84 | 87 | ### Variants |
85 | 88 |
|
@@ -128,9 +131,9 @@ This extension contributes the following settings: |
128 | 131 | ## Platform support |
129 | 132 |
|
130 | 133 | This extension is supported on every platform, but some limitations are to be expected on some: |
131 | | -- Windows: full feature set. |
132 | | -- Linux: full feature set. |
133 | | -- Mac: Rely on WASI version of server, same as web, see web support for limitations. |
| 134 | +- Windows x86_64: full feature set. |
| 135 | +- Linux x86_64: full feature set. |
| 136 | +- Mac & ARM Linux / Windows: Rely on WASI version of server, same as web, see web support for limitations. |
134 | 137 |
|
135 | 138 | ## Web support |
136 | 139 |
|
|
0 commit comments