From 1e0ab38aa837d4a8a5204d2538930fbddb6522c3 Mon Sep 17 00:00:00 2001 From: Max Rodriguez Date: Mon, 25 Jul 2022 15:04:39 -0700 Subject: [PATCH 1/3] quick_start.html: Small grammar fix under 'Selecting Vulkan version' section --- docs/html/quick_start.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html index 3b25570..c875f98 100644 --- a/docs/html/quick_start.html +++ b/docs/html/quick_start.html @@ -94,7 +94,7 @@ Initialization

Only members physicalDevice, device, instance are required. However, you should inform the library which Vulkan version do you use by setting VmaAllocatorCreateInfo::vulkanApiVersion and which extensions did you enable by setting VmaAllocatorCreateInfo::flags (like VMA_ALLOCATOR_CREATE_BUFFER_DEVICE_ADDRESS_BIT for VK_KHR_buffer_device_address). Otherwise, VMA would use only features of Vulkan 1.0 core with no extensions.

Selecting Vulkan version

-

VMA supports Vulkan version down to 1.0, for backward compatibility. If you want to use higher version, you need to inform the library about it. This is a two-step proces.

+

VMA supports Vulkan version down to 1.0, for backward compatibility. If you want to use higher version, you need to inform the library about it. This is a two-step process.

Step 1: Compile time. By default, VMA compiles with code supporting the highest Vulkan version found in the included <vulkan/vulkan.h> that is also supported by the library. If this is OK, you don't need to do anything. However, if you want to compile VMA as if only some lower Vulkan version was available, define macro VMA_VULKAN_VERSION before every #include "vk_mem_alloc.h". It should have decimal numeric value in form of ABBBCCC, where A = major, BBB = minor, CCC = patch Vulkan version. For example, to compile against Vulkan 1.2:

#define VMA_VULKAN_VERSION 1002000 // Vulkan 1.2
#include "vk_mem_alloc.h"
From 919c40ee39136f70239be42fb6e299dd1c4d0203 Mon Sep 17 00:00:00 2001 From: Max Rodriguez Date: Tue, 26 Jul 2022 11:43:21 -0700 Subject: [PATCH 2/3] Revert "quick_start.html: Small grammar fix under 'Selecting Vulkan version' section" This reverts commit 1e0ab38aa837d4a8a5204d2538930fbddb6522c3. --- docs/html/quick_start.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html index c875f98..3b25570 100644 --- a/docs/html/quick_start.html +++ b/docs/html/quick_start.html @@ -94,7 +94,7 @@ Initialization

Only members physicalDevice, device, instance are required. However, you should inform the library which Vulkan version do you use by setting VmaAllocatorCreateInfo::vulkanApiVersion and which extensions did you enable by setting VmaAllocatorCreateInfo::flags (like VMA_ALLOCATOR_CREATE_BUFFER_DEVICE_ADDRESS_BIT for VK_KHR_buffer_device_address). Otherwise, VMA would use only features of Vulkan 1.0 core with no extensions.

Selecting Vulkan version

-

VMA supports Vulkan version down to 1.0, for backward compatibility. If you want to use higher version, you need to inform the library about it. This is a two-step process.

+

VMA supports Vulkan version down to 1.0, for backward compatibility. If you want to use higher version, you need to inform the library about it. This is a two-step proces.

Step 1: Compile time. By default, VMA compiles with code supporting the highest Vulkan version found in the included <vulkan/vulkan.h> that is also supported by the library. If this is OK, you don't need to do anything. However, if you want to compile VMA as if only some lower Vulkan version was available, define macro VMA_VULKAN_VERSION before every #include "vk_mem_alloc.h". It should have decimal numeric value in form of ABBBCCC, where A = major, BBB = minor, CCC = patch Vulkan version. For example, to compile against Vulkan 1.2:

#define VMA_VULKAN_VERSION 1002000 // Vulkan 1.2
#include "vk_mem_alloc.h"
From b367bf3b87da24ef6a5dc503b8036175c20871ea Mon Sep 17 00:00:00 2001 From: Max Rodriguez Date: Tue, 26 Jul 2022 11:44:54 -0700 Subject: [PATCH 3/3] docs: Fixed a typo under 'Selecting Vulkan version' section --- include/vk_mem_alloc.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/vk_mem_alloc.h b/include/vk_mem_alloc.h index bdb4ff5..5a784d4 100644 --- a/include/vk_mem_alloc.h +++ b/include/vk_mem_alloc.h @@ -17596,7 +17596,7 @@ Otherwise, VMA would use only features of Vulkan 1.0 core with no extensions. VMA supports Vulkan version down to 1.0, for backward compatibility. If you want to use higher version, you need to inform the library about it. -This is a two-step proces. +This is a two-step process. Step 1: Compile time. By default, VMA compiles with code supporting the highest Vulkan version found in the included `` that is also supported by the library.