From 825d3d850a82de94bfb97c5db860497d1fb3ff11 Mon Sep 17 00:00:00 2001 From: Alex <28486541+IwakuraRein@users.noreply.github.com> Date: Fri, 10 Jun 2022 09:36:31 +0800 Subject: [PATCH] fix typos --- docs/html/allocation_annotation.html | 2 +- docs/html/group__group__alloc.html | 4 ++-- include/vk_mem_alloc.h | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/html/allocation_annotation.html b/docs/html/allocation_annotation.html index 9a3bde9..9635866 100644 --- a/docs/html/allocation_annotation.html +++ b/docs/html/allocation_annotation.html @@ -71,7 +71,7 @@ $(function() {

Allocation user data

-

You can annotate allocations with your own information, e.g. for debugging purposes. To do that, fill VmaAllocationCreateInfo::pUserData field when creating an allocation. It is an opaque void* pointer. You can use it e.g. as a pointer, some handle, index, key, ordinal number or any other value that would associate the allocation with your custom metadata. It it useful to identify appropriate data structures in your engine given VmaAllocation, e.g. when doing Defragmentation.

+

You can annotate allocations with your own information, e.g. for debugging purposes. To do that, fill VmaAllocationCreateInfo::pUserData field when creating an allocation. It is an opaque void* pointer. You can use it e.g. as a pointer, some handle, index, key, ordinal number or any other value that would associate the allocation with your custom metadata. It is useful to identify appropriate data structures in your engine given VmaAllocation, e.g. when doing Defragmentation.

VkBufferCreateInfo bufCreateInfo = ...
MyBufferMetadata* pMetadata = CreateBufferMetadata();
diff --git a/docs/html/group__group__alloc.html b/docs/html/group__group__alloc.html index dce6a40..5677d77 100644 --- a/docs/html/group__group__alloc.html +++ b/docs/html/group__group__alloc.html @@ -1799,7 +1799,7 @@ Functions
vkDestroyBuffer(device, buffer, allocationCallbacks);
vmaFreeMemory(allocator, allocation);
vmaFreeMemory
void vmaFreeMemory(VmaAllocator allocator, const VmaAllocation allocation)
Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...
-

It it safe to pass null as buffer and/or allocation.

+

It is safe to pass null as buffer and/or allocation.

@@ -1839,7 +1839,7 @@ Functions

This is just a convenience function equivalent to:

vkDestroyImage(device, image, allocationCallbacks);
vmaFreeMemory(allocator, allocation);
-

It it safe to pass null as image and/or allocation.

+

It is safe to pass null as image and/or allocation.

diff --git a/include/vk_mem_alloc.h b/include/vk_mem_alloc.h index 60f5720..52fb947 100644 --- a/include/vk_mem_alloc.h +++ b/include/vk_mem_alloc.h @@ -2360,7 +2360,7 @@ vkDestroyBuffer(device, buffer, allocationCallbacks); vmaFreeMemory(allocator, allocation); \endcode -It it safe to pass null as buffer and/or allocation. +It is safe to pass null as buffer and/or allocation. */ VMA_CALL_PRE void VMA_CALL_POST vmaDestroyBuffer( VmaAllocator VMA_NOT_NULL allocator, @@ -2392,7 +2392,7 @@ vkDestroyImage(device, image, allocationCallbacks); vmaFreeMemory(allocator, allocation); \endcode -It it safe to pass null as image and/or allocation. +It is safe to pass null as image and/or allocation. */ VMA_CALL_PRE void VMA_CALL_POST vmaDestroyImage( VmaAllocator VMA_NOT_NULL allocator, @@ -18555,7 +18555,7 @@ To do that, fill VmaAllocationCreateInfo::pUserData field when creating an allocation. It is an opaque `void*` pointer. You can use it e.g. as a pointer, some handle, index, key, ordinal number or any other value that would associate the allocation with your custom metadata. -It it useful to identify appropriate data structures in your engine given #VmaAllocation, +It is useful to identify appropriate data structures in your engine given #VmaAllocation, e.g. when doing \ref defragmentation. \code