VkWrapper

Open-source vulkan graphics plugin written in C++. It is designed to provide a simple and easy-to-use interface for Vulkan API.

Description

Engine² is a game engine that aims to provide a developer friendly and open-source alternative for 3D game development. It is designed to provide accurate physics simulation and visually appealing graphics in a single package.

VkWrapper is a Vulkan graphics plugin that is designed to provide a simple and easy-to-use interface for Vulkan API. It is designed to be used with Engine², but it can be used as a standalone library.

Getting started

Requirements

• Xmake
• Vulkan SDK

Compile the library

1. Run xmake build
2. Install required dependencies if needed (or use xmake build -y to install them automatically)

Set up a development environment

1. Open the repository using Visual Studio
2. Execute xmake project -k vsxmake -m "debug,release" inside the root using a VS "Developer PowerShell"
3. Open the created VS Solution using Visual Studio (/vsxmake2022/EngineSquared.sln)
4. (Optional) Install Xmake VS extension
5. Build the solution

Run unit tests

1. Run xmake test
2. Install required dependencies if needed (or use xmake test -y to install them automatically)
3. Tests will be executed individually

Coding style

1. Download clang-format from here or from github
2. Add the clang-format executable to your PATH

Apply the coding style

For bash users, you can use the following command to apply the coding style to the project:

find . -iname '*.hpp' -o -iname '*.cpp' -o -iname '*.inl' | xargs clang-format -i

For Windows users, you can use the following command to apply the coding style to the project:

Get-ChildItem -Recurse -Include *.cpp, *.hpp, *.inl | ForEach-Object { clang-format -i $_.FullName }

For Visual Studio users, you can use the ClangFormat extension to format the code.

Build the documentation

1. Download Doxygen from the official website
2. Create a docs folder if it doesn't already exist and run doxygen Doxyfile.cfg to generate the documentation using Doxygen
3. Open the generated documentation using a web browser (/docs/VkWrapper/html/index.html)