mirror/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2024-11-25 16:14:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documentation of VmaAllocatorCreateInfo::vulkanApiVersion

Browse Source 
Fixes #384 - thanks @qbojj
This commit is contained in:
Adam Sawicki 2024-01-20 23:01:16 +01:00
parent a0a04a22e9
commit 68d510599e
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/vk_mem_alloc.h
View File

@ -1074,13 +1074,15 @@ typedef struct VmaAllocatorCreateInfo
Starting from version 3.0.0 this member is no longer optional, it must be set! Starting from version 3.0.0 this member is no longer optional, it must be set!
*/ */
VkInstance VMA_NOT_NULL instance; VkInstance VMA_NOT_NULL instance;
/** \brief Optional. The highest version of Vulkan that the application is designed to use. /** \brief Optional. Vulkan version that the application uses.
It must be a value in the format as created by macro `VK_MAKE_VERSION` or a constant like: `VK_API_VERSION_1_1`, `VK_API_VERSION_1_0`. It must be a value in the format as created by macro `VK_MAKE_VERSION` or a constant like: `VK_API_VERSION_1_1`, `VK_API_VERSION_1_0`.
The patch version number specified is ignored. Only the major and minor versions are considered. The patch version number specified is ignored. Only the major and minor versions are considered.
It must be less or equal (preferably equal) to value as passed to `vkCreateInstance` as `VkApplicationInfo::apiVersion`.
Only versions 1.0, 1.1, 1.2, 1.3 are supported by the current implementation. Only versions 1.0, 1.1, 1.2, 1.3 are supported by the current implementation.
Leaving it initialized to zero is equivalent to `VK_API_VERSION_1_0`. Leaving it initialized to zero is equivalent to `VK_API_VERSION_1_0`.
It must match the Vulkan version used by the application and supported on the selected physical device,
so it must be no higher than `VkApplicationInfo::apiVersion` passed to `vkCreateInstance`
and no higher than `VkPhysicalDeviceProperties::apiVersion` found on the physical device used.
*/ */
uint32_t vulkanApiVersion; uint32_t vulkanApiVersion;
#if VMA_EXTERNAL_MEMORY #if VMA_EXTERNAL_MEMORY