Skip to content

Commit 68d5105

Browse files
Fixed documentation of VmaAllocatorCreateInfo::vulkanApiVersion
Fixes #384 - thanks @qbojj
1 parent a0a04a2 commit 68d5105

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

include/vk_mem_alloc.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1074,13 +1074,15 @@ typedef struct VmaAllocatorCreateInfo
10741074
Starting from version 3.0.0 this member is no longer optional, it must be set!
10751075
*/
10761076
VkInstance VMA_NOT_NULL instance;
1077-
/** \brief Optional. The highest version of Vulkan that the application is designed to use.
1077+
/** \brief Optional. Vulkan version that the application uses.
10781078

10791079
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`.
10801080
The patch version number specified is ignored. Only the major and minor versions are considered.
1081-
It must be less or equal (preferably equal) to value as passed to `vkCreateInstance` as `VkApplicationInfo::apiVersion`.
10821081
Only versions 1.0, 1.1, 1.2, 1.3 are supported by the current implementation.
10831082
Leaving it initialized to zero is equivalent to `VK_API_VERSION_1_0`.
1083+
It must match the Vulkan version used by the application and supported on the selected physical device,
1084+
so it must be no higher than `VkApplicationInfo::apiVersion` passed to `vkCreateInstance`
1085+
and no higher than `VkPhysicalDeviceProperties::apiVersion` found on the physical device used.
10841086
*/
10851087
uint32_t vulkanApiVersion;
10861088
#if VMA_EXTERNAL_MEMORY

0 commit comments

Comments
 (0)