SetRandomWriteTarget
Set random write target for Shader Model 4.5 level pixel shaders.
Read time 4 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
SetRandomWriteTarget(int, RenderTexture)
Set random write target for Shader Model 4.5 level pixel shaders.
public static void SetRandomWriteTarget(int index, RenderTexture uav)
Parameters
The index of the random write target.
Buffer or texture to set as the write target.
Remarks
Shader Model 4.5 and above 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 flag set, or a ComputeBuffer as target.
enableRandomWriteOffset the index value given to by adding the number of render targets used. This value might not correspond exactly to the fixed register index set in the shaders as the UAV indexing value can vary between different platforms. Refer to the platform-specific documentation for details of these differences. On DX11, the first valid UAV index is the number of active render targets, so in the common case of a single render target, the UAV indexing will start from 1. Platforms using automatically translated HLSL shaders will match this behavior, however, with hand-written GLSL shaders the indexes will match the bindings.
SetRandomWriteTargetWhen setting a ComputeBuffer, the parameter indicates whether to leave the counter value unchanged, or reset it to 0 (the default behaviour).
preserveCounterValueThe targets stay set until you manually clear them with Graphics.ClearRandomWriteTargets. It is best practice to call ClearRandomWriteTargets after your rendering is complete. If you do not do this, rendering issues can occur and some built-in Unity rendering passes may crash.
Additional Resources: RenderTexture.enableRandomWrite, ComputeBuffer, ComputeBuffer.SetCounterValue, UsingDX11GL3Features.
SetRandomWriteTarget(int, ComputeBuffer, bool)
Set random write target for Shader Model 4.5 level pixel shaders.
public static void SetRandomWriteTarget(int index, ComputeBuffer uav, bool preserveCounterValue)
Parameters
The index of the random write target.
Buffer or texture to set as the write target.
Whether to leave the append/consume counter value unchanged.
Remarks
Shader Model 4.5 and above 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 flag set, or a ComputeBuffer as target.
enableRandomWriteOffset the index value given to by adding the number of render targets used. This value might not correspond exactly to the fixed register index set in the shaders as the UAV indexing value can vary between different platforms. Refer to the platform-specific documentation for details of these differences. On DX11, the first valid UAV index is the number of active render targets, so in the common case of a single render target, the UAV indexing will start from 1. Platforms using automatically translated HLSL shaders will match this behavior, however, with hand-written GLSL shaders the indexes will match the bindings.
SetRandomWriteTargetWhen setting a ComputeBuffer, the parameter indicates whether to leave the counter value unchanged, or reset it to 0 (the default behaviour).
preserveCounterValueThe targets stay set until you manually clear them with Graphics.ClearRandomWriteTargets. It is best practice to call ClearRandomWriteTargets after your rendering is complete. If you do not do this, rendering issues can occur and some built-in Unity rendering passes may crash.
Additional Resources: RenderTexture.enableRandomWrite, ComputeBuffer, ComputeBuffer.SetCounterValue, UsingDX11GL3Features.
SetRandomWriteTarget(int, GraphicsBuffer, bool)
Set random write target for Shader Model 4.5 level pixel shaders.
public static void SetRandomWriteTarget(int index, GraphicsBuffer uav, bool preserveCounterValue)
Parameters
The index of the random write target.
Buffer or texture to set as the write target.
Whether to leave the append/consume counter value unchanged.
Remarks
Shader Model 4.5 and above 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 flag set, or a ComputeBuffer as target.
enableRandomWriteOffset the index value given to by adding the number of render targets used. This value might not correspond exactly to the fixed register index set in the shaders as the UAV indexing value can vary between different platforms. Refer to the platform-specific documentation for details of these differences. On DX11, the first valid UAV index is the number of active render targets, so in the common case of a single render target, the UAV indexing will start from 1. Platforms using automatically translated HLSL shaders will match this behavior, however, with hand-written GLSL shaders the indexes will match the bindings.
SetRandomWriteTargetWhen setting a ComputeBuffer, the parameter indicates whether to leave the counter value unchanged, or reset it to 0 (the default behaviour).
preserveCounterValueThe targets stay set until you manually clear them with Graphics.ClearRandomWriteTargets. It is best practice to call ClearRandomWriteTargets after your rendering is complete. If you do not do this, rendering issues can occur and some built-in Unity rendering passes may crash.
Additional Resources: RenderTexture.enableRandomWrite, ComputeBuffer, ComputeBuffer.SetCounterValue, UsingDX11GL3Features.