Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arctic-marmoset/vulkan-sandbox
A project for messing around with Vulkan
https://github.com/arctic-marmoset/vulkan-sandbox
Last synced: about 1 month ago
JSON representation
A project for messing around with Vulkan
- Host: GitHub
- URL: https://github.com/arctic-marmoset/vulkan-sandbox
- Owner: arctic-marmoset
- Created: 2021-03-07T02:36:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-26T22:06:11.000Z (almost 2 years ago)
- Last Synced: 2024-04-23T08:46:00.586Z (10 months ago)
- Language: C++
- Size: 45.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vulkan Sandbox
This is where I will experiment with the Vulkan graphics API. The plan is to
start by following [Vulkan Tutorial](https://vulkan-tutorial.com/) to build up a
foundation. Then, after completing the tutorial, I will modify the code with the
aim to produce a basic 3D renderer. The scope of the 3D renderer will be decided
at a later point.
# Development Branches
The main branch may not contain the latest changes, as risky changes are kept in
separate development branches prior to merging. These branches are named
`wip/{feature}`.
# External Dependencies
This project uses vcpkg to pull in most dependencies. However, the following must
still be installed manually:
| Dependency | Version Used in Project |
|----------------------------------------------------|-------------------------|
| A C++ compiler with C++23 support | `15.0.5 (clang)` |
| [vcpkg](https://github.com/microsoft/vcpkg) itself | - |
| [CMake](https://cmake.org/download/) | `3.24.0` |
| [Vulkan SDK](https://vulkan.lunarg.com/) | `1.3.236` |
# Project Setup
This project has only been tested on Linux and Windows 10. Other platforms may or
may not also work.
## Clone the Repository
```
git clone --recurse-submodules {repo}
```
## Configure CMake
There are currently two compilers (MSVC, Clang) and two build configurations (Debug, Release) with presets.
The presets are named `{Compiler}-{Configuration}`, with each component spelled exactly as above.
```
cd {projectRoot}
cmake --preset {preset}
```
## Build
```
cmake --build Build/{preset}
```
## Run
```
{projectRoot}/Build/{preset}/Renderer --resources-path="{ABSOLUTE_PATH_TO_RESOURCES_DIR}"
```
The "--resources-path" flag is necessary during development since the
Resources directory and the executable will not be in the same directory. Note
that the quotes are required.
If using CLion, you can take advantage of the `$ProjectFileDir$` macro in
Run/Debug Configurations → Program arguments.
# Progress Preview
Multiple meshes and textures, skybox cube map:
Reversed depth buffering:
