{"id":23803992,"url":"https://github.com/thejackimonster/vkcv-framework","last_synced_at":"2025-09-06T16:32:47.768Z","repository":{"id":43722006,"uuid":"508603603","full_name":"TheJackiMonster/vkcv-framework","owner":"TheJackiMonster","description":"Mirror from https://gitlab.uni-koblenz.de/vulkan2021/vkcv-framework.git","archived":false,"fork":false,"pushed_at":"2024-09-18T00:24:37.000Z","size":78707,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2024-09-19T01:53:41.246Z","etag":null,"topics":["framework","vulkan"],"latest_commit_sha":null,"homepage":"https://www.vkcv.de","language":"C++","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheJackiMonster.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-29T08:12:22.000Z","updated_at":"2024-09-18T00:24:41.000Z","dependencies_parsed_at":"2024-09-17T00:13:41.826Z","dependency_job_id":"dee21170-8ae9-45a6-8e03-b6ee2df61776","html_url":"https://github.com/TheJackiMonster/vkcv-framework","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheJackiMonster%2Fvkcv-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheJackiMonster%2Fvkcv-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheJackiMonster%2Fvkcv-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheJackiMonster%2Fvkcv-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheJackiMonster","download_url":"https://codeload.github.com/TheJackiMonster/vkcv-framework/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232133664,"owners_count":18477293,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework","vulkan"],"created_at":"2025-01-01T22:37:00.885Z","updated_at":"2025-01-01T22:37:03.652Z","avatar_url":"https://github.com/TheJackiMonster.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VkCV Framework\n A Vulkan framework for computer visualistics simplifying building applications\n\n[![linux-build-on-github](https://github.com/thejackimonster/vkcv-framework/workflows/Linux%20Build/badge.svg)](https://github.com/TheJackiMonster/vkcv-framework/actions/workflows/linux.yml)\n[![windows-build-on-github](https://github.com/thejackimonster/vkcv-framework/workflows/Windows%20Build/badge.svg)](https://github.com/TheJackiMonster/vkcv-framework/actions/workflows/windows.yml)\n[![macos-build-on-github](https://github.com/thejackimonster/vkcv-framework/workflows/macOS%20Build/badge.svg)](https://github.com/TheJackiMonster/vkcv-framework/actions/workflows/macos.yml)\n\n![Vulkan-Chan](https://gitlab.uni-koblenz.de/uploads/-/system/project/avatar/3712/VulkanChan.jpg)\n\n## Repository\n\nGit LFS is used for bigger resource files like meshes and textures. So you need to install Git LFS \nand use `git lfs install` after cloning.\n\nMore information about Git LFS [here](https://git-lfs.github.com/).\n\n## Build\n\nGit submodules are used for libraries. To download the submodules either clone using \n`git clone --recurse-submodules` or after `git clone` use `git submodule init` and \n`git submodule update`.\n\nDetailed build process:\n - [How to build on Windows](doc/BUILD_WINDOWS.md)\n - [How to build on macOS](doc/BUILD_MACOS.md)\n - [How to build on Linux](doc/BUILD_LINUX.md)\n\n### Dependencies (required):\n\nMost dependencies are used via submodules but for example Vulkan needs to be installed correctly \ndepending on your platform. So please setup your environment properly.\n\n| Name of dependency                                                                | Used as submodule |\n|-----------------------------------------------------------------------------------|---|\n| [Vulkan](https://www.vulkan.org/)                                                 | ❌ |\n| [Vulkan-Headers](https://github.com/KhronosGroup/Vulkan-Headers)                  | ✅ |\n| [Vulkan-Hpp](https://github.com/KhronosGroup/Vulkan-Hpp)                          | ✅ |\n| [GLFW](https://www.glfw.org/)                                                     | ✅ |\n| [SPIRV-CROSS](https://github.com/KhronosGroup/SPIRV-Cross)                        | ✅ |\n| [VulkanMemoryAllocator-Hpp](https://github.com/malte-v/VulkanMemoryAllocator-Hpp) | ✅ |\n\n### Modules (optional):\n\nThe following modules are provided in this repository and they build automatically together with \nthe framework if used. You can configure/adjust the build using CMake if necessary.\n\n - [Algorithm](modules/algorithm/README.md)\n - [Asset-Loader](modules/asset_loader/README.md)\n - [Camera](modules/asset_loader/README.md)\n - [Effects](modules/effects/README.md)\n - [Geometry](modules/geometry/README.md)\n - [GUI](modules/gui/README.md)\n - [Material](modules/material/README.md)\n - [Meshlet](modules/meshlet/README.md)\n - [Scene](modules/scene/README.md)\n - [Shader-Compiler](modules/shader_compiler/README.md)\n - [Tone-Mapping](modules/tone_mapping/README.md)\n - [Upscaling](modules/upscaling/README.md)\n\n### Projects (optional):\n\nThe following projects are provided in this repository and can be build with their own CMake \ntargets:\n\n - [bindless_textures](projects/bindless_textures/README.md)\n - [fire_works](projects/fire_works/README.md)\n - [first_mesh](projects/first_mesh/README.md)\n - [first_scene](projects/first_scene/README.md)\n - [first_triangle](projects/first_triangle/README.md)\n - [head_demo](projects/head_demo/README.md)\n - [indirect_dispatch](projects/indirect_dispatch/README.md)\n - [indirect_draw](projects/indirect_draw/README.md)\n - [mesh_shader](projects/mesh_shader/README.md)\n - [mpm](projects/mpm/README.md)\n - [particle_simulation](projects/particle_simulation/README.md)\n - [path_tracer](projects/path_tracer/README.md)\n - [ray_tracer](projects/ray_tracer/README.md)\n - [rt_ambient_occlusion](projects/rt_ambient_occlusion/README.md)\n - [sph](projects/sph/README.md)\n - [voxelization](projects/voxelization/README.md)\n\n## Development\n\nSee this guide to setup your IDE for most forward development.\n - [How to setup your IDE](doc/SETUP_IDE.md)\n\n## Documentation\n\nA pre-built documentation can be found here:  \nhttps://userpages.uni-koblenz.de/~vkcv/doc/\n\nBut it is recommended to build the documentation with Doxygen locally to get the most recent \nchanges. There is also an optional CMake target to build the documentation via Doxygen.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthejackimonster%2Fvkcv-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthejackimonster%2Fvkcv-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthejackimonster%2Fvkcv-framework/lists"}