From 67bf13cd085e6eaee0d5a0167b9ed30ea3194443 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Do=C4=9Fukan=20Korkmazt=C3=BCrk?= Date: Mon, 27 Jul 2020 23:48:55 -0400 Subject: [PATCH] Fix a typo in the explanation of VMA_ALLOCATION_CREATE_MAPPED_BIT --- docs/html/vk__mem__alloc_8h.html | 2 +- src/vk_mem_alloc.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/html/vk__mem__alloc_8h.html b/docs/html/vk__mem__alloc_8h.html index f0a0d00..ef09f0f 100644 --- a/docs/html/vk__mem__alloc_8h.html +++ b/docs/html/vk__mem__alloc_8h.html @@ -1069,7 +1069,7 @@ Functions VMA_ALLOCATION_CREATE_MAPPED_BIT 

Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.

Pointer to mapped memory will be returned through VmaAllocationInfo::pMappedData.

-

Is it valid to use this flag for allocation made from memory type that is not HOST_VISIBLE. This flag is then ignored and memory is not mapped. This is useful if you need an allocation that is efficient to use on GPU (DEVICE_LOCAL) and still want to map it directly if possible on platforms that support it (e.g. Intel GPU).

+

It is valid to use this flag for allocation made from memory type that is not HOST_VISIBLE. This flag is then ignored and memory is not mapped. This is useful if you need an allocation that is efficient to use on GPU (DEVICE_LOCAL) and still want to map it directly if possible on platforms that support it (e.g. Intel GPU).

You should not use this flag together with VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT.

VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT 

Allocation created with this flag can become lost as a result of another allocation with VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT flag, so you must check it before use.

diff --git a/src/vk_mem_alloc.h b/src/vk_mem_alloc.h index 5a1f2da..33b6db4 100644 --- a/src/vk_mem_alloc.h +++ b/src/vk_mem_alloc.h @@ -2644,7 +2644,7 @@ typedef enum VmaAllocationCreateFlagBits { Pointer to mapped memory will be returned through VmaAllocationInfo::pMappedData. - Is it valid to use this flag for allocation made from memory type that is not + It is valid to use this flag for allocation made from memory type that is not `HOST_VISIBLE`. This flag is then ignored and memory is not mapped. This is useful if you need an allocation that is efficient to use on GPU (`DEVICE_LOCAL`) and still want to map it directly if possible on platforms that