diff --git a/README.md b/README.md index 29c45f2660cb29d8ded6cdac14d1bf2db6b2ffc3..8510d57642033b114904c9d68e4bec9bd58ba89b 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,30 @@ More information about Git LFS [here](https://git-lfs.github.com/). Git submodules are used for libraries. To download the submodules either clone using `git clone --recurse-submodules` or after `git clone` use `git submodule init` and `git submodule update`. +### Dependencies (required): + +Most dependencies will be used via submodules but for example Vulkan needs to be installed correctly depending on your platform. So please setup your environment properly. + +| Name of dependency | Used as submodule | +|-----------------------------------|---| +| [Vulkan](https://www.vulkan.org/) | ⌠| +| [GLFW](https://www.glfw.org/) | ✅ | +| [SPIRV-CROSS](https://github.com/KhronosGroup/SPIRV-Cross) | ✅ | +| [VulkanMemoryAllocator-Hpp](https://github.com/malte-v/VulkanMemoryAllocator-Hpp) | ✅ | + +### Modules (optional): + +The following modules will be provided in this repository and they will automatically be builded together with the framework if used. You can configure/adjust the build using CMake if necessary. + + - [Asset-Loader](modules/asset_loader/README.md) + - [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 The documentation for the develop-branch can be found here: diff --git a/modules/asset_loader/README.md b/modules/asset_loader/README.md new file mode 100644 index 0000000000000000000000000000000000000000..61caa08aa0d9863ce1ad14e7ecde6fd7cb6eed4a --- /dev/null +++ b/modules/asset_loader/README.md @@ -0,0 +1,17 @@ +# Asset-Loader + +A VkCV module to load basic assets like models, materials and images + +## Build + +### Dependencies (required): + +| Name of dependency | Used as submodule | +|----------------------------------------------------|---| +| [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/develop/group__vkcv__asset.html) to this module. diff --git a/modules/camera/README.md b/modules/camera/README.md new file mode 100644 index 0000000000000000000000000000000000000000..cd9e3e01213821108eb38f1656285fb583795034 --- /dev/null +++ b/modules/camera/README.md @@ -0,0 +1,15 @@ +# Camera + +A VkCV module to manage cameras and their handle view and projection matrices + +## Build + +### Dependencies (required): + +| Name of dependency | Used as submodule | +|----------------------------------------------------|---| +| [GLM](https://github.com/g-truc/glm) | ✅ | + +## Docs + +Here is a [link](https://vkcv.de/develop/group__vkcv__camera.html) to this module. diff --git a/modules/gui/README.md b/modules/gui/README.md new file mode 100644 index 0000000000000000000000000000000000000000..079264056e0fa16a4db752d8fe96fe0e42426258 --- /dev/null +++ b/modules/gui/README.md @@ -0,0 +1,16 @@ +# GUI + +A VkCV module to integrate GUI rendering to your application as additional pass + +## Build + +### Dependencies (required): + +| Name of dependency | Used as submodule | +|----------------------------------------------------|---| +| [ImGUI](https://github.com/ocornut/imgui/) | ✅ | + +## Docs + +Here is a [link](https://vkcv.de/develop/group__vkcv__gui.html) to this module. + diff --git a/modules/material/README.md b/modules/material/README.md new file mode 100644 index 0000000000000000000000000000000000000000..c56a5cc19ae147106bda818775bcb828a69ba845 --- /dev/null +++ b/modules/material/README.md @@ -0,0 +1,7 @@ +# Material + +A VkCV module to abstract typical kinds of materials for rendering + +## Docs + +Here is a [link](https://vkcv.de/develop/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..2fe1a7342c6a21d9694e49fc1e8b6decf43a9786 --- /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/develop/group__vkcv__meshlet.html) to this module. diff --git a/modules/scene/README.md b/modules/scene/README.md new file mode 100644 index 0000000000000000000000000000000000000000..4b7596159ce741e584b9395bdde4c8577de3e5d8 --- /dev/null +++ b/modules/scene/README.md @@ -0,0 +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/develop/group__vkcv__scene.html) to this module. diff --git a/modules/shader_compiler/README.md b/modules/shader_compiler/README.md new file mode 100644 index 0000000000000000000000000000000000000000..03b195e65dbed45c3b91a1fc766b9e12d619c971 --- /dev/null +++ b/modules/shader_compiler/README.md @@ -0,0 +1,15 @@ +# Shader-Compiler + +A VkCV module to compile shaders at runtime + +## Build + +### Dependencies (required): + +| Name of dependency | Used as submodule | +|----------------------------------------------------|---| +| [Glslang](https://github.com/KhronosGroup/glslang/) | ✅ | + +## Docs + +Here is a [link](https://vkcv.de/develop/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..fc64bf84726fd2bda45efd988b588704a965e0f0 --- /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/develop/group__vkcv__upscaling.html) to this module.