Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

CommandBuffer.SetRenderTarget

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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 function SetRenderTarget(rt: Rendering.RenderTargetIdentifier): void;
public void SetRenderTarget(Rendering.RenderTargetIdentifier rt);
public function SetRenderTarget(color: Rendering.RenderTargetIdentifier, depth: Rendering.RenderTargetIdentifier): void;
public function SetRenderTarget(colors: RenderTargetIdentifier[], depth: Rendering.RenderTargetIdentifier): void;
public void SetRenderTarget(RenderTargetIdentifier[] colors, Rendering.RenderTargetIdentifier depth);

Parameters

rt Render target to set for both color & depth buffers.
color Render target to set as a color buffer.
colors Render targets to set as color buffers (MRT).
depth Render target to set as a depth buffer.

Description

Add a "set active render target" command.

Render texture to use can be indicated in several ways: a RenderTexture object, a temporary render texture created with GetTemporaryRT, or one of built-in temporary textures (BuiltinRenderTextureType). All that is expressed by a RenderTargetIdentifier struct, which has implicit conversion operators to save on typing.

You do not explicitly need to preserve active render targets during command buffer execution (current render targets are saved & restored afterwards).

See Also: GetTemporaryRT, ClearRenderTarget, Blit, RenderTargetIdentifier.