Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Graphics.SetRandomWriteTarget

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

public static function SetRandomWriteTarget(index: int, uav: ComputeBuffer, preserveCounterValue: bool = false): void;
public static void SetRandomWriteTarget(int index, ComputeBuffer uav, bool preserveCounterValue = false);
public static function SetRandomWriteTarget(index: int, uav: RenderTexture): void;
public static void SetRandomWriteTarget(int index, RenderTexture uav);

Parameters

index Index of the random write target in the shader.
uav RenderTexture to set as write target.
preserveCounterValue Whether to leave the append/consume counter value unchanged.

Description

Set random write target for Shader Model 5.0 level pixel shaders.

Shader Model 5.0 level pixel shaders can write into arbitrary locations of some textures and buffers, called "unordered access views" (UAV) in UsingDX11GL3Features. These "random write" targets are set similarly to how multiple render targets are set. You can either use a RenderTexture with enableRandomWrite flag set, or a ComputeBuffer as target.

The UAV indexing varies a bit between different platforms. On DX11 the first valid UAV index is the number of active render targets. So the common case of single render target the UAV indexing will start from 1. OpenGL ES 3.1 matches this behaviour when using translated HLSL shaders. However, with hand-written GLSL shaders the indexes will match the bindings. On PS4 the indexing starts always from 1 to match the most common case.

When setting a ComputeBuffer, the preserveCounterValue parameter indicates whether to leave the counter value unchanged, or reset it to 0 (the default behaviour).

The targets stay set until you manually clear them with ClearRandomWriteTargets.

See Also: RenderTexture.enableRandomWrite, ComputeBuffer, ComputeBuffer.SetCounterValue, UsingDX11GL3Features.