Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

CommandBuffer.SetComputeBufferParam

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

Declaration

public void SetComputeBufferParam(ComputeShader computeShader, int kernelIndex, string name, ComputeBuffer buffer);

Declaration

public void SetComputeBufferParam(ComputeShader computeShader, int kernelIndex, int nameID, ComputeBuffer buffer);

Declaration

public void SetComputeBufferParam(ComputeShader computeShader, int kernelIndex, string name, GraphicsBuffer buffer);

Declaration

public void SetComputeBufferParam(ComputeShader computeShader, int kernelIndex, int nameID, GraphicsBuffer buffer);

Declaration

public void SetComputeBufferParam(ComputeShader computeShader, int kernelIndex, int nameID, GraphicsBufferHandle bufferHandle);

Declaration

public void SetComputeBufferParam(ComputeShader computeShader, int kernelIndex, string name, GraphicsBufferHandle bufferHandle);

Parameters

computeShader ComputeShader to set parameter for.
kernelIndex Which kernel the buffer is being set for. See ComputeShader.FindKernel.
name Name of the buffer variable in shader code.
nameID Property name ID. Use Shader.PropertyToID to get this ID.
buffer Buffer to set.
bufferHandle The handle of the buffer to set.

Description

Adds a command to set an input or output buffer parameter on a ComputeShader.

Buffers and textures are set per-kernel. Use ComputeShader.FindKernel to find kernel index by function name.

Setting a compute buffer to a kernel will leave the append/consume counter value unchanged. To set or reset the value, use ComputeBuffer.SetCounterValue or GraphicsBuffer.SetCounterValue.

Additional resources: DispatchCompute, SetComputeFloatParam, SetComputeFloatParams, SetComputeIntParam, SetComputeIntParams, SetComputeMatrixParam, SetComputeMatrixArrayParam, SetComputeVectorParam, SetComputeVectorArrayParam, SetComputeTextureParam.