vklite

Lightweight C++ wrapper for Vulkan

Usage

#include <volk.h> // or other vulkan API header
#include <vklite/vulkan.hpp>
#include <vklite/vk_mem_alloc.hpp>

namespace vk = vklite;
namespace vma = vk::vma;

Features

• Type safety for enums and bitfields.
• Compile-time viability checking for struct extensions (i.e. those chained with pNext).
• No need to specify sType yourself.
• Informative comments from vk.xml registry.
• Code arranged in a way such that you can lookup the related info for an entity (e.g. enum/struct/function) quickly.
• Default parameters.

Why not Vulkan-Hpp

It's too heavyweight and almost unusable without using the C++ module version.

Naming Conventions

Types

VkName -> vk::Name

Functions

• vkName -> vk::name
• vkName(handle, ...) -> handle.name(...)

Enums

VK_ENUM_NAME -> vk::Enum::eName

FlagBits

VK_ENUM_NAME_BIT -> vk::EnumFlagBits::bName

In all cases the extension suffix is preserved.

Struct

Constructors

• sType is automatically set for extensible structs.
• Default constructor is value-initialized.
• Parametric constructor is available if all members are required.

Members

• prop -> setProp/getProp
• pProp -> setProp/getProp

setProp is available if the struct is not returnedonly.

Extensions

If a struct is extensible, attach member functions for each extension are available. If the attachment must be the first one, it's named attachHead instead.

Example

vk::PipelineShaderStageCreateInfo shaderStageInfo;
vk::ShaderModuleCreateInfo moduleInfo;
vk::DebugUtilsObjectNameInfoEXT objectNameInfo;
shaderStageInfo.attachHead(moduleInfo);
shaderStageInfo.attach(objectNameInfo);

Calling Conventions

• void function(..., T* out) -> T function(...)
• VkResult function(..., T* out) -> vk::Ret<T> function(...)

Exceptions

std::system_error with vk::errorCategory() is used for exceptions.

• check(vk::Result) throws if Result is not eSuccess.
• vk::Ret<T>::get() throws if Ret<T>::result is not eSuccess.