https://github.com/adrien-ben/gltf-viewer-rs
glTF 2.0 file viewer written in Rust using Vulkan
https://github.com/adrien-ben/gltf-viewer-rs
gltf2 rust vulkan
Last synced: about 1 year ago
JSON representation
glTF 2.0 file viewer written in Rust using Vulkan
- Host: GitHub
- URL: https://github.com/adrien-ben/gltf-viewer-rs
- Owner: adrien-ben
- Created: 2019-03-02T09:48:07.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-07T12:10:08.000Z (over 1 year ago)
- Last Synced: 2025-04-02T11:01:40.982Z (about 1 year ago)
- Topics: gltf2, rust, vulkan
- Language: Rust
- Homepage:
- Size: 27.4 MB
- Stars: 80
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gltf-viewer-rs
This project is a [glTF 2.0][0] viewer written in Rust. Rendering is done using the [Vulkan API][1]
using [Ash][2]. It runs on Window, Linux and MacOS.
## Features
- [x] Mesh vertices, normals, colors and two uv channels
- [x] Tangents generation
- [x] Material
- [x] Base color factor and texture
- [x] Metallic/Roughness factors and textures
- [x] Emissive factor and texture
- [x] Ambient occlusion
- [x] Normal maps
- [x] Alpha
- [x] Opaque
- [x] Mask
- [x] Blend
- [x] Double sided surfaces
- [x] IBL
- [x] Animations
- [x] Node animation
- [x] Skinning
- [x] Interpolation
- [x] Step
- [x] Linear
- [x] Cubicspline
- [ ] Extensions
- [x] KHR_lights_punctual
- [x] KHR_materials_unlit
- [x] KHR_materials_pbrSpecularGlossiness
- [x] KHR_materials_emissive_strength
- [x] KHR_materials_clearcoat
- [x] KHR_texture_transform
- [x] KHR_materials_ior
- [ ] KHR_draco_mesh_compression
- [x] Camera controls
- [x] Orbital
- [x] First Person
- [x] Drag and drop
- [x] Background loading
- [ ] Post processing
- [x] Gamma correction
- [x] Tone mapping
- [x] Ambient occlusion
- [x] Bloom
- [ ] Depth of field
- [x] egui integration
- [x] Model description
- [x] Animation controller
- [x] Camera details
- [x] Renderer settings
- [x] HDR display
- [x] Allow enabling HDR (if supported by the device)
- [x] Add HDR specific tonemapping
## Requirements
- Vulkan 1.0
- VK_KHR_dynamic_rendering
> You can check your Vulkan feature set using Sascha Willems' [Vulkan Caps Viewer][6]
## Controls
- 'H' to toggle UI
Orbital camera:
- Left click and move to rotate camera around origin
- Right click and move to move camera
- Mouse wheel to un/zoom
FPS camera:
- WASD to move
- Left Ctrl to go down
- Space to go up
- Left click to rotate
## Build it
```sh
cargo build
```
By default, building the project will trigger shader compilation for all shaders in `./assets/shaders`.
You can either skip this step altogether by setting the environnement variable `SKIP_SHADER_COMPILATION`
to `true`, or you can change the default by setting `SHADERS_DIR`. Compiled shaders will be generated at
the same location as the shader source, with the same name suffixed by `.spv`.
> To compile the shaders you'll need to have `glslangValidator` on your PATH.
## Run it
Just type the following command and drag and drop and gltf/glb file in the window.
```sh
RUST_LOG=gltf_viewer_rs=warn cargo run
```
You can provide a yaml configuration file with `--config` (or `-c`). Check [this example file](./config.yml). And you can specify a file to load at startup
with `--file` (or `-f`)
```sh
RUST_LOG=gltf_viewer_rs=warn,vulkan=warn cargo run -- --config config.yml --file C:\\dev\\assets\\glTF-Sample-Models\\2.0\\Triangle\\glTF\\Triangle.gltf
```
### Validation layers
You can set up validation layers by running the following commands.
```sh
export VK_LAYER_PATH=$VULKAN_SDK/Bin
export VK_INSTANCE_LAYERS=VK_LAYER_KHRONOS_validation
# Then running the app with the --debug (-d) flag.
RUST_LOG=gltf_viewer_rs=warn cargo run -- --debug
```
> You can also use the run.sh and debug.sh scripts
## Known issues
On linux, enabling v-sync causes the system to freeze with some hardware configuration (tested on a laptop running Pop_os 19.04, with a GTX 1050Ti). It seems to be an issue related with PRIME sync.
## Credits
Most of the shader code for BRDF lookup and pre-filtered map generation come from the excellent [Sasha Willems' vulkan samples repository][3].
Cubemap faces have been generated using [matheowis' HDRi to cubemap tool][4].
HDRi textures have been downloaded from [hdriheaven][5].
SSAO tutorial from John Chapman's [blog][7].
Bloom tutorial on [Learn OpenGL][8]
[0]: https://github.com/KhronosGroup/glTF
[1]: https://www.khronos.org/vulkan/
[2]: https://github.com/MaikKlein/ash
[3]: https://github.com/SaschaWillems/Vulkan
[4]: https://github.com/matheowis/HDRI-to-CubeMap
[5]: https://hdrihaven.com/
[6]: https://vulkan.gpuinfo.org/download.php
[7]: http://john-chapman-graphics.blogspot.com/2013/01/ssao-tutorial.html
[8]: https://learnopengl.com/Guest-Articles/2022/Phys.-Based-Bloom
## Screenshots
||||
|---|---|---|
||||
||||
||||