Version: 2022.3
LanguageEnglish
  • C#

ComputeShader.SetTexture

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

Declaration

public void SetTexture(int kernelIndex, string name, Texture texture);

Declaration

public void SetTexture(int kernelIndex, int nameID, Texture texture);

Declaration

public void SetTexture(int kernelIndex, string name, Texture texture, int mipLevel);

Declaration

public void SetTexture(int kernelIndex, int nameID, Texture texture, int mipLevel);

Declaration

public void SetTexture(int kernelIndex, string name, RenderTexture texture, int mipLevel, Rendering.RenderTextureSubElement element);

Declaration

public void SetTexture(int kernelIndex, int nameID, RenderTexture texture, int mipLevel, Rendering.RenderTextureSubElement element);

Parameters

kernelIndex For which kernel the texture is being set. See FindKernel.
nameID Property name ID, use Shader.PropertyToID to get it.
name Name of the buffer variable in shader code.
texture Texture to set.
mipLevel Optional mipmap level of the read-write texture.
element Optional parameter that specifies the type of data to set from the RenderTexture.

Description

Set a texture parameter.

This function can either set a regular texture that is read in the compute shader, or an output texture that is written into by the shader. For an output texture, it has to be a RenderTexture with random write flag enabled, see RenderTexture.enableRandomWrite.

Please note that the mipLevel parameter is ignored unless the shader specifies a read-write (unordered access) texture.

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

By specifying a `RenderTextureSubElement`, you can indicate which type of data to set from the RenderTexture. The possible options are: RenderTextureSubElement.Color, RenderTextureSubElement.Depth, and RenderTextureSubElement.Stencil.

Additional resources: FindKernel, Additional resources: SetFloat, SetFloats, SetInt, SetInts, SetBool, SetBuffer, SetMatrix, SetMatrixArray, SetVector, SetVectorArray., RenderTexture.enableRandomWrite, RenderTextureSubElement.