Final fixes before v2.2.0 release. Minor fixes after tests. Rebuilt binaries and documentation again.

This commit is contained in:
Adam Sawicki 2018-12-13 11:56:30 +01:00
parent 1a8424f41a
commit bdb89a93eb
6 changed files with 14 additions and 12 deletions

Binary file not shown.

Binary file not shown.

View File

@ -1285,7 +1285,7 @@ Functions</h2></td></tr>
<tr><td class="paramdir"></td><td class="paramname">pCreateInfo</td><td>Creation parameters for each alloction. </td></tr> <tr><td class="paramdir"></td><td class="paramname">pCreateInfo</td><td>Creation parameters for each alloction. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">allocationCount</td><td>Number of allocations to make. </td></tr> <tr><td class="paramdir"></td><td class="paramname">allocationCount</td><td>Number of allocations to make. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pAllocations</td><td>Pointer to array that will be filled with handles to created allocations. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">pAllocations</td><td>Pointer to array that will be filled with handles to created allocations. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pAlocationInfo</td><td>Optional. Pointer to array that will be filled with parameters of created allocations.</td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">pAllocationInfo</td><td>Optional. Pointer to array that will be filled with parameters of created allocations.</td></tr>
</table> </table>
</dd> </dd>
</dl> </dl>
@ -1873,10 +1873,10 @@ Functions</h2></td></tr>
<p>Begins defragmentation process. </p> <p>Begins defragmentation process. </p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">allocator</td><td>Allocator object. </td></tr> <tr><td class="paramdir"></td><td class="paramname">allocator</td><td>Allocator object. </td></tr>
<tr><td class="paramname">pInfo</td><td>Structure filled with parameters of defragmentation. </td></tr> <tr><td class="paramdir"></td><td class="paramname">pInfo</td><td>Structure filled with parameters of defragmentation. </td></tr>
<tr><td class="paramname">pStats[out]</td><td>Optional. Statistics of defragmentation. You can pass null if you are not interested in this information. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">pStats</td><td>Optional. Statistics of defragmentation. You can pass null if you are not interested in this information. </td></tr>
<tr><td class="paramname">pContext[out]</td><td>Context object that must be passed to <a class="el" href="vk__mem__alloc_8h.html#a8774e20e91e245aae959ba63efa15dd2" title="Ends defragmentation process. ">vmaDefragmentationEnd()</a> to finish defragmentation. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">pContext</td><td>Context object that must be passed to <a class="el" href="vk__mem__alloc_8h.html#a8774e20e91e245aae959ba63efa15dd2" title="Ends defragmentation process. ">vmaDefragmentationEnd()</a> to finish defragmentation. </td></tr>
</table> </table>
</dd> </dd>
</dl> </dl>

File diff suppressed because one or more lines are too long

View File

@ -13,6 +13,10 @@ extern VkCommandBuffer g_hTemporaryCommandBuffer;
void BeginSingleTimeCommands(); void BeginSingleTimeCommands();
void EndSingleTimeCommands(); void EndSingleTimeCommands();
#ifndef VMA_DEBUG_MARGIN
#define VMA_DEBUG_MARGIN 0
#endif
enum CONFIG_TYPE { enum CONFIG_TYPE {
CONFIG_TYPE_MINIMUM, CONFIG_TYPE_MINIMUM,
CONFIG_TYPE_SMALL, CONFIG_TYPE_SMALL,
@ -1379,6 +1383,7 @@ void TestDefragmentationSimple()
Allocation that must be move to an overlapping place using memmove(). Allocation that must be move to an overlapping place using memmove().
Create 2 buffers, second slightly bigger than the first. Delete first. Then defragment. Create 2 buffers, second slightly bigger than the first. Delete first. Then defragment.
*/ */
if(VMA_DEBUG_MARGIN == 0) // FAST algorithm works only when DEBUG_MARGIN disabled.
{ {
AllocInfo allocInfo[2]; AllocInfo allocInfo[2];

View File

@ -2499,7 +2499,7 @@ VkResult vmaAllocateMemory(
@param pCreateInfo Creation parameters for each alloction. @param pCreateInfo Creation parameters for each alloction.
@param allocationCount Number of allocations to make. @param allocationCount Number of allocations to make.
@param[out] pAllocations Pointer to array that will be filled with handles to created allocations. @param[out] pAllocations Pointer to array that will be filled with handles to created allocations.
@param[out] pAlocationInfo Optional. Pointer to array that will be filled with parameters of created allocations. @param[out] pAllocationInfo Optional. Pointer to array that will be filled with parameters of created allocations.
You should free the memory using vmaFreeMemory() or vmaFreeMemoryPages(). You should free the memory using vmaFreeMemory() or vmaFreeMemoryPages().
@ -2875,8 +2875,8 @@ typedef struct VmaDefragmentationStats {
@param allocator Allocator object. @param allocator Allocator object.
@param pInfo Structure filled with parameters of defragmentation. @param pInfo Structure filled with parameters of defragmentation.
@param pStats[out] Optional. Statistics of defragmentation. You can pass null if you are not interested in this information. @param[out] pStats Optional. Statistics of defragmentation. You can pass null if you are not interested in this information.
@param pContext[out] Context object that must be passed to vmaDefragmentationEnd() to finish defragmentation. @param[out] pContext Context object that must be passed to vmaDefragmentationEnd() to finish defragmentation.
@return `VK_SUCCESS` and `*pContext == null` if defragmentation finished within this function call. `VK_NOT_READY` and `*pContext != null` if defragmentation has been started and you need to call vmaDefragmentationEnd() to finish it. Negative value in case of error. @return `VK_SUCCESS` and `*pContext == null` if defragmentation finished within this function call. `VK_NOT_READY` and `*pContext != null` if defragmentation has been started and you need to call vmaDefragmentationEnd() to finish it. Negative value in case of error.
Use this function instead of old, deprecated vmaDefragment(). Use this function instead of old, deprecated vmaDefragment().
@ -6272,9 +6272,6 @@ private:
struct VmaBlockDefragmentationContext struct VmaBlockDefragmentationContext
{ {
private:
VMA_CLASS_NO_COPY(VmaBlockDefragmentationContext)
public:
enum BLOCK_FLAG enum BLOCK_FLAG
{ {
BLOCK_FLAG_USED = 0x00000001, BLOCK_FLAG_USED = 0x00000001,