Click or drag to resize
Ab4d.SharpEngine logo

GpuBuffer Class

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

Namespace: Ab4d.SharpEngine.Core
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
Syntax
C#
public class GpuBuffer : GpuDeviceComponent, IDisposable

The GpuBuffer type exposes the following members.

Constructors
Properties
 NameDescription
Public propertyBuffer Gets the Vulkan Buffer
Public propertyBufferMemory Gets the VulkanMemoryInfo that represents the memory location of the buffer
Public propertyBufferSize Gets the size of the buffer in bytes
Public propertyItemsCount Gets the number of items of type (ItemType) in this buffer.
Public propertyItemType Gets the type of each item in this buffer.
Top
Methods
 NameDescription
Public methodDispose Dispose
Protected methodDispose(Boolean) Dispose
(Overrides ComponentBaseDispose(Boolean))
Public methodGetMappedMemoryPtr 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.
Public methodGetMappedMemoryPtr(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.
Public methodGetMappedMemorySpanT 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.
Public methodGetMappedMemorySpanT(Void, T) 
Public methodReadFromBufferT Returns the read T from the buffer.
Public methodReadFromBufferT(Int32) Returns the read T from the buffer at the specified offset.
Public methodReadFromBufferT(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.
Public methodReadFromBufferT(Span) 
Public methodReadFromBufferT(Span, Void) 
Public methodReadFromBufferT(T, Int32, Int32) Reads the dataLength 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.
Public methodToString
(Overrides ObjectToString)
Public methodUnmapMemory Unmaps the memory that was mapped by calling GetMappedMemoryPtr.
Public methodWriteToBufferT(Span) 
Public methodWriteToBufferT(T) Writes the specified data to this buffer.
Public methodWriteToBufferT(T) Writes the specified data to this buffer.
Public methodWriteToBufferT(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).
Public methodWriteToBufferT(Span, Void) 
Public methodWriteToBufferT(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).
Top
Fields
 NameDescription
Public fieldIsPersistentlyMapped True if buffer is persistently mapped.
Top
See Also