Description
The Stencil
field is a member of the ClearFlags
enumeration in the Sandbox namespace. It represents the stencil buffer, which is used in graphics programming to control the drawing of pixels based on certain conditions. This flag can be used to specify that the stencil buffer should be cleared before rendering a scene.
Usage
Use the Stencil
flag when you need to clear the stencil buffer as part of the rendering process. This is typically used in conjunction with other ClearFlags
to ensure that the rendering target is properly prepared for new drawing operations.
Example
// Example of using ClearFlags with a SceneCamera
SceneCamera camera = new SceneCamera();
camera.ClearFlags = ClearFlags.Color | ClearFlags.Depth | ClearFlags.Stencil;
// This will clear the color, depth, and stencil buffers before rendering the scene
camera.Render();