Skip to content

Commit 071a681

Browse files
Fixes in documentation
1 parent e1c0f1e commit 071a681

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

include/vk_mem_alloc.h

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1670,24 +1670,28 @@ typedef struct VmaVirtualAllocationInfo
16701670
*/
16711671

16721672
#ifdef VOLK_HEADER_VERSION
1673-
/** \brief Fully initializes `pDstVulkanFunctions` structure with Vulkan functions needed by this library based on functions imported by
1674-
[volk library](https://github.com/zeux/volk).
1673+
/** \brief Fully initializes `pDstVulkanFunctions` structure with Vulkan functions needed by VMA
1674+
using [volk library](https://github.com/zeux/volk).
16751675

16761676
This function is defined in VMA header only if "volk.h" was included before it.
16771677

16781678
To use this function properly:
16791679

1680-
-# Create `VkInstance` and `VkDevice` object.
1680+
-# Initialize volk and Vulkan:
1681+
-# Call `volkInitialize()`
1682+
-# Create `VkInstance` object
1683+
-# Call `volkLoadInstance()`
1684+
-# Create `VkDevice` object
1685+
-# Call `volkLoadDevice()`
16811686
-# Fill in structure #VmaAllocatorCreateInfo, especially members:
16821687
- VmaAllocatorCreateInfo::device
16831688
- VmaAllocatorCreateInfo::vulkanApiVersion
16841689
- VmaAllocatorCreateInfo::flags - set appropriate flags for the Vulkan extensions you enabled
1685-
-# Define structure #VmaVulkanFunctions.
1686-
-# Call this function.
1690+
-# Create an instance of the #VmaVulkanFunctions structure.
1691+
-# Call vmaImportVulkanFunctionsFromVolk().
16871692
Parameter `pAllocatorCreateInfo` is read to find out which functions should be fetched for
16881693
appropriate Vulkan version and extensions.
1689-
Parameter `pDstVulkanFunctions` is filled with those function pointers.
1690-
Others are set to null.
1694+
Parameter `pDstVulkanFunctions` is filled with those function pointers, or null if not applicable.
16911695
-# Attach the #VmaVulkanFunctions structure to VmaAllocatorCreateInfo::pVulkanFunctions.
16921696
-# Call vmaCreateAllocator() to create the #VmaAllocator object.
16931697

0 commit comments

Comments
 (0)