2020-02-24 14:56:51 +00:00
# Naga
2020-03-06 02:14:58 +00:00
[](https://matrix.to/#/#naga:matrix.org)
2020-02-27 04:28:18 +00:00
[](https://crates.io/crates/naga)
[](https://docs.rs/naga)
2020-06-25 04:34:02 +00:00
[](https://github.com/gfx-rs/naga/actions)
2020-02-24 14:56:51 +00:00
2020-06-25 04:34:02 +00:00
This is an experimental shader translation library for the needs of gfx-rs project and WebGPU.
2020-02-24 14:56:51 +00:00
## Supported end-points
2021-01-30 16:54:15 +00:00
Everything is still a work-in-progress, but some end-points are usable:
2020-02-24 14:56:51 +00:00
Front-end | Status | Notes |
--------------- | ------------------ | ----- |
2021-01-30 21:52:40 +00:00
SPIR-V (binary) | :white_check_mark: | |
WGSL | :white_check_mark: | |
GLSL (Vulkan) | :ok: | |
2020-02-24 14:56:51 +00:00
Rust | | |
Back-end | Status | Notes |
--------------- | ------------------ | ----- |
2021-01-30 21:52:40 +00:00
SPIR-V (binary) | :white_check_mark: | |
2020-02-28 18:05:24 +00:00
WGSL | | |
2021-01-30 21:52:40 +00:00
Metal | :white_check_mark: | |
2021-03-01 14:30:32 +00:00
HLSL | :construction: | |
2021-01-30 21:52:40 +00:00
GLSL | :ok: | |
2020-02-24 14:56:51 +00:00
AIR | | |
2021-01-30 16:54:15 +00:00
DXIL/DXIR | | |
2020-02-27 04:28:18 +00:00
DXBC | | |
2020-09-23 04:48:31 +00:00
2021-01-30 21:52:40 +00:00
:white_check_mark: = Primary support — :ok: = Secondary support — :construction: = Unsupported, but support in progress
2021-02-05 17:22:24 +00:00
2021-02-24 15:49:27 +00:00
## Conversion tool
Naga includes a default binary target "convert", which allows to test the conversion of different code paths.
```bash
cargo run --features spv-in -- my_shader.spv # dump the IR module to debug output
cargo run --features spv-in,msl-out -- 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 --features wgsl-in,glsl-out -- my_shader.wgsl my_shader.vert --profile es310 # convert the WGSL to GLSL vertex stage under ES 3.20 profile
```
2021-02-05 17:22:24 +00:00
## Development workflow
The main instrument aiding the development is the good old `cargo test --all-features` ,
which will run the snapshot tests as well as the unit tests.
Any changes in the snapshots would then have to be reviewed with `cargo insta review`
before being accepted into 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
```
