ClearRenderer Class
Namespace: Stride.Rendering.CompositingAssembly: Stride.Rendering.dll
A renderer to clear a render frame.
Derived from ClearRenderer:
[Display("Clear", null)]
public class ClearRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
| Name | Description | |
|---|---|---|
| Constructors | ||
| ClearRenderer() | Initializes a new instance of the ClearRenderer class. |
|
| Properties | ||
| ClearFlags | Gets or sets the clear flags. |
|
| Color | Gets or sets the clear color. |
|
| Depth | Gets or sets the depth value used to clear the depth stencil buffer. |
|
| Stencil | Gets or sets the stencil value used to clear the depth stencil buffer. |
|
| Methods | ||
| DrawCore(RenderContext, RenderDrawContext) | ||
Constructors
ClearRenderer()
Initializes a new instance of the ClearRenderer class.
public ClearRenderer()
Properties
ClearFlags
Gets or sets the clear flags.
[DataMember(10)]
[Display("Clear Flags", null)]
public ClearRendererFlags ClearFlags { get; set; }
Property Value
| Type | Description |
|---|---|
| ClearRendererFlags | The clear flags. |
Color
Gets or sets the clear color.
[DataMember(20)]
[Display("Color", null)]
public Color4 Color { get; set; }
Property Value
| Type | Description |
|---|---|
| Color4 | The clear color. |
Depth
Gets or sets the depth value used to clear the depth stencil buffer.
[DataMember(30)]
[Display("Depth Value", null)]
public float Depth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single | The depth value used to clear the depth stencil buffer. |
Stencil
Gets or sets the stencil value used to clear the depth stencil buffer.
[DataMember(40)]
[Display("Stencil Value", null)]
public byte Stencil { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte | The stencil value used to clear the depth stencil buffer. |
Methods
DrawCore(RenderContext, RenderDrawContext)
protected override void DrawCore(RenderContext context, RenderDrawContext drawContext)
Parameters
| Type | Name | Description |
|---|---|---|
| RenderContext | context | |
| RenderDrawContext | drawContext |