From 72798ab738c3e45380073bb338bab7d14853077f Mon Sep 17 00:00:00 2001 From: Tobias Frisch <tfrisch@uni-koblenz.de> Date: Fri, 17 Sep 2021 14:50:32 +0200 Subject: [PATCH] [#97] Added README files for newer modules and added links to docs per module Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de> --- README.md | 2 ++ modules/asset_loader/README.md | 4 ++++ modules/camera/README.md | 4 ++++ modules/gui/README.md | 5 +++++ modules/material/README.md | 6 +++++- modules/meshlet/README.md | 7 +++++++ modules/scene/README.md | 4 ++++ modules/shader_compiler/README.md | 4 ++++ modules/upscaling/README.md | 15 +++++++++++++++ 9 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 modules/meshlet/README.md create mode 100644 modules/upscaling/README.md diff --git a/README.md b/README.md index 4cd92163..8510d576 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 dd50c653..599dace9 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 c17ca5ed..84e8dda7 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 7e8a3309..a63454e2 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 f00f8fc7..3f5ce591 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 00000000..54af3388 --- /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 12fb018e..da8a1a3b 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 86673e55..f9a3eedb 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 00000000..09b474f8 --- /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. -- GitLab