wgpu-renderer/README.md

# wpgu-renderer

A small [wgpu](https://github.com/gfx-rs/wgpu) renderer written in [Rust](https://github.com/rust-lang/rust).

![](demo.gif)

## Try it out
[rasanen.dev/wgpu-renderer](https://rasanen.dev/wgpu-renderer)  
Note: the .wasm is about 50 MB because it embeds Sponza.  
Note: shadowmaps are not enabled on WebGL.

Controls:
- WASD - Move horizontally
- Ctrl/Space - Move vertically
- Mouse - Look around
- Scrollwheel - Increase/Decrease movement speed
- ESC - Quit (Only on standalone version)

## Features

- PBS
- glTF models
- 1 realtime pointlight
- Shadow mapping*
- Soft shadows*
- Simple wgsl preprocessor for includes
- Runs on WASM and native desktop
  - Tested on:
    - `Ubuntu 22.04 (Mesa 23.1.0-devel)`
    - `Windows 10 Pro 21H2`
    - `Firefox 109.0`
    - `Chrome 109.0.5414.120`

*Native only

TODO:
- Transparency
- Restructuring
    - Simplify/abstract renderpasses; will be nice to have for PP and GI
    - `src/core/state.rs` is a mess; separate input handling, pipeline, passes
- SSAO
- Bloom
- AA
- Texture filtering
- Immediate mode UI (dear imgui, egui)
- Some type of GI (DDGI, VXGI)

## Running locally

Standalone:
```sh
cargo run --release
```

WASM requires:
- [wasm-pack](https://github.com/rustwasm/wasm-pack)
  - `cargo install wasm-pack`
- [miniserve](https://github.com/svenstaro/miniserve), or some other http server, such as `python3 -m http.server`.
  - For miniserve, see: `run-wasm.sh`

## References
- [wgpu examples](https://github.com/gfx-rs/wgpu/blob/master/wgpu/examples)
- [Learn Wgpu](https://sotrh.github.io/learn-wgpu/)
- [Learn OpenGL: PBR](https://learnopengl.com/PBR/Theory)

## Assets
- Sponza
  - Obtained from [KhronosGroup glTF-Sample-Models repository](https://github.com/KhronosGroup/glTF-Sample-Models/tree/16e2408d31e06d4b0bcf6123db472e802d71f081/2.0/Sponza), converted to .glb
- Cube
  - Obtained from [KhronosGroup glTF-Sample-Models repository](https://github.com/KhronosGroup/glTF-Sample-Models/tree/16e2408d31e06d4b0bcf6123db472e802d71f081/2.0/Cube), converted to .glb
update readme 2023-01-27 22:06:09 +02:00			`# wpgu-renderer`

			`A small [wgpu](https://github.com/gfx-rs/wgpu) renderer written in [Rust](https://github.com/rust-lang/rust).`

Add demo gif 2023-11-05 02:44:17 +02:00			`![](demo.gif)`

update readme 2023-01-28 12:58:38 +02:00			`## Try it out`
update readme 2023-01-28 14:16:39 +02:00			`[rasanen.dev/wgpu-renderer](https://rasanen.dev/wgpu-renderer)`
Disable shadowmapping on WebGL 2023-11-05 02:27:38 +02:00			`Note: the .wasm is about 50 MB because it embeds Sponza.`
			`Note: shadowmaps are not enabled on WebGL.`
update readme 2023-01-28 12:58:38 +02:00
update readme 2023-01-28 13:24:06 +02:00			`Controls:`
			`- WASD - Move horizontally`
			`- Ctrl/Space - Move vertically`
			`- Mouse - Look around`
			`- Scrollwheel - Increase/Decrease movement speed`
			`- ESC - Quit (Only on standalone version)`

update readme 2023-01-27 22:06:09 +02:00			`## Features`

fix light position offset 2023-04-15 19:52:58 +03:00			`- PBS`
update readme 2023-01-27 23:16:33 +02:00			`- glTF models`
working wasm build 2023-01-28 12:23:43 +02:00			`- 1 realtime pointlight`
Disable shadowmapping on WebGL 2023-11-05 02:27:38 +02:00			`- Shadow mapping*`
			`- Soft shadows*`
update readme 2023-01-27 22:06:09 +02:00			`- Simple wgsl preprocessor for includes`
update readme 2023-01-28 14:30:29 +02:00			`- Runs on WASM and native desktop`
update readme 2023-01-28 15:46:43 +02:00			`- Tested on:`
fix light position offset 2023-04-15 19:52:58 +03:00			- `Ubuntu 22.04 (Mesa 23.1.0-devel)`
update readme 2023-01-28 15:46:43 +02:00			- `Windows 10 Pro 21H2`
			- `Firefox 109.0`
			- `Chrome 109.0.5414.120`
update readme 2023-01-27 22:06:09 +02:00
Disable shadowmapping on WebGL 2023-11-05 02:27:38 +02:00			`*Native only`

update readme 2023-01-28 12:58:38 +02:00			`TODO:`
update todo 2023-04-16 14:57:38 +03:00			`- Transparency`
update readme 2023-01-27 23:16:33 +02:00			`- Restructuring`
			`- Simplify/abstract renderpasses; will be nice to have for PP and GI`
			- `src/core/state.rs` is a mess; separate input handling, pipeline, passes
			`- SSAO`
			`- Bloom`
working wasm build 2023-01-28 12:23:43 +02:00			`- AA`
			`- Texture filtering`
update readme 2023-01-27 23:16:33 +02:00			`- Immediate mode UI (dear imgui, egui)`
			`- Some type of GI (DDGI, VXGI)`

update readme 2023-01-28 13:24:06 +02:00			`## Running locally`

			`Standalone:`
			```sh
			`cargo run --release`
			```

Update readme for wasm 2023-04-13 16:56:06 +03:00			`WASM requires:`
			`- [wasm-pack](https://github.com/rustwasm/wasm-pack)`
			- `cargo install wasm-pack`
			- [miniserve](https://github.com/svenstaro/miniserve), or some other http server, such as `python3 -m http.server`.
			- For miniserve, see: `run-wasm.sh`
update readme 2023-01-28 13:24:06 +02:00
update readme 2023-01-27 22:06:09 +02:00			`## References`
working wasm build 2023-01-28 12:23:43 +02:00			`- [wgpu examples](https://github.com/gfx-rs/wgpu/blob/master/wgpu/examples)`
update readme 2023-01-28 12:58:38 +02:00			`- [Learn Wgpu](https://sotrh.github.io/learn-wgpu/)`
			`- [Learn OpenGL: PBR](https://learnopengl.com/PBR/Theory)`
update readme 2023-01-27 23:16:33 +02:00
			`## Assets`
			`- Sponza`
update readme 2023-01-28 12:58:38 +02:00			`- Obtained from [KhronosGroup glTF-Sample-Models repository](https://github.com/KhronosGroup/glTF-Sample-Models/tree/16e2408d31e06d4b0bcf6123db472e802d71f081/2.0/Sponza), converted to .glb`
Use cube for light debug mesh instead of entirety of Sponza... 2023-01-29 15:12:41 +02:00			`- Cube`
			`- Obtained from [KhronosGroup glTF-Sample-Models repository](https://github.com/KhronosGroup/glTF-Sample-Models/tree/16e2408d31e06d4b0bcf6123db472e802d71f081/2.0/Cube), converted to .glb`