Skip to content

Commit 5b598e0

Browse files
Clarified documentation about required C++14 version
Fixes #252
1 parent 3ed40d8 commit 5b598e0

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

docs/html/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
<div class="headertitle"><div class="title">Vulkan Memory Allocator </div></div>
6666
</div><!--header-->
6767
<div class="contents">
68-
<div class="textblock"><p ><b>Version 3.0.0 (2022-03-25)</b></p>
68+
<div class="textblock"><p ><b>Version 3.0.1-development (2022-03-28)</b></p>
6969
<p >Copyright (c) 2017-2022 Advanced Micro Devices, Inc. All rights reserved. <br />
7070
License: MIT</p>
7171
<p ><b>API documentation divided into groups:</b> <a href="modules.html">Modules</a></p>

docs/html/quick_start.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
<div class="ttc" id="avk__mem__alloc_8h_html"><div class="ttname"><a href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a></div></div>
8484
</div><!-- fragment --><p >It may be a good idea to create dedicated CPP file just for this purpose.</p>
8585
<p >This library includes header <code>&lt;vulkan/vulkan.h&gt;</code>, which in turn includes <code>&lt;windows.h&gt;</code> on Windows. If you need some specific macros defined before including these headers (like <code>WIN32_LEAN_AND_MEAN</code> or <code>WINVER</code> for Windows, <code>VK_USE_PLATFORM_WIN32_KHR</code> for Vulkan), you must define them before every <code>#include</code> of this library.</p>
86-
<dl class="section note"><dt>Note</dt><dd>This library is written in C++, but has C-compatible interface. Thus you can include and use <a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a> in C or C++ code, but full implementation with <code>VMA_IMPLEMENTATION</code> macro must be compiled as C++, NOT as C.</dd></dl>
86+
<p >This library is written in C++, but has C-compatible interface. Thus you can include and use <a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a> in C or C++ code, but full implementation with <code>VMA_IMPLEMENTATION</code> macro must be compiled as C++, NOT as C. Some features of C++14 used. STL containers, RTTI, or C++ exceptions are not used.</p>
8787
<h1><a class="anchor" id="quick_start_initialization"></a>
8888
Initialization</h1>
8989
<p >At program startup:</p>

include/vk_mem_alloc.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17608,9 +17608,10 @@ before including these headers (like `WIN32_LEAN_AND_MEAN` or
1760817608
`WINVER` for Windows, `VK_USE_PLATFORM_WIN32_KHR` for Vulkan), you must define
1760917609
them before every `#include` of this library.
1761017610

17611-
\note This library is written in C++, but has C-compatible interface.
17611+
This library is written in C++, but has C-compatible interface.
1761217612
Thus you can include and use vk_mem_alloc.h in C or C++ code, but full
1761317613
implementation with `VMA_IMPLEMENTATION` macro must be compiled as C++, NOT as C.
17614+
Some features of C++14 used. STL containers, RTTI, or C++ exceptions are not used.
1761417615

1761517616

1761617617
\section quick_start_initialization Initialization

0 commit comments

Comments
 (0)