Skip to content

Commit 1db1f55

Browse files
Fixes in documentation regarding sparse binding.
1 parent bc90dd5 commit 1db1f55

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Additional features:
4242
- 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.
4343
- Support for memory mapping, reference-counted internally. Support for persistently mapped memory: Just allocate with appropriate flag and you get access to mapped pointer.
4444
- Support for non-coherent memory. Functions that flush/invalidate memory. `nonCoherentAtomSize` is respected automatically.
45+
- Support for sparse binding and sparse residency: Convenience functions that allocate or free multiple memory pages at once.
4546
- Custom memory pools: Create a pool with desired parameters (e.g. fixed or limited maximum size) and allocate memory out of it.
4647
- Linear allocator: Create a pool with linear algorithm and use it for much faster allocations and deallocations in free-at-once, stack, double stack, or ring buffer fashion.
4748
- Support for VK_KHR_dedicated_allocation extension: Just enable it and it will be used automatically by the library.

src/vk_mem_alloc.h

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1587,13 +1587,8 @@ The library uses following algorithm for allocation, in order:
15871587

15881588
Features deliberately excluded from the scope of this library:
15891589

1590-
- Support for sparse binding and sparse residency. You can still use these
1591-
features (when supported by the device) with VMA. You just need to do it
1592-
yourself. Allocate memory pages with vmaAllocateMemory().
1593-
Any explicit support for sparse binding/residency would rather
1594-
require another, higher-level library on top of VMA.
1595-
- Data transfer - issuing commands that transfer data between buffers or images, any usage of
1596-
`VkCommandBuffer` or `VkQueue` and related synchronization is responsibility of the user.
1590+
- Data transfer. Uploading (straming) and downloading data of buffers and images
1591+
between CPU and GPU memory and related synchronization is responsibility of the user.
15971592
- Allocations for imported/exported external memory. They tend to require
15981593
explicit memory type index and dedicated allocation anyway, so they don't
15991594
interact with main features of this library. Such special purpose allocations

0 commit comments

Comments
 (0)