AuroraMiddleware/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator synced 2024-11-05 12:20:07 +00:00
Code Issues Projects Releases Wiki Activity

Clarified documentation about required C++14 version

Browse Source 
Fixes #252
This commit is contained in:
Adam Sawicki 2022-03-28 16:36:24 +02:00
parent 3ed40d8321
commit 5b598e0a35
3 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/html/index.html
View File

@ -65,7 +65,7 @@ $(function() {
<div class="headertitle"><div class="title">Vulkan Memory Allocator </div></div> <div class="headertitle"><div class="title">Vulkan Memory Allocator </div></div>
</div><!--header--> </div><!--header-->
<div class="contents"> <div class="contents">
<div class="textblock"><p ><b>Version 3.0.0 (2022-03-25)</b></p> <div class="textblock"><p ><b>Version 3.0.1-development (2022-03-28)</b></p>
<p >Copyright (c) 2017-2022 Advanced Micro Devices, Inc. All rights reserved. <br /> <p >Copyright (c) 2017-2022 Advanced Micro Devices, Inc. All rights reserved. <br />
License: MIT</p> License: MIT</p>
<p ><b>API documentation divided into groups:</b> <a href="modules.html">Modules</a></p> <p ><b>API documentation divided into groups:</b> <a href="modules.html">Modules</a></p>

2
docs/html/quick_start.html
View File

@ -83,7 +83,7 @@ Project setup</h1>
<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> <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>
</div><!-- fragment --><p >It may be a good idea to create dedicated CPP file just for this purpose.</p> </div><!-- fragment --><p >It may be a good idea to create dedicated CPP file just for this purpose.</p>
<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> <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>
<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> <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>
<h1><a class="anchor" id="quick_start_initialization"></a> <h1><a class="anchor" id="quick_start_initialization"></a>
Initialization</h1> Initialization</h1>
<p >At program startup:</p> <p >At program startup:</p>

3
include/vk_mem_alloc.h
View File

@ -17608,9 +17608,10 @@ before including these headers (like `WIN32_LEAN_AND_MEAN` or
`WINVER` for Windows, `VK_USE_PLATFORM_WIN32_KHR` for Vulkan), you must define `WINVER` for Windows, `VK_USE_PLATFORM_WIN32_KHR` for Vulkan), you must define
them before every `#include` of this library. them before every `#include` of this library.
\note This library is written in C++, but has C-compatible interface. This library is written in C++, but has C-compatible interface.
Thus you can include and use vk_mem_alloc.h in C or C++ code, but full Thus you can include and use vk_mem_alloc.h in C or C++ code, but full
implementation with `VMA_IMPLEMENTATION` macro must be compiled as C++, NOT as C. implementation with `VMA_IMPLEMENTATION` macro must be compiled as C++, NOT as C.
Some features of C++14 used. STL containers, RTTI, or C++ exceptions are not used.
\section quick_start_initialization Initialization \section quick_start_initialization Initialization