Skip to content

Commit 47950d2

Browse files
committed
Better description of the intent of the extension & small clean.
1 parent c8806f5 commit 47950d2

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11
# Shader validator
22

3+
[![Rust](https://img.shields.io/badge/Rust-%23000000.svg?e&logo=rust&logoColor=white)](https://www.rust-lang.org/)
34
[![extension issues](https://img.shields.io/github/issues/antaalt/shader-validator.svg?label=extension%20issues)](https://github.com/antaalt/shader-validator/issues)
45
[![server issues](https://img.shields.io/github/issues/antaalt/shader-sense.svg?label=server%20issues)](https://github.com/antaalt/shader-sense/issues)
56
[![vsmarketplace](https://img.shields.io/visual-studio-marketplace/v/antaalt.shader-validator?color=blue&label=vscode%20marketplace)](https://marketplace.visualstudio.com/items?itemName=antaalt.shader-validator)
67
[![openVSX registry](https://img.shields.io/open-vsx/v/antaalt/shader-validator?color=purple)](https://open-vsx.org/extension/antaalt/shader-validator)
78

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.
912

1013
Currently, it support some features and languages:
1114

1215
- **[Syntax Highlighting](#syntax-highlighting)**: Improved syntax highlighting for code.
1316
- **[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.
1922
- **[Variant](#variants)**: Define multiple shader variant entry point & quickly switch between them.
2023
- **[Regions](#regions)**: Detect inactive regions in code due to preprocessor and grey them out.
2124

@@ -73,13 +76,13 @@ Add inlay hints to your function calls.
7376

7477
![inlay-hints](res/doc/inlay-hints.png)
7578

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+
> ```
8386
8487
### Variants
8588
@@ -128,9 +131,9 @@ This extension contributes the following settings:
128131
## Platform support
129132
130133
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.
134137
135138
## Web support
136139

0 commit comments

Comments
 (0)