Skip to content

Commit 187206f

Browse files
committed
Fix documentation typos
List of typos: - 'license' -> 'license' - 'ofsets' -> 'offsets' - 'instrinsics' -> 'intrinsics' - 'becase' -> 'because' - 'availeble' -> 'available' - 'mesure' -> 'measure' - 'parametrs' -> 'parameters' Signed-off-by: Luiz G. Mugnaini A. <luizmugnaini@gmail.com>
1 parent 5677097 commit 187206f

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ See **[Documentation](https://gpuopen-librariesandsdks.github.io/VulkanMemoryAll
171171
- **[PowerVR SDK](https://github.com/powervr-graphics/Native_SDK)** - C++ cross-platform 3D graphics SDK, from Imagination. License: MIT.
172172
- **[Skia](https://github.com/google/skia)** - complete 2D graphic library for drawing Text, Geometries, and Images, from Google.
173173
- **[The Forge](https://github.com/ConfettiFX/The-Forge)** - cross-platform rendering framework. Apache License 2.0.
174-
- **[VK9](https://github.com/disks86/VK9)** - Direct3D 9 compatibility layer using Vulkan. Zlib lincese.
174+
- **[VK9](https://github.com/disks86/VK9)** - Direct3D 9 compatibility layer using Vulkan. Zlib license.
175175
- **[vkDOOM3](https://github.com/DustinHLand/vkDOOM3)** - Vulkan port of GPL DOOM 3 BFG Edition. License: GNU GPL.
176176
- **[vkQuake2](https://github.com/kondrak/vkQuake2)** - vanilla Quake 2 with Vulkan support. License: GNU GPL.
177177
- **[Vulkan Best Practice for Mobile Developers](https://github.com/ARM-software/vulkan_best_practice_for_mobile_developers)** from ARM. License: MIT.

include/vk_mem_alloc.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2166,7 +2166,7 @@ For more information, see documentation of vmaFlushAllocation().
21662166
\param allocator
21672167
\param allocationCount
21682168
\param allocations
2169-
\param offsets If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero.
2169+
\param offsets If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all offsets are zero.
21702170
\param sizes If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means `VK_WHOLE_SIZE` for all allocations.
21712171

21722172
This function returns the `VkResult` from `vkFlushMappedMemoryRanges` if it is
@@ -2187,7 +2187,7 @@ For more information, see documentation of vmaInvalidateAllocation().
21872187
\param allocator
21882188
\param allocationCount
21892189
\param allocations
2190-
\param offsets If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero.
2190+
\param offsets If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all offsets are zero.
21912191
\param sizes If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means `VK_WHOLE_SIZE` for all allocations.
21922192

21932193
This function returns the `VkResult` from `vkInvalidateMappedMemoryRanges` if it is
@@ -3389,7 +3389,7 @@ class VmaAllocationObjectAllocator;
33893389
/*
33903390
Returns number of bits set to 1 in (v).
33913391

3392-
On specific platforms and compilers you can use instrinsics like:
3392+
On specific platforms and compilers you can use intrinsics like:
33933393

33943394
Visual Studio:
33953395
return __popcnt(v);
@@ -12880,7 +12880,7 @@ VmaAllocator_T::VmaAllocator_T(const VmaAllocatorCreateInfo* pCreateInfo) :
1288012880
GetMemoryTypeMinAlignment(memTypeIndex), // minAllocationAlignment
1288112881
VMA_NULL); // // pMemoryAllocateNext
1288212882
// No need to call m_pBlockVectors[memTypeIndex][blockVectorTypeIndex]->CreateMinBlocks here,
12883-
// becase minBlockCount is 0.
12883+
// because minBlockCount is 0.
1288412884
}
1288512885
}
1288612886
}
@@ -16553,7 +16553,7 @@ You may need to configure importing Vulkan functions. There are 3 ways to do thi
1655316553
\subsection quick_start_initialization_enabling_extensions Enabling extensions
1655416554

1655516555
VMA can automatically use following Vulkan extensions.
16556-
If you found them availeble on the selected physical device and you enabled them
16556+
If you found them available on the selected physical device and you enabled them
1655716557
while creating `VkInstance` / `VkDevice` object, inform VMA about their availability
1655816558
by setting appropriate flags in VmaAllocatorCreateInfo::flags.
1655916559

@@ -17332,7 +17332,7 @@ Many of the common concerns can be addressed in a different way than using custo
1733217332
- If you want to keep your allocations of certain size (small versus large) or certain lifetime (transient versus long lived)
1733317333
separate, you likely don't need to.
1733417334
VMA uses a high quality allocation algorithm that manages memory well in various cases.
17335-
Please mesure and check if using custom pools provides a benefit.
17335+
Please measure and check if using custom pools provides a benefit.
1733617336
- If you want to keep your images and buffers separate, you don't need to.
1733717337
VMA respects `bufferImageGranularity` limit automatically.
1733817338
- If you want to keep your mapped and not mapped allocations separate, you don't need to.
@@ -18464,7 +18464,7 @@ vmaCreateImage(allocator, &imgCreateInfo, &allocCreateInfo, &img, &alloc, nullpt
1846418464
`priority` member is ignored in the following situations:
1846518465

1846618466
- Allocations created in custom pools: They inherit the priority, along with all other allocation parameters
18467-
from the parametrs passed in #VmaPoolCreateInfo when the pool was created.
18467+
from the parameters passed in #VmaPoolCreateInfo when the pool was created.
1846818468
- Allocations created in default pools: They inherit the priority from the parameters
1846918469
VMA used when creating default pools, which means `priority == 0.5f`.
1847018470

0 commit comments

Comments
 (0)