Version: 2020.1
LanguageEnglish
  • C#

ComputeShader.SetConstantBuffer

Suggest a change

Success!

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

Submission failed

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

Cancel

Switch to Manual
public void SetConstantBuffer(int nameID, ComputeBuffer buffer, int offset, int size);

Parameters

nameID The ID of the property name for the constant buffer in shader code. Use Shader.PropertyToID to get this ID.
buffer The buffer to bind as constant buffer.
offset The offset in bytes from the beginning of the ComputeBuffer to bind. Must be a multiple of SystemInfo.MinConstantBufferAlignment, or 0 if that value is 0.
size The number of bytes to bind.

Description

Sets a ComputeBuffer as a named constant buffer for the ComputeShader.

Use this method to override all of the shader parameters in the given constant buffer with the contents of the given ComputeBuffer.

To use this method, the following must be true:

The ComputeBuffer must have been created with a ComputeBufferType.Constant flag. The data layout of the constant buffer must match exactly with the data provided in the ComputeBuffer. All the different shader variants for this Material must use the same constant buffer layout for the given constant buffer.

If the obove conditions are not met the buffer might not be bound correctly and so regular parameters will be picked up. Alternatively visual artifacts might occur.

After this function has been called with a non-null ComputeBuffer, you can no longer manually set the value of a variable inside the overridden constant buffer. Calls to ComputeShader.SetFloat and similar where the given property name ID points to a variable inside the overridden constant buffer will have no effect.

Constant buffers are bound to all kernels in a ComputeShader.

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