Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Clear

Clear the current render buffer.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

Clear(bool, bool, Color, float)

Clear the current render buffer.
public static void Clear(bool clearDepth, bool clearColor, Color backgroundColor, float depth)

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 the z-buffer with, used only if clearDepth is true. The valid range is from 0 (near plane) to 1 (far plane). The value is graphics API agnostic: the abstraction layer will convert the value to match the convention of the current graphics API.

Remarks

This clears the screen or the active RenderTexture you are drawing into. The cleared area is limited by the active viewport. This operation might alter the model/view/projection matrices.
In most cases, a Camera will already be configured to clear the screen or RenderTexture and you will not need to perform this operation manually.
Additional Resources: GL.ClearWithSkybox.

Clear(bool, bool, Color)

Clear the current render buffer.
public static void Clear(bool clearDepth, bool clearColor, Color backgroundColor)

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.

Remarks

This clears the screen or the active RenderTexture you are drawing into. The cleared area is limited by the active viewport. This operation might alter the model/view/projection matrices.
In most cases, a Camera will already be configured to clear the screen or RenderTexture and you will not need to perform this operation manually.
Additional Resources: GL.ClearWithSkybox.