mirror of
https://github.com/gfx-rs/wgpu.git
synced 2024-11-27 09:14:01 +00:00
69 lines
3.5 KiB
Markdown
69 lines
3.5 KiB
Markdown
# Naga
|
|
|
|
[](https://matrix.to/#/#naga:matrix.org)
|
|
[](https://crates.io/crates/naga)
|
|
[](https://docs.rs/naga)
|
|
[](https://github.com/gfx-rs/naga/actions)
|
|
|
|
[](https://codecov.io/gh/gfx-rs/naga)
|
|
|
|
The shader translation library for the needs of [wgpu](https://github.com/gfx-rs/wgpu) and [gfx-rs](https://github.com/gfx-rs/gfx) projects.
|
|
|
|
## Supported end-points
|
|
|
|
Everything is still work-in-progress, but some end-points are usable:
|
|
|
|
Front-end | Status | Feature | Notes |
|
|
--------------- | ------------------ | ------- | ----- |
|
|
SPIR-V (binary) | :white_check_mark: | spv-in | |
|
|
WGSL | :white_check_mark: | wgsl-in | Fully validated |
|
|
GLSL | :ok: | glsl-in | |
|
|
|
|
Back-end | Status | Feature | Notes |
|
|
--------------- | ------------------ | -------- | ----- |
|
|
SPIR-V | :white_check_mark: | spv-out | |
|
|
WGSL | :ok: | wgsl-out | |
|
|
Metal | :white_check_mark: | msl-out | |
|
|
HLSL | :ok: | hlsl-out | Shader Model 5.0+ (DirectX 11+) |
|
|
GLSL | :ok: | glsl-out | |
|
|
AIR | | | |
|
|
DXIL/DXIR | | | |
|
|
DXBC | | | |
|
|
DOT (GraphViz) | :ok: | dot-out | Not a shading language |
|
|
|
|
:white_check_mark: = Primary support — :ok: = Secondary support — :construction: = Unsupported, but support in progress
|
|
|
|
## Conversion tool
|
|
|
|
Naga includes a default binary target, which allows to test the conversion of different code paths.
|
|
```bash
|
|
cargo run my_shader.wgsl # validate only
|
|
cargo run my_shader.spv my_shader.txt # dump the IR module into a file
|
|
cargo run my_shader.spv my_shader.metal --flow-dir flow-dir # convert the SPV to Metal, also dump the SPIR-V flow graph to `flow-dir`
|
|
cargo run my_shader.wgsl my_shader.vert --profile es310 # convert the WGSL to GLSL vertex stage under ES 3.20 profile
|
|
```
|
|
|
|
## Development workflow
|
|
|
|
The main instrument aiding the development is the good old `cargo test --all-features --workspace`,
|
|
which will run the unit tests, and also update all the snapshots. You'll see these
|
|
changes in git before committing the code.
|
|
|
|
If working on a particular front-end or back-end, it may be convenient to
|
|
enable the relevant features in `Cargo.toml`, e.g.
|
|
```toml
|
|
default = ["spv-out"] #TEMP!
|
|
```
|
|
This allows IDE basic checks to report errors there, unless your IDE is sufficiently configurable already.
|
|
|
|
Finally, when changes to the snapshots are made, we should verify that the produced shaders
|
|
are indeed valid for the target platforms they are compiled for. We automate this with `Makefile`:
|
|
```bash
|
|
make validate-spv # for Vulkan shaders, requires SPIRV-Tools installed
|
|
make validate-msl # for Metal shaders, requires XCode command-line tools installed
|
|
make validate-glsl # for OpenGL shaders, requires GLSLang installed
|
|
make validate-dot # for dot files, requires GraphViz installed
|
|
make validate-wgsl # for WGSL shaders
|
|
make validate-hlsl # for HLSL shaders. Note: this Make target makes use of the "sh" shell. This is not the default shell in Windows.
|
|
```
|