Fix documentation to state that VmaAllocatorCreateInfo::instance is now required

Compatibility breaking!
Closes #107
This commit is contained in:
Adam Sawicki 2020-03-24 15:58:45 +01:00
parent 297639774c
commit 204a810449

View File

@ -2214,10 +2214,9 @@ typedef struct VmaAllocatorCreateInfo
creation of the allocator object fails with `VK_ERROR_FEATURE_NOT_PRESENT`. creation of the allocator object fails with `VK_ERROR_FEATURE_NOT_PRESENT`.
*/ */
const VmaRecordSettings* pRecordSettings; const VmaRecordSettings* pRecordSettings;
/** \brief Optional handle to Vulkan instance object. /** \brief Handle to Vulkan instance object.
Optional, can be null. Must be set if #VMA_ALLOCATOR_CREATE_EXT_MEMORY_BUDGET_BIT flas is used Starting from version 3.0.0 this member is no longer optional, it must be set!
or if `vulkanApiVersion >= VK_MAKE_VERSION(1, 1, 0)`.
*/ */
VkInstance instance; VkInstance instance;
/** \brief Optional. The highest version of Vulkan that the application is designed to use. /** \brief Optional. The highest version of Vulkan that the application is designed to use.
@ -15085,7 +15084,7 @@ VmaAllocator_T::VmaAllocator_T(const VmaAllocatorCreateInfo* pCreateInfo) :
VMA_ASSERT(VMA_DEBUG_MARGIN % sizeof(uint32_t) == 0); VMA_ASSERT(VMA_DEBUG_MARGIN % sizeof(uint32_t) == 0);
} }
VMA_ASSERT(pCreateInfo->physicalDevice && pCreateInfo->device); VMA_ASSERT(pCreateInfo->physicalDevice && pCreateInfo->device && pCreateInfo->instance);
if(m_VulkanApiVersion < VK_MAKE_VERSION(1, 1, 0)) if(m_VulkanApiVersion < VK_MAKE_VERSION(1, 1, 0))
{ {