From defbf3d9755e2fbc8574554935cef2ee4ef1eb2e Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Tue, 23 Jan 2018 13:58:07 +0100 Subject: [PATCH] Minor fix in documentation. --- docs/html/custom_memory_pools.html | 2 +- docs/html/struct_vma_allocator_create_info.html | 8 ++++---- docs/html/vk__mem__alloc_8h_source.html | 2 +- src/vk_mem_alloc.h | 8 ++++---- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/html/custom_memory_pools.html b/docs/html/custom_memory_pools.html index bff6411..573c0fb 100644 --- a/docs/html/custom_memory_pools.html +++ b/docs/html/custom_memory_pools.html @@ -79,7 +79,7 @@ $(function() {
  • When making an allocation, set VmaAllocationCreateInfo::pool to this handle. You don't need to specify any other parameters of this structure, like usage.

    • Example:

    -
    // Create a pool that could have at most 2 blocks, 128 MB each.
    VmaPoolCreateInfo poolCreateInfo = {};
    poolCreateInfo.memoryTypeIndex = ...
    poolCreateInfo.blockSize = 128ull * 1024 * 1024;
    poolCreateInfo.maxBlockCount = 2;
    VmaPool pool;
    vmaCreatePool(allocator, &poolCreateInfo, &pool);
    // Allocate a buffer out of it.
    VkBufferCreateInfo bufCreateInfo = { VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO };
    bufCreateInfo.size = 1024;
    bufCreateInfo.usage = VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT | VK_BUFFER_USAGE_TRANSFER_DST_BIT;
    VmaAllocationCreateInfo allocCreateInfo = {};
    allocCreateInfo.pool = pool;
    VkBuffer buf;
    VmaAllocation alloc;
    VmaAllocationInfo allocInfo;
    vmaCreateBuffer(allocator, &bufCreateInfo, &allocCreateInfo, &buf, &alloc, &allocInfo);

    You have to free all allocations made from this pool before destroying it.

    +
    // Create a pool that could have at most 2 blocks, 128 MiB each.
    VmaPoolCreateInfo poolCreateInfo = {};
    poolCreateInfo.memoryTypeIndex = ...
    poolCreateInfo.blockSize = 128ull * 1024 * 1024;
    poolCreateInfo.maxBlockCount = 2;
    VmaPool pool;
    vmaCreatePool(allocator, &poolCreateInfo, &pool);
    // Allocate a buffer out of it.
    VkBufferCreateInfo bufCreateInfo = { VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO };
    bufCreateInfo.size = 1024;
    bufCreateInfo.usage = VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT | VK_BUFFER_USAGE_TRANSFER_DST_BIT;
    VmaAllocationCreateInfo allocCreateInfo = {};
    allocCreateInfo.pool = pool;
    VkBuffer buf;
    VmaAllocation alloc;
    VmaAllocationInfo allocInfo;
    vmaCreateBuffer(allocator, &bufCreateInfo, &allocCreateInfo, &buf, &alloc, &allocInfo);

    You have to free all allocations made from this pool before destroying it.

    vmaDestroyBuffer(allocator, buf, alloc);
    vmaDestroyPool(allocator, pool);
    diff --git a/docs/html/struct_vma_allocator_create_info.html b/docs/html/struct_vma_allocator_create_info.html index 7b8f5f5..4a548db 100644 --- a/docs/html/struct_vma_allocator_create_info.html +++ b/docs/html/struct_vma_allocator_create_info.html @@ -86,7 +86,7 @@ Public Attributes  Preferred size of a single VkDeviceMemory block to be allocated from large heaps. More...
      VkDeviceSize preferredSmallHeapBlockSize - Preferred size of a single VkDeviceMemory block to be allocated from small heaps <= 512 MB. More...
    + Preferred size of a single VkDeviceMemory block to be allocated from small heaps <= 512 MiB. More...
      const VkAllocationCallbacks * pAllocationCallbacks  Custom CPU memory allocation callbacks. More...
    @@ -247,7 +247,7 @@ Public Attributes

    Preferred size of a single VkDeviceMemory block to be allocated from large heaps.

    -

    Set to 0 to use default, which is currently 256 MB.

    +

    Set to 0 to use default, which is currently 256 MiB.

    @@ -263,8 +263,8 @@ Public Attributes
    -

    Preferred size of a single VkDeviceMemory block to be allocated from small heaps <= 512 MB.

    -

    Set to 0 to use default, which is currently 64 MB.

    +

    Preferred size of a single VkDeviceMemory block to be allocated from small heaps <= 512 MiB.

    +

    Set to 0 to use default, which is currently 64 MiB.

    diff --git a/docs/html/vk__mem__alloc_8h_source.html b/docs/html/vk__mem__alloc_8h_source.html index fc378c2..d72f985 100644 --- a/docs/html/vk__mem__alloc_8h_source.html +++ b/docs/html/vk__mem__alloc_8h_source.html @@ -86,7 +86,7 @@ $(function() {
    vmaCalculateStats
    void vmaCalculateStats(VmaAllocator allocator, VmaStats *pStats)
    Retrieves statistics from current state of the Allocator.
    VmaAllocatorCreateInfo::pVulkanFunctions
    const VmaVulkanFunctions * pVulkanFunctions
    Pointers to Vulkan functions. Can be null if you leave define VMA_STATIC_VULKAN_FUNCTIONS 1...
    Definition: vk_mem_alloc.h:848
    VmaAllocatorCreateInfo
    Description of a Allocator to be created.
    Definition: vk_mem_alloc.h:777
    -
    VmaAllocatorCreateInfo::preferredSmallHeapBlockSize
    VkDeviceSize preferredSmallHeapBlockSize
    Preferred size of a single VkDeviceMemory block to be allocated from small heaps <= 512 MB...
    Definition: vk_mem_alloc.h:792
    +
    VmaAllocatorCreateInfo::preferredSmallHeapBlockSize
    VkDeviceSize preferredSmallHeapBlockSize
    Preferred size of a single VkDeviceMemory block to be allocated from small heaps <= 512 MiB...
    Definition: vk_mem_alloc.h:792
    vmaDestroyAllocator
    void vmaDestroyAllocator(VmaAllocator allocator)
    Destroys allocator object.
    VmaAllocationCreateFlagBits
    VmaAllocationCreateFlagBits
    Flags to be passed as VmaAllocationCreateInfo::flags.
    Definition: vk_mem_alloc.h:993
    vmaGetAllocationInfo
    void vmaGetAllocationInfo(VmaAllocator allocator, VmaAllocation allocation, VmaAllocationInfo *pAllocationInfo)
    Returns current information about specified allocation.
    diff --git a/src/vk_mem_alloc.h b/src/vk_mem_alloc.h index 4dfb7cf..e587c51 100644 --- a/src/vk_mem_alloc.h +++ b/src/vk_mem_alloc.h @@ -333,7 +333,7 @@ To use custom memory pools: Example: \code -// Create a pool that could have at most 2 blocks, 128 MB each. +// Create a pool that could have at most 2 blocks, 128 MiB each. VmaPoolCreateInfo poolCreateInfo = {}; poolCreateInfo.memoryTypeIndex = ... poolCreateInfo.blockSize = 128ull * 1024 * 1024; @@ -785,10 +785,10 @@ typedef struct VmaAllocatorCreateInfo /** It must be valid throughout whole lifetime of created allocator. */ VkDevice device; /// Preferred size of a single `VkDeviceMemory` block to be allocated from large heaps. - /** Set to 0 to use default, which is currently 256 MB. */ + /** Set to 0 to use default, which is currently 256 MiB. */ VkDeviceSize preferredLargeHeapBlockSize; - /// Preferred size of a single `VkDeviceMemory` block to be allocated from small heaps <= 512 MB. - /** Set to 0 to use default, which is currently 64 MB. */ + /// Preferred size of a single `VkDeviceMemory` block to be allocated from small heaps <= 512 MiB. + /** Set to 0 to use default, which is currently 64 MiB. */ VkDeviceSize preferredSmallHeapBlockSize; /// Custom CPU memory allocation callbacks. /** Optional, can be null. When specified, will also be used for all CPU-side memory allocations. */