Skip to content

Commit 7ec3930

Browse files
Documentation "Introduction" - added paragraph about macros define before including headers. Issue #36 Thanks @chaoticbob !
1 parent 53e9239 commit 7ec3930

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/vk_mem_alloc.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,13 @@ To do it properly:
123123
124124
It may be a good idea to create dedicated CPP file just for this purpose.
125125
126+
Please note that this library includes header `<vulkan/vulkan.h>`, which in turn
127+
includes `<windows.h>` on Windows. If you need some specific macros defined
128+
before including these headers (like `NOMINMAX`, `WIN32_LEAN_AND_MEAN`, or
129+
`WINVER` for Windows, `VK_USE_PLATFORM_WIN32_KHR` for Vulkan), you must define
130+
them before every `#include` of this library.
131+
132+
126133
\section quick_start_initialization Initialization
127134
128135
At program startup:

0 commit comments

Comments
 (0)