From 7ec3930906ef27370b281801dd56be4e2569402c Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Mon, 27 Aug 2018 11:00:06 +0200 Subject: [PATCH] Documentation "Introduction" - added paragraph about macros define before including headers. Issue #36 Thanks @chaoticbob ! --- src/vk_mem_alloc.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/vk_mem_alloc.h b/src/vk_mem_alloc.h index 7dd8ff2..46384a7 100644 --- a/src/vk_mem_alloc.h +++ b/src/vk_mem_alloc.h @@ -123,6 +123,13 @@ To do it properly: It may be a good idea to create dedicated CPP file just for this purpose. +Please note that this library includes header ``, which in turn +includes `` on Windows. If you need some specific macros defined +before including these headers (like `NOMINMAX`, `WIN32_LEAN_AND_MEAN`, or +`WINVER` for Windows, `VK_USE_PLATFORM_WIN32_KHR` for Vulkan), you must define +them before every `#include` of this library. + + \section quick_start_initialization Initialization At program startup: