Skip to content

Commit a1bd730

Browse files
Minor updates in README.
1 parent ff1cf54 commit a1bd730

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,23 @@ Memory allocation and resource (buffer and image) creation in Vulkan is difficul
2626

2727
# Features
2828

29-
This library can help game developers to manage memory allocations and resource creation by offering some higher-level functions. Features of the library are divided into several layers, low level to high level:
29+
This library can help game developers to manage memory allocations and resource creation by offering some higher-level functions:
3030

3131
1. Functions that help to choose correct and optimal memory type based on intended usage of the memory.
3232
- Required or preferred traits of the memory are expressed using higher-level description comparing to Vulkan flags.
3333
2. Functions that allocate memory blocks, reserve and return parts of them (`VkDeviceMemory` + offset + size) to the user.
34-
- Library keeps track of allocated memory blocks, used and unused ranges inside them, finds best matching unused ranges for new allocations, takes all the rules of alignment and buffer/image granularity into consideration.
34+
- Library keeps track of allocated memory blocks, used and unused ranges inside them, finds best matching unused ranges for new allocations, respects all the rules of alignment and buffer/image granularity.
3535
3. Functions that can create an image/buffer, allocate memory for it and bind them together - all in one call.
3636

3737
Additional features:
3838

39+
- Well-documented - description of all functions and structures provided, along with chapters that contain general description and example code.
3940
- Thread-safety: Library is designed to be used by multithreaded code.
40-
- Configuration: Fill optional members of CreateInfo structure to provide custom CPU memory allocator and other parameters.
41+
- Configuration: Fill optional members of CreateInfo structure to provide custom CPU memory allocator, pointers to Vulkan functions and other parameters.
4142
- Customization: Predefine appropriate macros to provide your own implementation of all external facilities used by the library, from assert, mutex, and atomic, to vector and linked list.
42-
- Support memory mapping, reference-counted internally. Support for persistently mapped memory: Just allocate with appropriate flag and you get access to mapped pointer.
43+
- Support for memory mapping, reference-counted internally. Support for persistently mapped memory: Just allocate with appropriate flag and you get access to mapped pointer.
4344
- Custom memory pools: Create a pool with desired parameters (e.g. fixed or limited maximum size) and allocate memory out of it.
44-
- Support for VK_KHR_dedicated_allocation extension: Enable it and it will be used automatically by the library.
45+
- Support for VK_KHR_dedicated_allocation extension: Just enable it and it will be used automatically by the library.
4546
- Defragmentation: Call one function and let the library move data around to free some memory blocks and make your allocations better compacted.
4647
- Lost allocations: Allocate memory with appropriate flags and let the library remove allocations that are not used for many frames to make room for new ones.
4748
- Statistics: Obtain detailed statistics about the amount of memory used, unused, number of allocated blocks, number of allocations etc. - globally, per memory heap, and per memory type.
@@ -52,9 +53,9 @@ Additional features:
5253

5354
- Self-contained C++ library in single header file. No external dependencies other than standard C and C++ library and of course Vulkan.
5455
- Public interface in C, in same convention as Vulkan API. Implementation in C++.
55-
- Interface documented using Doxygen-style comments.
56-
- Platform-independent, but developed and tested on Windows using Visual Studio.
5756
- Error handling implemented by returning `VkResult` error codes - same way as in Vulkan.
57+
- Interface documented using Doxygen-style comments.
58+
- Platform-independent, but developed and tested on Windows using Visual Studio. Continuous integration setup for Windows and Linux. Tested also on Android and MacOS.
5859

5960
# Example
6061

@@ -79,20 +80,20 @@ With this one function call:
7980
2. `VkDeviceMemory` block is allocated if needed.
8081
3. An unused region of the memory block is bound to this buffer.
8182
82-
`VmaAllocation` is an object that represents memory assigned to this buffer. It can be queried for parameters useful e.g. if you want to map the memory on host.
83+
`VmaAllocation` is an object that represents memory assigned to this buffer. It can be queried for parameters like Vulkan memory handle and offset.
8384
8485
# Read more
8586
8687
See **[Documentation](https://gpuopen-librariesandsdks.github.io/VulkanMemoryAllocator/html/)**.
8788
8889
# Software using this library
8990
90-
- **[Anvil](https://github.com/GPUOpen-LibrariesAndSDKs/Anvil)** - cross-platform framework for Vulkan
91-
- **[vkDOOM3](https://github.com/DustinHLand/vkDOOM3)** - Vulkan port of GPL DOOM 3 BFG Edition
92-
- **[Lightweight Java Game Library (LWJGL)](https://www.lwjgl.org/)** - includes binding of the library for Java
91+
- **[Anvil](https://github.com/GPUOpen-LibrariesAndSDKs/Anvil)** - cross-platform framework for Vulkan. License: MIT.
92+
- **[vkDOOM3](https://github.com/DustinHLand/vkDOOM3)** - Vulkan port of GPL DOOM 3 BFG Edition. License: GNU GPL.
93+
- **[Lightweight Java Game Library (LWJGL)](https://www.lwjgl.org/)** - includes binding of the library for Java. License: BSD.
9394
9495
# See also
9596
9697
- **[Awesome Vulkan](https://github.com/vinjn/awesome-vulkan)** - a curated list of awesome Vulkan libraries, debuggers and resources.
97-
- **[PyVMA](https://github.com/realitix/pyvma)** - Python wrapper for this library. Author: Jean-Sébastien B. (@realitix). License: Apache 2.0.
98+
- **[PyVMA](https://github.com/realitix/pyvma)** - Python wrapper for this library. Author: Jean-Sébastien B. (@realitix). License: Apache 2.0.
9899
- **[vulkan-malloc](https://github.com/dylanede/vulkan-malloc)** - Vulkan memory allocation library for Rust. Based on version 1 of this library. Author: Dylan Ede (@dylanede). License: MIT / Apache 2.0.

0 commit comments

Comments
 (0)