AuroraMiddleware/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator synced 2024-11-27 22:40:06 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #286 from laurelkeys/patch-1

Browse Source 
Fix minor typos in documentation
This commit is contained in:
Adam Sawicki 2022-09-08 10:02:05 +02:00 committed by GitHub
commit e4057da74f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/vk_mem_alloc.h
View File

@ -3031,7 +3031,7 @@ Mapping hysteresis is a logic that launches when vmaMapMemory/vmaUnmapMemory is
or a persistently mapped allocation is created and destroyed several times in a row. or a persistently mapped allocation is created and destroyed several times in a row.
It keeps additional +1 mapping of a device memory block to prevent calling actual It keeps additional +1 mapping of a device memory block to prevent calling actual
vkMapMemory/vkUnmapMemory too many times, which may improve performance and help vkMapMemory/vkUnmapMemory too many times, which may improve performance and help
tools like RenderDOc. tools like RenderDoc.
*/ */
#ifndef VMA_MAPPING_HYSTERESIS_ENABLED #ifndef VMA_MAPPING_HYSTERESIS_ENABLED
#define VMA_MAPPING_HYSTERESIS_ENABLED 1 #define VMA_MAPPING_HYSTERESIS_ENABLED 1
@ -17831,7 +17831,7 @@ so you can map it.
For example, a staging buffer that will be filled via mapped pointer and then For example, a staging buffer that will be filled via mapped pointer and then
used as a source of transfer to the buffer described previously can be created like this. used as a source of transfer to the buffer described previously can be created like this.
It will likely and up in a memory type that is `HOST_VISIBLE` and `HOST_COHERENT` It will likely end up in a memory type that is `HOST_VISIBLE` and `HOST_COHERENT`
but not `HOST_CACHED` (meaning uncached, write-combined) and not `DEVICE_LOCAL` (meaning system RAM). but not `HOST_CACHED` (meaning uncached, write-combined) and not `DEVICE_LOCAL` (meaning system RAM).
\code \code
@ -19074,7 +19074,7 @@ to decrease chances to be evicted to system memory by the operating system.
\section usage_patterns_staging_copy_upload Staging copy for upload \section usage_patterns_staging_copy_upload Staging copy for upload
<b>When:</b> <b>When:</b>
A "staging" buffer than you want to map and fill from CPU code, then use as a source od transfer A "staging" buffer than you want to map and fill from CPU code, then use as a source of transfer
to some GPU resource. to some GPU resource.
<b>What to do:</b> <b>What to do:</b>
@ -19141,7 +19141,7 @@ const float* downloadedData = (const float*)allocInfo.pMappedData;
\section usage_patterns_advanced_data_uploading Advanced data uploading \section usage_patterns_advanced_data_uploading Advanced data uploading
For resources that you frequently write on CPU via mapped pointer and For resources that you frequently write on CPU via mapped pointer and
freqnently read on GPU e.g. as a uniform buffer (also called "dynamic"), multiple options are possible: frequently read on GPU e.g. as a uniform buffer (also called "dynamic"), multiple options are possible:
-# Easiest solution is to have one copy of the resource in `HOST_VISIBLE` memory, -# Easiest solution is to have one copy of the resource in `HOST_VISIBLE` memory,
even if it means system RAM (not `DEVICE_LOCAL`) on systems with a discrete graphics card, even if it means system RAM (not `DEVICE_LOCAL`) on systems with a discrete graphics card,