Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

CommandBuffer.ClearRenderTarget

Leave feedback
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

Declaration

public void ClearRenderTarget(bool clearDepth, bool clearColor, Color backgroundColor);

Declaration

public void ClearRenderTarget(bool clearDepth, bool clearColor, Color backgroundColor, float depth);

Declaration

public void ClearRenderTarget(bool clearDepth, bool clearColor, Color backgroundColor, float depth, uint stencil);

Declaration

public void ClearRenderTarget(Rendering.RTClearFlags clearFlags, Color backgroundColor, float depth, uint stencil);

Declaration

public void ClearRenderTarget(Rendering.RTClearFlags clearFlags, Color[] backgroundColors, float depth, uint stencil);

Parameters

clearDepth Whether to clear both the depth buffer and the stencil buffer.
clearColor Whether to clear the color buffer.
clearFlags Which render targets to clear, defined using a bitwise OR combination of RTClearFlags values.
backgroundColor Color to clear with.
backgroundColors Colors to clear with.
depth Depth to clear with (default is 1.0).
stencil Stencil to clear with (default is 0).

Description

Adds a "clear render target" command.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2005-2024 Unity Technologies. All rights reserved. Built from: 6000.0.7f1 (7b7d41f2151f). Built on: 2024-06-07.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information