nullprop/wgpu-renderer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Lauri Räsänen 2023-01-28 13:24:06 +02:00
parent 998b7747e9
commit 85e708b317
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -5,6 +5,13 @@ A small [wgpu](https://github.com/gfx-rs/wgpu) renderer written in [Rust](https:
## Try it out ## Try it out
[rasanen.dev/wgpu-renderer](https://rasanen.dev/wgpu-renderer) [rasanen.dev/wgpu-renderer](https://rasanen.dev/wgpu-renderer)
Controls:
- WASD - Move horizontally
- Ctrl/Space - Move vertically
- Mouse - Look around
- Scrollwheel - Increase/Decrease movement speed
- ESC - Quit (Only on standalone version)
## Features ## Features
- Physically based shading - Physically based shading
@ -28,6 +35,19 @@ TODO:
- Immediate mode UI (dear imgui, egui) - Immediate mode UI (dear imgui, egui)
- Some type of GI (DDGI, VXGI) - Some type of GI (DDGI, VXGI)
## Running locally
Standalone:
```sh
cargo run --release
```
WASM requires [miniserve](https://github.com/svenstaro/miniserve), or some other http server, such as `python3 -m http.server`.
For miniserve, see:
```sh
./run-wasm.sh
```
## References ## References
- [wgpu examples](https://github.com/gfx-rs/wgpu/blob/master/wgpu/examples) - [wgpu examples](https://github.com/gfx-rs/wgpu/blob/master/wgpu/examples)
- [Learn Wgpu](https://sotrh.github.io/learn-wgpu/) - [Learn Wgpu](https://sotrh.github.io/learn-wgpu/)