GpuBuffer Class


GpuBuffer Class

GpuBuffer represents a buffer in the graphics card's memory.

Inheritance Hierarchy

SystemObject
  Ab4d.SharpEngine.CoreComponentBase
    Ab4d.SharpEngine.CoreGpuDeviceComponent
      Ab4d.SharpEngine.CoreGpuBuffer
        Ab4d.SharpEngine.CoreGpuStagingBuffer

Namespace: Ab4d.SharpEngine.Core
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.0.9208+3b2441d6a11f923f2600f40f4296bdc3d8b46035

Syntax

Copy

public class GpuBuffer : GpuDeviceComponent, IDisposable

The GpuBuffer type exposes the following members.

Constructors

	Name	Description
	GpuBuffer(VulkanDevice, BufferCreateInfo, MemoryPropertyFlags, Type, Int32, Boolean, Boolean, String)	Constructor
	GpuBuffer(VulkanDevice, Buffer, VulkanMemoryInfo, UInt32, Type, Int32, QueueFlags, Boolean, String)	Constructor
	GpuBuffer(VulkanDevice, Int64, BufferUsageFlags, QueueFlags, MemoryPropertyFlags, Type, Int32, Boolean, Boolean, String)	Constructor

Top

Properties

	Name	Description
	AllocatedMemorySize	Gets the size of the allocated memory in bytes. This value can be bigger then the BufferSize.
	Buffer	Gets the Vulkan Buffer
	BufferMemory	Gets the VulkanMemoryInfo that represents the memory location of the buffer
	BufferSize	Gets the size of the buffer in bytes. This represents the amount of memory required to store the ItemsCount * sizeof(ItemType). This value can be smaller than the size of actually allocated memory (AllocatedMemorySize). When using vkCmdCopyBuffer, we need to specify this value and not AllocatedMemorySize.
	IsDataWritePostponed	True when some data is not yet written to this GpuBuffer because the data will be copied in the background thread or in the GpuStagingBuffer to be executed in a batch.
	IsHostVisible	True if buffer can be accessed from the CPU (MemoryPropertyFlags have HostVisible flag).
	IsMapped	True if buffer is currently mapped (GetMappedMemoryPtr or GetMappedMemorySpan methods were called).
	IsNonCoherentMemory	True if buffer is using non-coherent memory that needs to be manually invalidated or flashed (MemoryPropertyFlags has HostVisible flag but not HostCoherent flag).
	IsPersistentlyMapped	True if buffer is persistently mapped.
	ItemsCount	Gets the number of items of type (ItemType) in this buffer.
	ItemType	Gets the type of each item in this buffer.
	QueueFamilies	Gets the Queue families that can be used for this buffer.

Top

Methods

	Name	Description
	CopyToBuffer	CopyToBuffer copies this buffer to the destinationBuffer and waits for the copy operation to finish. When size is not defined (is zero), then size of the smaller buffer is used.
	Dispose	Dispose
	Dispose(Boolean)	Dispose (Overrides ComponentBaseDispose(Boolean))
	GetMappedMemoryPtr	Returns an IntPtr of the mapped memory. The IntPtr can be used to get the content of the buffer or to copy new content to that location. After using the memory call UnmapMemory method.
	GetMappedMemoryPtr(Int64, Int64)	Returns an IntPtr of the mapped memory with specified offset and size. The IntPtr can be used to get the content of the buffer or to copy new content to that location. After using the memory call UnmapMemory method.
	GetMappedMemorySpanT	Returns a Span that can be used to get the content of the buffer or copy new content to that location. After using the memory call UnmapMemory method.
	GetMappedMemorySpanT(Void, T)
	ReadFromBufferT	Returns the read T from the buffer.
	ReadFromBufferT(Int32)	Returns the read T from the buffer at the specified offset.
	ReadFromBufferT(T)	Reads the content of this buffer to the specified array. If the array is smaller than this buffer, then only the data with the size of the array are copied. If the buffer is smaller than the array, then the whole buffer will be copied to the start of the array.
	ReadFromBufferT(Span)
	ReadFromBufferT(Span, Void)
	ReadFromBufferT(T, Int32, Int32)	Reads the dataItemsCount items from this buffer, starting from the bufferDataOffset (specified in absolute bytes offset not as items count). The data are read to the specified array.
	ToString	(Overrides ObjectToString)
	UnmapMemory	Unmaps the memory that was mapped by calling GetMappedMemoryPtr.
	WriteToBufferT(Span)
	WriteToBufferT(T)	Writes the specified data to this buffer.
	WriteToBufferT(T)	Writes the specified data to this buffer.
	WriteToBufferT(T, Int32)	Writes the specified data to this buffer. The data is written to the bufferDataOffset location in this buffer (specified in absolute bytes offset not as items count).
	WriteToBufferT(Span, Void)
	WriteToBufferT(T, Int32, Int32)	Writes the dataLength items to this buffer. Writing starting at the bufferDataOffset location in this buffer (specified in absolute bytes offset not as items count).
	WriteToBufferAsyncT(T)
	WriteToBufferAsyncT(T, ActionGpuBuffer)

Top

Fields

	Name	Description
	AlwaysAllowCopyFromGpuBuffer	Gets or sets a static Boolean that specifies if GpuBuffers are always created with usage mode that allows copying data from the buffer to another buffer (this adds TransferSrc to BufferUsageFlags). Default value is false. This can be set to true for testing the content of the buffers.

Top

Reference

Ab4d.SharpEngine.Core Namespace