Minor fix in documentation regarding CSV recording

This commit is contained in:
Adam Sawicki 2019-07-02 12:37:36 +02:00
parent af88c1bde1
commit 543ba5baec
3 changed files with 148 additions and 150 deletions

View File

@ -86,8 +86,7 @@ Usage</h1>
Additional considerations</h1> Additional considerations</h1>
<ul> <ul>
<li>Replaying file that was recorded on a different GPU (with different parameters like <code>bufferImageGranularity</code>, <code>nonCoherentAtomSize</code>, and especially different set of memory heaps and types) may give different performance and memory usage results, as well as issue some warnings and errors.</li> <li>Replaying file that was recorded on a different GPU (with different parameters like <code>bufferImageGranularity</code>, <code>nonCoherentAtomSize</code>, and especially different set of memory heaps and types) may give different performance and memory usage results, as well as issue some warnings and errors.</li>
<li>Current implementation of recording in VMA, as well as VmaReplay application, is coded and tested only on Windows. Inclusion of recording code is driven by <code>VMA_RECORDING_ENABLED</code> macro. Support for other platforms should be easy to add. Contributions are welcomed.</li> <li>Current implementation of recording in VMA, as well as VmaReplay application, is coded and tested only on Windows. Inclusion of recording code is driven by <code>VMA_RECORDING_ENABLED</code> macro. Support for other platforms should be easy to add. Contributions are welcomed. </li>
<li>Currently calls to <a class="el" href="vk__mem__alloc_8h.html#a6aced90fcc7b39882b6654a740a0b9bb" title="Deprecated. Compacts memory by moving allocations.">vmaDefragment()</a> function are not recorded. </li>
</ul> </ul>
</div></div><!-- PageDoc --> </div></div><!-- PageDoc -->
</div><!-- contents --> </div><!-- contents -->

File diff suppressed because one or more lines are too long

View File

@ -1332,7 +1332,6 @@ It's a human-readable, text file in CSV format (Comma Separated Values).
coded and tested only on Windows. Inclusion of recording code is driven by coded and tested only on Windows. Inclusion of recording code is driven by
`VMA_RECORDING_ENABLED` macro. Support for other platforms should be easy to `VMA_RECORDING_ENABLED` macro. Support for other platforms should be easy to
add. Contributions are welcomed. add. Contributions are welcomed.
- Currently calls to vmaDefragment() function are not recorded.
\page usage_patterns Recommended usage patterns \page usage_patterns Recommended usage patterns