ComputeBuffer

class in UnityEngine

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.

Properties

count	Number of elements in the buffer (Read Only).
name	The debug label for the ComputeBuffer. This name shows up in profiling and frame debugger tools, wherever supported.
stride	Size of one element in the buffer (Read Only).

Constructors

ComputeBuffer

Create a Compute Buffer.

Public Methods

GetData	Read data values from the buffer into an array. The array can only use blittable types.
GetNativeBufferPtr	Retrieve a native (underlying graphics API) pointer to the buffer.
IsValid	Returns true if this compute buffer is valid and false otherwise.
Release	Release a Compute Buffer.
SetCounterValue	Sets counter value of append/consume buffer.
SetData	Set the buffer with values from an array.

Static Methods

CopyCount

Copy counter value of append/consume buffer into another buffer.

Did you find this page useful? Please give it a rating:

Report a problem on this page

Scripting API

ComputeBuffer

Success!

Submission failed

Description

Properties

Constructors

Public Methods

Static Methods