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.
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)
public void Clear ( ClearOptions options, Color color, float depth, int stencil, Rectangle regions )
- Flags that indicate which surfaces to clear.
- Color value to which the render target surface is cleared.
- 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.
- 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.
- The regions to clear.
|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.|