mirror/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2024-12-01 18:34:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarified that the library doesn't use STL containers by default.

Browse Source 
Because responses in the survey indicate that some users think it does.
This commit is contained in:
Adam Sawicki 2019-03-15 12:26:36 +01:00
parent b25a20a8da
commit e5aa3c0a1e
3 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -60,11 +60,11 @@ Additional features:
# Prequisites # Prequisites
- Self-contained C++ library in single header file. No external dependencies other than standard C and C++ library and of course Vulkan. - Self-contained C++ library in single header file. No external dependencies other than standard C and C++ library and of course Vulkan. STL containers are not used by default.
- Public interface in C, in same convention as Vulkan API. Implementation in C++. - Public interface in C, in same convention as Vulkan API. Implementation in C++.
- Error handling implemented by returning `VkResult` error codes - same way as in Vulkan. - Error handling implemented by returning `VkResult` error codes - same way as in Vulkan.
- Interface documented using Doxygen-style comments. - Interface documented using Doxygen-style comments.
- Platform-independent, but developed and tested on Windows using Visual Studio. Continuous integration setup for Windows and Linux. Tested also on Android, MacOS, and other platforms. - Platform-independent, but developed and tested on Windows using Visual Studio. Continuous integration setup for Windows and Linux. Used also on Android, MacOS, and other platforms.
# Example # Example

2
docs/html/vk__mem__alloc_8h_source.html
View File

File diff suppressed because one or more lines are too long

4
src/vk_mem_alloc.h
View File

@ -3177,6 +3177,10 @@ the containers.
#endif #endif
#endif #endif
/*
THESE INCLUDES ARE NOT ENABLED BY DEFAULT.
Library has its own container implementation.
*/
#if VMA_USE_STL_VECTOR #if VMA_USE_STL_VECTOR
#include <vector> #include <vector>
#endif #endif