class in UnityEngine
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.Close
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.Close
GPU graphics data buffer, for working with geometry or compute shader data.
ComputeShader programs often need to read or write arbitrary data from or to memory buffers, and some rendering algorithms need a lower level access or control over geometry data than what is provided by the Mesh class. You can use
GraphicsBuffer for these cases. You create the buffers from C# scripts, and then fill them with data using either C# scripts or compute shader programs.
A graphics buffer is similar to an array in C#, in that it has a number of elements (count) of the same size (stride). You must supply the intended buffer usage (target) when you create a GraphicsBuffer; for example, you must pass GraphicsBuffer.Target.Index for the buffer to be usable as a geometry index buffer.
When you have finished working with the buffer, you must manually release the GPU memory should be released. You can do this using C# dispose pattern, or by calling Release.
Additional resources: Graphics.RenderPrimitivesIndexed, Graphics.RenderPrimitivesIndexedIndirect, Graphics.CopyBuffer, ComputeShader, Shader.SetGlobalBuffer, Material.SetBuffer.
|The internal handle of this GraphicsBuffer. Only valid until the buffer is disposed of. (Read Only)
|Number of elements in the buffer (Read Only).
|The debug label for the graphics buffer (setter only).
|Size of one element in the buffer. For index buffers, this must be either 2 or 4 bytes (Read Only).
|Target, which specifies the intended target(s) of this GraphicsBuffer (Read Only).
|The flags that specify how this GraphicsBuffer can be used or updated (Read Only).
|Create a Graphics Buffer.
|Read data values from the buffer into an array. The array can only use blittable types.
|Retrieve a native (underlying graphics API) pointer to the buffer.
|Returns true if this graphics buffer is valid, or false otherwise.
|Begins a write operation to the buffer
|Release a Graphics Buffer.
|Sets counter value of append/consume buffer.
|Set the buffer with values from an array.
|Ends a write operation to the buffer
|Copy the counter value of a GraphicsBuffer into another buffer.