ed94 / vaultedvulkan

Vulkan redesigned with modern C++.

VaultedVulkan

A vulkan wrapper.

Documentation can be found here: Docs Site (Documentation is updated usually with implementation or if not during refactoring periods)

Benefits:

• Features a 1:1 wrap implementation of the Vulkan C-API. (See Vault_01 implementation) [Note: Work in progress, the entire API has not be wrapped as of yet.
• Vulkan API Structures auto set thier VkStructureType and have other default member initalization + operators for equality comparison.
• Typesafe bitmasks inspired by Jonathan's typesafe library.
• Ease of use functionality for bootstrapping (See Vaults_02/3/4), but without the extra non-gpu API related clutter (Asset Loading, Camera, Entity, etc)
• Leveled abstraction namespacing and optional implementation wrapped in macros to allow easy discretion of features desired.
• Full doxygen documentation presented nicely in a nice web format thanks to ModernC++Starter.
• Single header version available.
• Handwritten.

State

WIP. See milestones / projects tab.

Currently the library can be used to bootstrap a vulkan backend, however a good amount of the C-API has not been wrapped.

My current intentions is to get this going as far as I like in conjunction with following various vulkan guides, and making my engine mvp. After that is done, this will be publicly released with some sort of open source license.

Guides

Head on over to to get started.

vaultedvulkan's Issues

Complete Uniform Buffers Tut

Deleted issue.

https://vulkan-tutorial.com/Introduction

Figure out how to get breathe + sphinx working.

Design: Order definitions properly (End of Tutorial)

Complete Depth Buffering Tut

Complete Texture mapping tut.

Fill in missing documentation: Vault 2

Complete multisampling tut.

Review design.

Fill in missing documentation: Vault 4

End of Tutorial Refactor

Due to rushing the tutorial, much of the implementation may not even have specification links. Simply add them.

Do a proper sample guide based on the test run.

Figure out standardese deployment on cmake and if it can interact with sphix / a site theme setup.

VK Allocator: Find out how to intergrate the library as optional to the main library (as a separate branch?)

Vault 4: FInish VTGPU_Renderer

Do a test run with Carlos or Haczar (or anyone else) of the Hello Triangle tutorial based on Alain Galvan's Raw Vulkan tutorial.

Vault 4: Finish VTGPU_Comms

API Spec 5: Command Buffers Fully wrapped.

Look at Abstract Realm's implementation / Imgui's backend and make a new backend for it to adhere properly to this library.

API Spec 4: Devices and Queues Fully wrapped.

Fill in missing documentation: Vault 1

Needs license

Convert documentation generation to standardese

Docs: Add proper brief descriptor to all definitions missing it.

Flesh out contributor guidelines

Keep it to Vaults 1-3 for now.

API Spec 6: Synchronization and Cache Control Fully wrapped

Complete Generating mipmaps tut

Complete Loading Models Tut