s&box docs
API ReferenceSandbox

GpuBufferclass

A GPU data buffer intended for use with a `Sandbox.ComputeShader`. You can read and write arbitrary data to and from the CPU and GPU. This allows for efficient parallel data processing on the GPU. Different GPU buffer types can be used depending on the provided `Sandbox.GpuBuffer.UsageFlags`. Using the default `Sandbox.GpuBuffer.UsageFlags.Structured` type buffers map to StructuredBuffer and RWStructuredBuffer in HLSL.

object→GpuBuffer
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public class Sandbox.GpuBuffer

Constructors2

Showing 2 constructors

Methods12

Showing 12 methods

public void Clear(uint value = 0)PUBLIC

Fills the entire buffer with a repeated uint32 value. Uses the native GPU fill command (vkCmdFillBuffer) — no CPU-side allocation needed.

ParameterTypeDescription
value = 0uintThe uint32 value to fill with. Defaults to zero.
Returns:void—

public void CopyStructureCount(Sandbox.GpuBuffer destBuffer, int destBufferOffset = 0)PUBLIC

For `Sandbox.GpuBuffer.UsageFlags.Append` buffers there is a hidden uint 32-bit atomic counter in the buffer that contains the number of writes to the buffer after invocation of the compute shader. In order to get the value of the counter, the data needs to be copied to another GPU buffer that can be used.

ParameterTypeDescription
destBufferGpuBuffer—
destBufferOffset = 0int—
Returns:void—

public virtual sealed void Dispose()PUBLICVIRTUAL

Destroys the GPU buffer, don't use it no more

Returns:void—

protected virtual override void Finalize()PROTECTEDVIRTUALOVERRIDE

Returns:void—

protected void Initialize(int elementCount, int elementSize, Sandbox.GpuBuffer.UsageFlags usageFlags = 32, string debugName = null)PROTECTED

ParameterTypeDescription
elementCountint—
elementSizeint—
usageFlags = 32UsageFlags—
debugName = nullstring—
Returns:void—

public void SetCounterValue(uint counterValue)PUBLIC

Sets the counter value for `Sandbox.GpuBuffer.UsageFlags.Append` or `Sandbox.GpuBuffer.UsageFlags.Counter` structured buffers.

ParameterTypeDescription
counterValueuint—
Returns:void—

Properties4

Showing 4 properties

public int Sandbox.GpuBuffer.ElementCount { get; set; }PUBLICGETSET

Number of elements in the buffer.

Returns:int—

public int Sandbox.GpuBuffer.ElementSize { get; set; }PUBLICGETSET

Size of a single element in the buffer.

Returns:int—

public virtual sealed bool Sandbox.GpuBuffer.IsValid { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

Related Guides

→Bindless API→GPU Instancing

WithSolidABXY()

Previous Page

ElementCount

Next Page

On this page

Constructorsprotected GpuBuffer()public GpuBuffer(System.Int32 elementCount, System.Int32 elementSize, Sandbox.GpuBuffer.UsageFlags flags = 32, System.String debugName = null)Methodspublic System.Void Clear(System.UInt32 value = 0)public System.Void CopyStructureCount(Sandbox.GpuBuffer destBuffer, System.Int32 destBufferOffset = 0)public virtual sealed System.Void Dispose()protected virtual override System.Void Finalize()public System.Void GetData(System.Span`1<T> data, System.Int32 start, System.Int32 count)public System.Void GetData(System.Span`1<T> data)public System.Void GetDataAsync(System.Action`1<System.ReadOnlySpan`1<T>> callback, System.Int32 start, System.Int32 count)public System.Void GetDataAsync(System.Action`1<System.ReadOnlySpan`1<T>> callback)protected System.Void Initialize(System.Int32 elementCount, System.Int32 elementSize, Sandbox.GpuBuffer.UsageFlags usageFlags = 32, System.String debugName = null)public System.Void SetCounterValue(System.UInt32 counterValue)public System.Void SetData(System.Collections.Generic.List`1<T> data, System.Int32 elementOffset = 0)public System.Void SetData(System.ReadOnlySpan`1<T> data, System.Int32 elementOffset = 0)Propertiespublic System.Int32 Sandbox.GpuBuffer.ElementCount { get; set; }public System.Int32 Sandbox.GpuBuffer.ElementSize { get; set; }public virtual sealed System.Boolean Sandbox.GpuBuffer.IsValid { get; set; }public Sandbox.GpuBuffer.UsageFlags Sandbox.GpuBuffer.Usage { get; set; }Metadata