Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET
Assembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)
Component of render pipeline which cleans up
frame buffer.
Namespace: Visual3D.Graphics3D.StandardPipelineAssembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
| C# | Visual Basic |
public class FrameCleaner : RenderPipelineComponent
Public Class FrameCleaner _ Inherits RenderPipelineComponent
Members
| All Members | Constructors | Fields | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| FrameCleaner()()()() | Initializes a new instance of the FrameCleaner class | |
| FrameCleaner(String) | Initializes a new instance of the FrameCleaner class | |
| AcceptsInput | Gets/sets flag indicate that the component of rendering pipeline accepts
input events from mouse. Default is false.
(Inherited from RenderPipelineComponent.) | |
| AfterRender | This event fires after Render method is called for this component. (Inherited from RenderPipelineComponent.) | |
| BeforeRender | This event fires before Render method is called for this component. (Inherited from RenderPipelineComponent.) | |
| Camera | Gets/sets a camera, which defines viewpoint and view frustrum. (Inherited from RenderPipelineComponent.) | |
| CameraChanged | Fires when Camera was assigned to new value. (Inherited from RenderPipelineComponent.) | |
| ClearAreaRectangles | Gets/sets optional array of rectangles to clear, in pixel units within render target.
Rectangle positions and size will be clipped to viewport bounds. Set to null to clear entire viewport.
Default is null. (Inherited from RenderPipelineComponent.) | |
| ClearColorValue | Gets/sets color to fill render target with, prior to render this component.
Default is Black. Ignored in case if ClearBufferOptions does not contain Target flag,
OR if ClearBufferColorHDR contains non-null reference. (Inherited from RenderPipelineComponent.) | |
| ClearColorValueHDR | Gets/sets HDR color (as Vector4) to fill render target with, prior to render this component.
If contains null value, ClearBufferColor will be used instead (32-bit color).
Default is null reference. Ignored in case if ClearBufferOptions does not contain Target flag. (Inherited from RenderPipelineComponent.) | |
| ClearDepthValue | Gets/sets depth value to fill depth buffer with, prior to render this component.
Default is 1. Ignored in case if ClearBufferOptions does not contain Depth flag. (Inherited from RenderPipelineComponent.) | |
| ClearEntireRenderTargetBeforeUpdate | Turns ON/OFF clearing entire render target before rendering this component.
To account viewport bounds and clear only viewport area, use ClearViewportBeforeUpdate property.
Default is true. See also ClearXXXX properties for more options. (Inherited from RenderPipelineComponent.) | |
| ClearOptions | Gets/sets flags specifying what surfaces to clear prior to
render this component. Note that only area clipped by viewport will
be cleared. Default value is Target|DepthBuffer. See additional
options in properties named as ClearBuffer[option]. (Inherited from RenderPipelineComponent.) | |
| ClearStencilValue | Gets/sets depth value to fill stencil buffer with, prior to render this component.
Default is 0. Ignored in case if ClearBufferOptions does not contain Stencil flag. (Inherited from RenderPipelineComponent.) | |
| ClearViewportBeforeUpdate | Turns ON/OFF clearing viewport area before rendering this component.
To ignore viewport bounds and clear render target entirely, use ClearEntireRenderTargetBeforeUpdate property.
Default is true. See also ClearXXXX properties for more options. (Inherited from RenderPipelineComponent.) | |
| CompareTo(RenderPipelineComponent) | (Inherited from RenderPipelineComponent.) | |
| Components | Components that are attached to this Entity. (Inherited from ComponentBase.) | |
| ComponentsForGlobalSceneFolders | (Inherited from ComponentBase.) | |
| Context | Defines the Owner of this component as well as the role (i.e. 'slot') that this component fulfills. (Inherited from ComponentBase.) | |
| CreateService<(Of <<'(TService>)>>)()()()() | (Inherited from ComponentBase.) | |
| CurrentPipeline | (Inherited from RenderPipelineComponent.) | |
| DefaultClearColorValue | ||
| Dispose()()()() | Disposes the component of rendering pipeline. (Inherited from RenderPipelineComponent.) | |
| Disposed | (Inherited from ComponentBase.) | |
| GetService<(Of <<'(TService>)>>)()()()() | (Inherited from ComponentBase.) | |
| GetService<(Of <<'(TService>)>>)(TService%) | (Inherited from ComponentBase.) | |
| HasComponents | (Inherited from ComponentBase.) | |
| Invalidate()()()() | Invalidates component state; specific implementation depends on particular component.
Called by framework after device reset, or can be called manually to force component
update on next frame. Default implementation does nothing. (Inherited from RenderPipelineComponent.) | |
| IsActive | Gets/sets flag indicate that component is active. Inactive
components are skipped during rendering a frame. Default is true (component is active). (Inherited from RenderPipelineComponent.) | |
| IsDeserialized | Indicates if Instance was created by Deserialization. (Inherited from ComponentBase.) | |
| IsDisposed | Indicates if Dispose() was called for this instance (and it's either in process of Disposing or already fully disposed). (Inherited from ComponentBase.) | |
| IsSaved | Indicates if the component is to be Saved when the owning context is saved
(e.g. for components in your scene, this controls whether or not they are saved to the scene file when the scene is saved).
Typically objects are 'Saved', unless they are transient to be programmatically created each time. (Inherited from ComponentBase.) | |
| IsStandardComponent | Indicates if component should be considered "Standard" and never removed during "purging". (Inherited from RenderPipelineComponent.) | |
| Name | Gets/sets the name of this component. (Inherited from RenderPipelineComponent.) | |
| OnAddedToPipeline(RenderPipeline) | (Inherited from RenderPipelineComponent.) | |
| OnMemberwiseClone()()()() | (Inherited from ComponentBase.) | |
| OnRemovedFromPipeline(RenderPipeline) | (Inherited from RenderPipelineComponent.) | |
| Priority | Gets/sets a priority of this component. Components with LOWER priorities are
rendered FIRST. For example, GUI may have priority 10000, and post-effect may have priority 20000.
Standard priorities are defined in constants of StandardRenderPipeline class. Default value is 0. (Inherited from RenderPipelineComponent.) | |
| Render(RenderContext) | (Overrides RenderPipelineComponent..::..Render(RenderContext).) | |
| RenderTarget | Gets/sets a render target to render on. (Inherited from RenderPipelineComponent.) | |
| RenderTargetChanged | Fires when RenderTarget was assigned to new value. (Inherited from RenderPipelineComponent.) | |
| ToString()()()() | (Inherited from RenderPipelineComponent.) | |
| Viewport | Gets/sets a viewport, which defines area of render target to render in. (Inherited from RenderPipelineComponent.) | |
| ViewportChanged | Fires when Viewport was assigned to new value. (Inherited from RenderPipelineComponent.) |
Inheritance Hierarchy
System..::..Object
Visual3D.EntityModel..::..ComponentBase
Visual3D.Graphics3D..::..RenderPipelineComponent
Visual3D.Graphics3D.StandardPipeline..::..FrameCleaner
Visual3D.EntityModel..::..ComponentBase
Visual3D.Graphics3D..::..RenderPipelineComponent
Visual3D.Graphics3D.StandardPipeline..::..FrameCleaner