Skip to content

Commit fc9db8d

Browse files
Minor addition to documentation. #46
1 parent b03d51e commit fc9db8d

File tree

3 files changed

+135
-130
lines changed

3 files changed

+135
-130
lines changed

docs/html/quick_start.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
<li>In exacly one CPP file define following macro before this include. It enables also internal definitions.</li>
8080
</ol>
8181
<div class="fragment"><div class="line"><span class="preprocessor">#define VMA_IMPLEMENTATION</span></div><div class="line"><span class="preprocessor">#include &quot;vk_mem_alloc.h&quot;</span></div></div><!-- fragment --><p>It may be a good idea to create dedicated CPP file just for this purpose.</p>
82+
<p>Note on language: 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.</p>
8283
<p>Please note that 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>
8384
<h1><a class="anchor" id="quick_start_initialization"></a>
8485
Initialization</h1>

docs/html/vk__mem__alloc_8h_source.html

Lines changed: 130 additions & 130 deletions
Large diffs are not rendered by default.

src/vk_mem_alloc.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,10 @@ To do it properly:
124124

125125
It may be a good idea to create dedicated CPP file just for this purpose.
126126

127+
Note on language: This library is written in C++, but has C-compatible interface.
128+
Thus you can include and use vk_mem_alloc.h in C or C++ code, but full
129+
implementation with `VMA_IMPLEMENTATION` macro must be compiled as C++, NOT as C.
130+
127131
Please note that this library includes header `<vulkan/vulkan.h>`, which in turn
128132
includes `<windows.h>` on Windows. If you need some specific macros defined
129133
before including these headers (like `WIN32_LEAN_AND_MEAN` or

0 commit comments

Comments
 (0)