AuroraMiddleware/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator synced 2024-11-05 12:20:07 +00:00
Code Issues Projects Releases Wiki Activity

Minor fixes in documentation.

Browse Source
This commit is contained in:
Adam Sawicki 2018-12-13 12:15:01 +01:00
parent bdb89a93eb
commit 663b0c9567
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/html/defragmentation.html
View File

File diff suppressed because one or more lines are too long

6
src/vk_mem_alloc.h
View File

@ -799,7 +799,7 @@ for(uint32_t i = 0; i < allocCount; ++i)
} }
\endcode \endcode
Filling VmaDefragmentationInfo2::pAllocationsChanged is optional. Setting VmaDefragmentationInfo2::pAllocationsChanged is optional.
This output array tells whether particular allocation in VmaDefragmentationInfo2::pAllocations at the same index This output array tells whether particular allocation in VmaDefragmentationInfo2::pAllocations at the same index
has been modified during defragmentation. has been modified during defragmentation.
You can pass null, but you then need to query every allocation passed to defragmentation You can pass null, but you then need to query every allocation passed to defragmentation
@ -914,13 +914,13 @@ but it is not exposed through the library API - you need to hack its source code
Here are steps needed to do this: Here are steps needed to do this:
-# Main thing you need to do is to define your own class derived from base abstract -# Main thing you need to do is to define your own class derived from base abstract
class `VmaDefragmentationAlgorithm` and implement your version of its pure virtual method. class `VmaDefragmentationAlgorithm` and implement your version of its pure virtual methods.
See definition and comments of this class for details. See definition and comments of this class for details.
-# Your code needs to interact with device memory block metadata. -# Your code needs to interact with device memory block metadata.
If you need more access to its data than it's provided by its public interface, If you need more access to its data than it's provided by its public interface,
declare your new class as a friend class e.g. in class `VmaBlockMetadata_Generic`. declare your new class as a friend class e.g. in class `VmaBlockMetadata_Generic`.
-# If you want to create a flag that would enable your algorithm or pass some additional -# If you want to create a flag that would enable your algorithm or pass some additional
flags to configure it, define some enum with such flags and use them in flags to configure it, add them to `VmaDefragmentationFlagBits` and use them in
VmaDefragmentationInfo2::flags. VmaDefragmentationInfo2::flags.
-# Modify function `VmaBlockVectorDefragmentationContext::Begin` to create object -# Modify function `VmaBlockVectorDefragmentationContext::Begin` to create object
of your new class whenever needed. of your new class whenever needed.