diff --git a/README.md b/README.md index 4cd92163faac9778230bdfbb36bde6914b577cd3..8510d57642033b114904c9d68e4bec9bd58ba89b 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,10 @@ The following modules will be provided in this repository and they will automati - [Camera](modules/asset_loader/README.md) - [GUI](modules/gui/README.md) - [Material](modules/material/README.md) + - [Meshlet](modules/meshlet/README.md) - [Scene](modules/scene/README.md) - [Shader-Compiler](modules/shader_compiler/README.md) + - [Upscaling](modules/upscaling/README.md) ## Documentation diff --git a/modules/asset_loader/README.md b/modules/asset_loader/README.md index dd50c65339989f4f45fc705aae8aac7e54cd7183..599dace95e1ad4afe8ee2dacace0ecbbf1b48e87 100644 --- a/modules/asset_loader/README.md +++ b/modules/asset_loader/README.md @@ -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) | ✅ | | [nlohmann::json](https://github.com/nlohmann/json) | ✅ | | [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. diff --git a/modules/camera/README.md b/modules/camera/README.md index c17ca5ed6e28cb1a7964b9be9d7a82fd83f91c1c..84e8dda7b443e4e5f878c32bcef347a077a789da 100644 --- a/modules/camera/README.md +++ b/modules/camera/README.md @@ -9,3 +9,7 @@ A VkCV module to manage cameras and their handle view and projection matrices | Name of dependency | Used as submodule | |----------------------------------------------------|---| | [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. diff --git a/modules/gui/README.md b/modules/gui/README.md index 7e8a3309f4ec41805fe3aebc68c31e3d188f9576..a63454e2cb9a2ee3605fbe02d7dfa2635af46cfe 100644 --- a/modules/gui/README.md +++ b/modules/gui/README.md @@ -9,3 +9,8 @@ A VkCV module to integrate GUI rendering to your application as additional pass | Name of dependency | Used as submodule | |----------------------------------------------------|---| | [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. + diff --git a/modules/material/README.md b/modules/material/README.md index f00f8fc770f837fad283c1a6349187cac1ffb850..3f5ce591b6419db27b464c6e548ce642bf080960 100644 --- a/modules/material/README.md +++ b/modules/material/README.md @@ -1,3 +1,7 @@ -# GUI +# Material 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. diff --git a/modules/meshlet/README.md b/modules/meshlet/README.md new file mode 100644 index 0000000000000000000000000000000000000000..54af3388a35352839a00e55893af4fe22e99223d --- /dev/null +++ b/modules/meshlet/README.md @@ -0,0 +1,7 @@ +# 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. diff --git a/modules/scene/README.md b/modules/scene/README.md index 12fb018e25a15f637ba8c4bf57311640823ac616..da8a1a3b3bcb245526496cc61ecbbb50a3d753aa 100644 --- a/modules/scene/README.md +++ b/modules/scene/README.md @@ -1,3 +1,7 @@ # Scene 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. diff --git a/modules/shader_compiler/README.md b/modules/shader_compiler/README.md index 86673e5535ad99efe466473e51f5c36cede38383..f9a3eedbec41deb5959f1ba8b452c4dd578cb62f 100644 --- a/modules/shader_compiler/README.md +++ b/modules/shader_compiler/README.md @@ -9,3 +9,7 @@ A VkCV module to compile shaders at runtime | Name of dependency | Used as submodule | |----------------------------------------------------|---| | [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. diff --git a/modules/upscaling/README.md b/modules/upscaling/README.md new file mode 100644 index 0000000000000000000000000000000000000000..09b474f8e5607882619ba1f6c52741b24a664c41 --- /dev/null +++ b/modules/upscaling/README.md @@ -0,0 +1,15 @@ +# 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.