C# Class Myre.Graphics.RendererComponent

An object which represents a stage of a render plan. Each renderer component encapsulates drawing onto a render target, while providing its' output a a resource for other renderer components to consume.

Inheritance: IDisposable

Show file Open project: TomGillen/Myre Class Usage Examples

Public Methods

Method	Description
Draw ( Renderer renderer ) : void	Draws this component.
Initialise ( Renderer renderer, ResourceContext context ) : void	Initialised this renderer component. Here, components may validate that required inputs are available, and define their output.

Protected Methods

Method	Description
GetResource ( string name ) : RenderTarget2D	Gets a named resource.
Output ( string name, RenderTarget2D resource ) : void	Outputs a resource.

Method Details

Draw() public abstract method

Draws this component.

public abstract Draw ( Renderer renderer ) : void
renderer	Renderer	The renderer
return	void

GetResource() protected method

Gets a named resource.

protected GetResource ( string name ) : RenderTarget2D
name	string	The name of the resource.
return	Microsoft.Xna.Framework.Graphics.RenderTarget2D

Initialise() public method

Initialised this renderer component.

Here, components may validate that required inputs are available, and define their output.

public Initialise ( Renderer renderer, ResourceContext context ) : void
renderer	Renderer	The renderer.
context	ResourceContext	The resource context containing environment information and providing means to define inputs and outputs.
return	void

Output() protected method

Outputs a resource.

protected Output ( string name, RenderTarget2D resource ) : void
name	string	The name of the resource.
resource	Microsoft.Xna.Framework.Graphics.RenderTarget2D	The resource.
return	void