GraphicsDevice.Clear Method (ClearOptions, Color, Single, Int32, Rectangle )

Clears a set of regions to a specified color, clears the depth buffer, and erases the stencil buffer.

Namespace: Microsoft.Xna.Framework.Graphics
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)

Syntax

public void Clear (
         ClearOptions options,
         Color color,
         float depth,
         int stencil,
         Rectangle[] regions
)

options
Flags that indicate which surfaces to clear.
color
Color value to which the render target surface is cleared.
depth
New depth value to store in the depth buffer. This parameter can be in the range of 0.0 through 1.0 (for z-based or w-based depth buffers). A value of 0.0 represents the nearest distance to the viewer; a value of 1.0 represents the farthest distance.
stencil
Integer value to store in each stencil-buffer entry. This parameter can be in the range of 0 through 2n−1, where n is the bit depth of the stencil buffer.
regions
The regions to clear.

Exception type	Condition
InvalidOperationException	No DepthStencilBuffer surface exists, or the active render target and depth stencil surface do not have the same pixel size and multisampling type. Unable to clear the depth or stencil buffer.
ObjectDisposedException	Clear was called after this GraphicsDevice was disposed.

Xbox 360, Windows XP SP2, Windows Vista