Class RenderPipeline

Allows control over how the scene is rendered.

Inheritance
object
DisposableObject
RenderPipeline
DefaultRenderPipeline
Inherited Members
Namespace: Evergine.Framework.Graphics
Assembly: Evergine.Framework.dll
Syntax
public abstract class RenderPipeline : DisposableObject

Fields

Clock

Gets the clock service instance.

Declaration
public Clock Clock
Field Value
Type Description
Clock

PerSceneCBufferCollection

Gets the per-frame CBuffer collection of this scene.

Declaration
public CBufferCollectionUpdater PerSceneCBufferCollection
Field Value
Type Description
CBufferCollectionUpdater

Properties

AdditionalEffectDirectives

Gets the additional effects directives specified by this pipeline.

Declaration
public virtual List<string> AdditionalEffectDirectives { get; }
Property Value
Type Description
List<string>

DefaultRenderPath

Gets the default rendering path.

Declaration
public abstract CameraRenderPath DefaultRenderPath { get; }
Property Value
Type Description
CameraRenderPath

RenderManager

Gets the render manager.

Declaration
public RenderManager RenderManager { get; }
Property Value
Type Description
RenderManager

SupportedRenderPaths

Gets the supported render path.

Declaration
public abstract IReadOnlyList<CameraRenderPath> SupportedRenderPaths { get; }
Property Value
Type Description
IReadOnlyList<CameraRenderPath>

Methods

AddCamera(Camera)

Adds a camera.

Declaration
public abstract void AddCamera(Camera camera)
Parameters
Type Name Description
Camera camera

The camera.

AddLight(Light)

Adds a light.

Declaration
public abstract void AddLight(Light light)
Parameters
Type Name Description
Light light

The light.

AddRenderPath(CameraRenderPath)

Adds a render path.

Declaration
public abstract void AddRenderPath(CameraRenderPath renderPath)
Parameters
Type Name Description
CameraRenderPath renderPath

The render path.

BaseInitialize(RenderManager)

Initializes this instance.

Declaration
public void BaseInitialize(RenderManager renderManager)
Parameters
Type Name Description
RenderManager renderManager

The render manager.

Destroy()

Destroys all resources of this instance.

Declaration
protected override void Destroy()
Overrides

FireOnCameraRender(DrawContext)

Fires on camera render event.

Declaration
public void FireOnCameraRender(DrawContext drawContext)
Parameters
Type Name Description
DrawContext drawContext

The draw context.

FireOnPostRender()

Fires on post render event.

Declaration
protected void FireOnPostRender()

FireOnPreRender()

Fires on the pre-render event.

Declaration
protected void FireOnPreRender()

Initialize()

Initializes the Render Pipeline.

Declaration
protected abstract void Initialize()

PreparingNextFrame()

Prepares items for the next frame.

Declaration
protected virtual void PreparingNextFrame()

RemoveCamera(Camera)

Removes a camera.

Declaration
public abstract void RemoveCamera(Camera camera)
Parameters
Type Name Description
Camera camera

The camera.

RemoveLight(Light)

Removes a light.

Declaration
public abstract void RemoveLight(Light light)
Parameters
Type Name Description
Light light

The light.

RemoveRenderPath(CameraRenderPath)

Removes the render path.

Declaration
public abstract bool RemoveRenderPath(CameraRenderPath renderPath)
Parameters
Type Name Description
CameraRenderPath renderPath

The render path.
Returns
Type Description
bool

True if it has been removed successfully.

Render(TimeSpan)

Renders this scene.

Declaration
public abstract void Render(TimeSpan gameTime)
Parameters
Type Name Description
TimeSpan gameTime

The game time.

Events

OnCameraRender

Event fired when a camera is rendering

Declaration
public event EventHandler<DrawContext> OnCameraRender
Event Type
Type Description
EventHandler<DrawContext>

OnPostRender

Event fired after the render finishes

Declaration
public event EventHandler OnPostRender
Event Type
Type Description
EventHandler

OnPreRender

Event fired before the rendering starts

Declaration
public event EventHandler OnPreRender
Event Type
Type Description
EventHandler

Extension Methods