eden-emu/VulkanMemoryAllocator
14
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2025-05-15 01:08:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixes in documentation

Browse source
This commit is contained in:
Adam Sawicki 2025-04-11 17:27:57 +02:00
parent e1c0f1ee36
commit 071a681e3b
1 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
include/vk_mem_alloc.h
View file

@ -1670,24 +1670,28 @@ typedef struct VmaVirtualAllocationInfo
*/ */
#ifdef VOLK_HEADER_VERSION #ifdef VOLK_HEADER_VERSION
/** \brief Fully initializes `pDstVulkanFunctions` structure with Vulkan functions needed by this library based on functions imported by /** \brief Fully initializes `pDstVulkanFunctions` structure with Vulkan functions needed by VMA
[volk library](https://github.com/zeux/volk). using [volk library](https://github.com/zeux/volk).
This function is defined in VMA header only if "volk.h" was included before it. This function is defined in VMA header only if "volk.h" was included before it.
To use this function properly: To use this function properly:
-# Create `VkInstance` and `VkDevice` object. -# Initialize volk and Vulkan:
-# Call `volkInitialize()`
-# Create `VkInstance` object
-# Call `volkLoadInstance()`
-# Create `VkDevice` object
-# Call `volkLoadDevice()`
-# Fill in structure #VmaAllocatorCreateInfo, especially members: -# Fill in structure #VmaAllocatorCreateInfo, especially members:
- VmaAllocatorCreateInfo::device - VmaAllocatorCreateInfo::device
- VmaAllocatorCreateInfo::vulkanApiVersion - VmaAllocatorCreateInfo::vulkanApiVersion
- VmaAllocatorCreateInfo::flags - set appropriate flags for the Vulkan extensions you enabled - VmaAllocatorCreateInfo::flags - set appropriate flags for the Vulkan extensions you enabled
-# Define structure #VmaVulkanFunctions. -# Create an instance of the #VmaVulkanFunctions structure.
-# Call this function. -# Call vmaImportVulkanFunctionsFromVolk().
Parameter `pAllocatorCreateInfo` is read to find out which functions should be fetched for Parameter `pAllocatorCreateInfo` is read to find out which functions should be fetched for
appropriate Vulkan version and extensions. appropriate Vulkan version and extensions.
Parameter `pDstVulkanFunctions` is filled with those function pointers. Parameter `pDstVulkanFunctions` is filled with those function pointers, or null if not applicable.
Others are set to null.
-# Attach the #VmaVulkanFunctions structure to VmaAllocatorCreateInfo::pVulkanFunctions. -# Attach the #VmaVulkanFunctions structure to VmaAllocatorCreateInfo::pVulkanFunctions.
-# Call vmaCreateAllocator() to create the #VmaAllocator object. -# Call vmaCreateAllocator() to create the #VmaAllocator object.