VkCV Framework

A Vulkan framework for computer visualistics simplifying building applications

Repository

Git LFS is used for bigger resource files like meshes and textures. So you need to install Git LFS and use git lfs install after cloning.

More information about Git LFS here.

Build

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.

Detailed build process:

• How to build on Windows
• How to build on macOS
• How to build on Linux

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.

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.

• Algorithm
• Asset-Loader
• Camera
• GUI
• Effects
• Geometry
• Material
• Meshlet
• Scene
• Shader-Compiler
• Upscaling

Development

See this guide to setup your IDE for most forward development.

• How to setup your IDE

Documentation

A pre-built documentation can be found here:
https://userpages.uni-koblenz.de/~vkcv/doc/

But it is recommended to build the documentation with Doxygen locally to get the most recent changes. There is also an optional CMake target to build the documentation via Doxygen.