ComputeBuffer

class in UnityEngine

Switch to Manual

Description

GPU data buffer, mostly for use with compute shaders.

ComputeShader programs often need arbitrary data to be read & written into memory buffers. ComputeBuffer class is exactly for that - you can create & fill them from script code, and use them in compute shaders or regular shaders.

Compute buffers are always supported in compute shaders. Compute shader support can be queried runtime using SystemInfo.supportsComputeShaders. See the Compute Shaders Manual page for more information about platforms supporting compute shaders. In regular graphics shaders the compute buffer support requires minimum shader model 4.5.

On the shader side, ComputeBuffers with default ComputeBufferType map to StructuredBuffer<T> and RWStructuredBuffer<T> in HLSL.

See Also: ComputeShader class, Shader.SetGlobalBuffer, Material.SetBuffer, Compute Shaders overview.

Variables

countNumber of elements in the buffer (Read Only).
nameThe debug label for the ComputeBuffer. This name shows up in profiling and frame debugger tools, wherever supported.
strideSize of one element in the buffer (Read Only).

Constructors

ComputeBufferCreate a Compute Buffer.

Public Functions

GetDataRead data values from the buffer into an array. The array can only use blittable types.
GetNativeBufferPtrRetrieve a native (underlying graphics API) pointer to the buffer.
IsValidReturns true if this compute buffer is valid and false otherwise.
ReleaseRelease a Compute Buffer.
SetCounterValueКопирует значение счетчика добавления/извлечения буфера в другой буфер.
SetDataSet the buffer with values from an array.

Static Functions

CopyCountКопирует значение счетчика добавления/извлечения буфера в другой буфер.