Version: 2018.2 (switch to 2018.3b or 2017.4)
LanguageEnglish
  • C#

Graphics.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

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 void SetRenderTarget(RenderTexture rt, int mipLevel = 0, CubemapFace face = CubemapFace.Unknown, int depthSlice = 0);
public static void SetRenderTarget(RenderBuffer[] colorBuffers, RenderBuffer depthBuffer);
public static void SetRenderTarget(RenderBuffer colorBuffer, RenderBuffer depthBuffer, int mipLevel = 0, CubemapFace face = CubemapFace.Unknown, int depthSlice = 0);
public static void SetRenderTarget(RenderTargetSetup setup);

Parameters

rt RenderTexture to set as active render target.
mipLevelMipmap level to render into (use 0 if not mipmapped).
faceCubemap face to render into (use Unknown if not a cubemap).
depthSliceDepth slice to render into (use 0 if not a 3D or 2DArray render target).
colorBufferColor buffer to render into.
depthBufferDepth buffer to render into.
colorBuffersColor buffers to render into (for multiple render target effects).
setupFull render target setup information.

Description

Sets current render target.

This function sets which RenderTexture or a RenderBuffer combination will be rendered into next. Use it when implementing custom rendering algorithms, where you need to render something into a render texture manually.

Variants with mipLevel and face arguments enable rendering into a specific mipmap level of a render texture, or specific cubemap face of a cubemap RenderTexture. Variants with depthSlice allow rendering into a specific slice of a 3D or 2DArray render texture.

The function call with colorBuffers array enables techniques that use Multiple Render Targets (MRT), where fragment shader can output more than one final color.

Calling SetRenderTarget with just a RenderTexture argument is the same as setting RenderTexture.active property.

Note that in Linear color space, it is important to have the correct sRGB<->Linear color conversion state set. Depending on what was rendered previously, the current state might not be the one you expect. You should consider setting GL.sRGBWrite as you need it before doing SetRenderTarget or any other manual rendering.

See Also: RenderTexture, Graphics.activeColorBuffer, Graphics.activeDepthBuffer, SystemInfo.supportedRenderTargetCount.

Did you find this page useful? Please give it a rating: