diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html index 2c9fcfb..50a7428 100644 --- a/docs/html/doxygen_crawl.html +++ b/docs/html/doxygen_crawl.html @@ -185,6 +185,7 @@ + diff --git a/docs/html/globals.html b/docs/html/globals.html index 5f61b09..e584505 100644 --- a/docs/html/globals.html +++ b/docs/html/globals.html @@ -234,6 +234,7 @@ $(function(){ initResizable(false); });
Functions | |||
VkResult | vmaImportVulkanFunctionsFromVolk (const VmaAllocatorCreateInfo *pAllocatorCreateInfo, VmaVulkanFunctions *pDstVulkanFunctions) | ||
Fully initializes pDstVulkanFunctions structure with Vulkan functions needed by VMA using volk library. | |||
VkResult | vmaCreateAllocator (const VmaAllocatorCreateInfo *pCreateInfo, VmaAllocator *pAllocator) | ||
Creates VmaAllocator object. | |||
VkResult vmaImportVulkanFunctionsFromVolk | +( | +const VmaAllocatorCreateInfo * | pAllocatorCreateInfo, | +
+ | + | VmaVulkanFunctions * | pDstVulkanFunctions ) | +
Fully initializes pDstVulkanFunctions
structure with Vulkan functions needed by VMA using volk library.
This function is defined in VMA header only if "volk.h" was included before it.
+To use this function properly:
+volkInitialize()
VkInstance
objectvolkLoadInstance()
VkDevice
objectvolkLoadDevice()
pAllocatorCreateInfo
is read to find out which functions should be fetched for appropriate Vulkan version and extensions. Parameter pDstVulkanFunctions
is filled with those function pointers, or null if not applicable.Example:
+Internally in this function, pointers to functions related to the entire Vulkan instance are fetched using global function definitions, while pointers to functions related to the Vulkan device are fetched using volkLoadDeviceTable()
for given pAllocatorCreateInfo->device
.
Step 2: Runtime. Even when compiled with higher Vulkan version available, VMA can use only features of a lower version, which is configurable during creation of the VmaAllocator object. By default, only Vulkan 1.0 is used. To initialize the allocator with support for higher Vulkan version, you need to set member VmaAllocatorCreateInfo::vulkanApiVersion to an appropriate value, e.g. using constants like VK_API_VERSION_1_2
. See code sample below.
You may need to configure importing Vulkan functions. There are 3 ways to do this:
+You may need to configure importing Vulkan functions. There are 4 ways to do this:
VMA_STATIC_VULKAN_FUNCTIONS
and VMA_DYNAMIC_VULKAN_FUNCTIONS
to 0.VMA_STATIC_VULKAN_FUNCTIONS
and VMA_DYNAMIC_VULKAN_FUNCTIONS
to 0.Functions | |
VkResult | vmaImportVulkanFunctionsFromVolk (const VmaAllocatorCreateInfo *pAllocatorCreateInfo, VmaVulkanFunctions *pDstVulkanFunctions) |
Fully initializes pDstVulkanFunctions structure with Vulkan functions needed by VMA using volk library. | |
VkResult | vmaCreateAllocator (const VmaAllocatorCreateInfo *pCreateInfo, VmaAllocator *pAllocator) |
Creates VmaAllocator object. | |