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

Script language

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

GL.Clear

Other Versions
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 Clear(clearDepth: bool, clearColor: bool, backgroundColor: Color, depth: float = 1.0f): void;
public static void Clear(bool clearDepth, bool clearColor, Color backgroundColor, float depth = 1.0f);

Parameters

clearDepth Should the depth buffer be cleared?
clearColor Should the color buffer be cleared?
backgroundColor The color to clear with, used only if clearColor is true.
depth The depth to clear Z buffer with, used only if clearDepth is true.

Description

Clear the current render buffer.

This clears the screen or the active RenderTexture you are drawing into. In most other situations, some camera is drawing something somewhere, and probably is clearing already with the background color of the skybox.

See Also: GL.ClearWithSkybox.

Leave Feedback

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 © 2017 Unity Technologies. Publication: 5.6-001M. Built: 2017-06-19.
Tutorials Community Answers Knowledge Base Forums Asset Store