Skip to content
This repository was archived by the owner on Apr 15, 2022. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,30 @@
# VulkanMemoryAllocator-Hpp
These bindings use all the handy stuff from `Vulkan-Hpp`: wrapper classes, type safe enums, `std::vector`s, `Optional` etc. They are generated by the generator used by `Vulkan-Hpp`, that's why they look so similar.

Current VMA version: 2.2.0
Current VMA version: 2.3.0

Warning: The bindings are not thoroughly tested yet. If you encounter any errors, please open an issue: https://github.com/malte-v/VulkanMemoryAllocator-Hpp/issues/new

Setup
--
## Setup
Just copy vk_mem_alloc.h and vk_mem_alloc.hpp to your project.

Usage
--
## Usage
```c++
// In *one* source file:
#define VMA_IMPLEMENTATION

// If you don't like the `vma::` prefix:
#define VMA_HPP_NAMESPACE <prefix>

#include "vk_mem_alloc.hpp"
```

## Configuration
### `namespace`
If you don't like the `vma::` prefix:
```c++
#define VMA_HPP_NAMESPACE <prefix>
```
### Designated Initializers
If you have access to c++20 compiler and want to take advantage of designated initializers:
```c++
#define VMA_HPP_NO_STRUCT_CONSTRUCTORS
```
See [Vulkan-HPP readme](https://github.com/KhronosGroup/Vulkan-Hpp#designated-initializers).
Loading