 | |
Vulkan | |
Inheritance HierarchySystem.Object
Ab4d.SharpEngine.Core.ComponentBase
Ab4d.SharpEngine.Core.GpuDeviceComponent
Ab4d.SharpEngine.Utilities.VulkanMemoryAllocator
Ab4d.SharpEngine.Core.ComponentBase
Ab4d.SharpEngine.Core.GpuDeviceComponent
Ab4d.SharpEngine.Utilities.VulkanMemoryAllocator
Namespace: Ab4d.SharpEngine.Utilities
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.0.9208+3b2441d6a11f923f2600f40f4296bdc3d8b46035
SyntaxC#
public class VulkanMemoryAllocator : GpuDeviceComponent, IVulkanMemoryAllocator
The VulkanMemoryAllocator type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CheckMemoryBudget | When true (by default) and when the device supports reading memory budget, then the memory budget is always checked before allocating the memory. |
| InitialBufferMemoryBlockSize | Gets size in bytes that defines the size of the first memory block used for GpuBuffers. The next block that is allocated is twice the size of the previous block. By default this value is set from InitialBufferMemoryBlockSize. User can change this value for this instance of VulkanMemoryAllocator before the first allocation is made. |
| InitialImageMemoryBlockSize | Gets size in bytes that defines the size of the first memory block used for GpuImages. The next block that is allocated is twice the size of the previous block. By default this value is set from InitialImageMemoryBlockSize. User can change this value for this instance of VulkanMemoryAllocator before the first allocation is made. |
| MaxAllocatedMemoryBlockSize | Gets size in bytes that defines the maximum allocated memory block size (except if a bigger memory block is required). The size of blocks that are allocated is doubled each time a block is allocated. This value defines the size after which the allocated size is not doubled anymore. By default this value is set from MaxAllocatedMemoryBlockSize. User can change this value for this instance of VulkanMemoryAllocator. |
| MaxVulkanMemoryAllocationsCount | Returns the maximum number of valid memory allocations that can exist simultaneously within a Device. |
| PeakAllocatedMemory | |
| StoreDisposedAllocationsData | When StoreDisposedAllocationsData is true (false by default), then information about disposed allocations is preserved and is shown in the GetReportString(Boolean, Boolean, Boolean) method. |
| TotalAllocatedMemory | |
| TotalAllocationsCount |
Methods| Name | Description | |
|---|---|---|
 | AllocateMemory(Buffer, MemoryPropertyFlags, Boolean, String) | |
| AllocateMemory(Image, MemoryPropertyFlags, Boolean, String) | |
| AllocateMemory(MemoryRequirements, MemoryPropertyFlags, Boolean, Boolean, String) | |
| AllocateMemory(UInt32, UInt32, Int32, MemoryPropertyFlags, Boolean, Boolean, String) | |
| AllocateMemory(UInt32, UInt32, Int32, MemoryPropertyFlags, Boolean, Boolean, UInt32, String) | |
 | AllocateVulkanMemory | AllocateVulkanMemory is a protected virtual method that calls the vkAllocateMemory function. The method can be overwritten to provide custom allocation logic. |
| Cleanup | Cleanup method checks all memory blocks. Memory block is freed when it is empty and freeEmptyMemoryBlocks is true or when it empty for at least EngineRuntimeOptions.FramesCountToReleaseEmptyMemoryBlock frames. |
 | Create | |
| Dispose | (Overrides ComponentBase.Dispose(Boolean)) |
| DumpMemoryAllocations | Writes string that that describes the allocated memory to the console (when the application is debugged in Visual Studio the string is written to Output window). |
| FreeMemory(VulkanMemoryInfo) | |
| FreeMemory(Int32, UInt32, String) | |
| FreeVulkanMemory | FreeVulkanMemory is a protected virtual method that calls the vkFreeMemory function. The method can be overwritten to provide custom allocation logic. |
| GetNewMemoryBlockSize | GetNewMemoryBlockSize is a protected virtual method that returns the size of the allocated memory block based on the memoryTypeIndex, requestedSize (size of a single allocation that lead to the allocation of new memory block) and allocatedMemoryBlocksForThisMemoryType (number of already allocated memory blocks for this memoryTypeIndex). The method can be overwritten to provide custom size calculation logic. |
| GetReportString | Gets the string that describes the allocated memory. |
See Also