Skip to content
Snippets Groups Projects
Verified Commit 72798ab7 authored by Tobias Frisch's avatar Tobias Frisch
Browse files

[#97] Added README files for newer modules and added links to docs per module

parent 55d3ba3c
No related branches found
No related tags found
1 merge request!81Resolve "Listung von Dependencies"
Pipeline #27301 passed
...@@ -35,8 +35,10 @@ The following modules will be provided in this repository and they will automati ...@@ -35,8 +35,10 @@ The following modules will be provided in this repository and they will automati
- [Camera](modules/asset_loader/README.md) - [Camera](modules/asset_loader/README.md)
- [GUI](modules/gui/README.md) - [GUI](modules/gui/README.md)
- [Material](modules/material/README.md) - [Material](modules/material/README.md)
- [Meshlet](modules/meshlet/README.md)
- [Scene](modules/scene/README.md) - [Scene](modules/scene/README.md)
- [Shader-Compiler](modules/shader_compiler/README.md) - [Shader-Compiler](modules/shader_compiler/README.md)
- [Upscaling](modules/upscaling/README.md)
## Documentation ## Documentation
......
...@@ -11,3 +11,7 @@ A VkCV module to load basic assets like models, materials and images ...@@ -11,3 +11,7 @@ A VkCV module to load basic assets like models, materials and images
| [fx-gltf](https://github.com/jessey-git/fx-gltf) | ✅ | | [fx-gltf](https://github.com/jessey-git/fx-gltf) | ✅ |
| [nlohmann::json](https://github.com/nlohmann/json) | ✅ | | [nlohmann::json](https://github.com/nlohmann/json) | ✅ |
| [stb](https://github.com/nothings/stb) | ✅ | | [stb](https://github.com/nothings/stb) | ✅ |
## Docs
Here is a [link](https://vkcv.de/branch/96-dokumentation-vervollstandigen/group__vkcv__asset.html) to this module.
...@@ -9,3 +9,7 @@ A VkCV module to manage cameras and their handle view and projection matrices ...@@ -9,3 +9,7 @@ A VkCV module to manage cameras and their handle view and projection matrices
| Name of dependency | Used as submodule | | Name of dependency | Used as submodule |
|----------------------------------------------------|---| |----------------------------------------------------|---|
| [GLM](https://github.com/g-truc/glm) | ✅ | | [GLM](https://github.com/g-truc/glm) | ✅ |
## Docs
Here is a [link](https://vkcv.de/branch/96-dokumentation-vervollstandigen/group__vkcv__camera.html) to this module.
...@@ -9,3 +9,8 @@ A VkCV module to integrate GUI rendering to your application as additional pass ...@@ -9,3 +9,8 @@ A VkCV module to integrate GUI rendering to your application as additional pass
| Name of dependency | Used as submodule | | Name of dependency | Used as submodule |
|----------------------------------------------------|---| |----------------------------------------------------|---|
| [ImGUI](https://github.com/ocornut/imgui/) | ✅ | | [ImGUI](https://github.com/ocornut/imgui/) | ✅ |
## Docs
Here is a [link](https://vkcv.de/branch/96-dokumentation-vervollstandigen/group__vkcv__gui.html) to this module.
# GUI # Material
A VkCV module to abstract typical kinds of materials for rendering A VkCV module to abstract typical kinds of materials for rendering
## Docs
Here is a [link](https://vkcv.de/branch/96-dokumentation-vervollstandigen/group__vkcv__asset.html) to this module.
# Meshlet
A VkCV module to divide vertex data of a mesh into meshlets
## Docs
Here is a [link](https://vkcv.de/branch/96-dokumentation-vervollstandigen/group__vkcv__meshlet.html) to this module.
# Scene # Scene
A VkCV module to load and manage a scene, simplify its rendering and potentially optimize it A VkCV module to load and manage a scene, simplify its rendering and potentially optimize it
## Docs
Here is a [link](https://vkcv.de/branch/96-dokumentation-vervollstandigen/group__vkcv__scene.html) to this module.
...@@ -9,3 +9,7 @@ A VkCV module to compile shaders at runtime ...@@ -9,3 +9,7 @@ A VkCV module to compile shaders at runtime
| Name of dependency | Used as submodule | | Name of dependency | Used as submodule |
|----------------------------------------------------|---| |----------------------------------------------------|---|
| [Glslang](https://github.com/KhronosGroup/glslang/) | ✅ | | [Glslang](https://github.com/KhronosGroup/glslang/) | ✅ |
## Docs
Here is a [link](https://vkcv.de/branch/96-dokumentation-vervollstandigen/group__vkcv__shader.html) to this module.
# Upscaling
A VkCV module to upscale images in realtime
## Build
### Dependencies (required):
| Name of dependency | Used as submodule |
|----------------------------------------------------|---|
| [FidelityFX-FSR](https://github.com/GPUOpen-Effects/FidelityFX-FSR/) | ✅ |
## Docs
Here is a [link](https://vkcv.de/branch/96-dokumentation-vervollstandigen/group__vkcv__upscaling.html) to this module.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment