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

Change default value of macro VMA_RECORDING_ENABLED to 0

Browse Source 
...so that Windows.h is not included by default on Windows.
This commit is contained in:
Adam Sawicki 2019-07-02 15:19:05 +02:00
parent 4abe30c1ae
commit 2024cc570a
4 changed files with 159 additions and 155 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/html/record_and_replay.html
View File

@ -79,7 +79,8 @@ Introduction</h1>
</ul> </ul>
<h1><a class="anchor" id="record_and_replay_usage"></a> <h1><a class="anchor" id="record_and_replay_usage"></a>
Usage</h1> Usage</h1>
<p><b>To record sequence of calls to a file:</b> Fill in <a class="el" href="struct_vma_allocator_create_info.html#ace2aa4877b16a42b0b7673d4e26000ee" title="Parameters for recording of VMA calls. Can be null.">VmaAllocatorCreateInfo::pRecordSettings</a> member while creating <a class="el" href="struct_vma_allocator.html" title="Represents main object of this library initialized.">VmaAllocator</a> object. File is opened and written during whole lifetime of the allocator.</p> <p>Recording functionality is disabled by default. To enable it, define following macro before every include of this library:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#define VMA_RECORDING_ENABLED 1</span></div></div><!-- fragment --><p><b>To record sequence of calls to a file:</b> Fill in <a class="el" href="struct_vma_allocator_create_info.html#ace2aa4877b16a42b0b7673d4e26000ee" title="Parameters for recording of VMA calls. Can be null.">VmaAllocatorCreateInfo::pRecordSettings</a> member while creating <a class="el" href="struct_vma_allocator.html" title="Represents main object of this library initialized.">VmaAllocator</a> object. File is opened and written during whole lifetime of the allocator.</p>
<p><b>To replay file:</b> Use VmaReplay - standalone command-line program. Precompiled binary can be found in "bin" directory. Its source can be found in "src/VmaReplay" directory. Its project is generated by Premake. Command line syntax is printed when the program is launched without parameters. Basic usage: </p><pre class="fragment">VmaReplay.exe MyRecording.csv <p><b>To replay file:</b> Use VmaReplay - standalone command-line program. Precompiled binary can be found in "bin" directory. Its source can be found in "src/VmaReplay" directory. Its project is generated by Premake. Command line syntax is printed when the program is launched without parameters. Basic usage: </p><pre class="fragment">VmaReplay.exe MyRecording.csv
</pre><p><b>Documentation of file format</b> can be found in file: "docs/Recording file format.md". It's a human-readable, text file in CSV format (Comma Separated Values).</p> </pre><p><b>Documentation of file format</b> can be found in file: "docs/Recording file format.md". It's a human-readable, text file in CSV format (Comma Separated Values).</p>
<h1><a class="anchor" id="record_and_replay_additional_considerations"></a> <h1><a class="anchor" id="record_and_replay_additional_considerations"></a>

296
docs/html/vk__mem__alloc_8h_source.html
View File

File diff suppressed because one or more lines are too long

2
src/VmaUsage.h
View File

@ -45,7 +45,7 @@ include all public interface declarations. Example:
//#define VMA_DEBUG_MARGIN 16 //#define VMA_DEBUG_MARGIN 16
//#define VMA_DEBUG_DETECT_CORRUPTION 1 //#define VMA_DEBUG_DETECT_CORRUPTION 1
//#define VMA_DEBUG_INITIALIZE_ALLOCATIONS 1 //#define VMA_DEBUG_INITIALIZE_ALLOCATIONS 1
//#define VMA_RECORDING_ENABLED 0 //#define VMA_RECORDING_ENABLED 1
//#define VMA_DEBUG_MIN_BUFFER_IMAGE_GRANULARITY 256 //#define VMA_DEBUG_MIN_BUFFER_IMAGE_GRANULARITY 256
//#define VMA_USE_STL_SHARED_MUTEX 0 //#define VMA_USE_STL_SHARED_MUTEX 0
//#define VMA_DEBUG_GLOBAL_MUTEX 1 //#define VMA_DEBUG_GLOBAL_MUTEX 1

13
src/vk_mem_alloc.h
View File

@ -1307,6 +1307,13 @@ application. It can be useful to:
\section record_and_replay_usage Usage \section record_and_replay_usage Usage
Recording functionality is disabled by default.
To enable it, define following macro before every include of this library:
\code
#define VMA_RECORDING_ENABLED 1
\endcode
<b>To record sequence of calls to a file:</b> Fill in <b>To record sequence of calls to a file:</b> Fill in
VmaAllocatorCreateInfo::pRecordSettings member while creating #VmaAllocator VmaAllocatorCreateInfo::pRecordSettings member while creating #VmaAllocator
object. File is opened and written during whole lifetime of the allocator. object. File is opened and written during whole lifetime of the allocator.
@ -1680,11 +1687,7 @@ Define this macro to 0/1 to disable/enable support for recording functionality,
available through VmaAllocatorCreateInfo::pRecordSettings. available through VmaAllocatorCreateInfo::pRecordSettings.
*/ */
#ifndef VMA_RECORDING_ENABLED #ifndef VMA_RECORDING_ENABLED
#ifdef _WIN32 #define VMA_RECORDING_ENABLED 0
#define VMA_RECORDING_ENABLED 1
#else
#define VMA_RECORDING_ENABLED 0
#endif
#endif #endif
#ifndef NOMINMAX #ifndef NOMINMAX