Class RenderSystem

Namespace

Stride.Rendering

Assembly

Stride.Rendering.dll

Facility to perform rendering: extract rendering data from scene, determine effects and GPU states, compute and prepare data (i.e. matrices, buffers, etc...) and finally draw it.

public class RenderSystem : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder

Inheritance

object

DisposeBase

ComponentBase

RenderSystem

Implements

IDisposable

IComponent

IReferencable

ICollectorHolder

Inherited Members

ComponentBase.Tags

ComponentBase.Name

ComponentBase.OnNameChanged()

ComponentBase.ToString()

DisposeBase.Dispose()

DisposeBase.IsDisposed

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

Extension Methods

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

Constructors

RenderSystem()

public RenderSystem()

Properties

EffectSystem

The effect system, used to compile effects.

public EffectSystem EffectSystem { get; }

Property Value

EffectSystem

FrameCounter

Frame counter, mostly for internal use.

public int FrameCounter { get; }

Property Value

int

GraphicsDevice

The graphics device, used to create graphics resources.

public GraphicsDevice GraphicsDevice { get; }

Property Value

GraphicsDevice

RenderContextOld

public RenderContext RenderContextOld { get; }

Property Value

RenderContext

RenderFeatures

List of render features

public FastTrackingCollection<RootRenderFeature> RenderFeatures { get; }

Property Value

FastTrackingCollection<RootRenderFeature>

RenderStages

List of render stages.

public FastTrackingCollection<RenderStage> RenderStages { get; }

Property Value

FastTrackingCollection<RenderStage>

Services

Gets the services registry.

public IServiceRegistry Services { get; }

Property Value

IServiceRegistry

The services registry.

Views

List of views.

public FastTrackingCollection<RenderView> Views { get; }

Property Value

FastTrackingCollection<RenderView>

Methods

AddRenderObject(RenderObject)

Adds a RenderObject to the rendering.

public void AddRenderObject(RenderObject renderObject)

Parameters

renderObject RenderObject

Collect(RenderContext)

Performs pipeline initialization, enumerates views and populates visibility groups.

public void Collect(RenderContext context)

Parameters

context RenderContext

Destroy()

Disposes of object resources.

protected override void Destroy()

Draw(RenderDrawContext, RenderView, RenderStage)

public void Draw(RenderDrawContext renderDrawContext, RenderView renderView, RenderStage renderStage)

Parameters

renderDrawContext RenderDrawContext

renderView RenderView

renderStage RenderStage

Extract(RenderContext)

Extract data from entities, should be as fast as possible to not block simulation loop. It should be mostly copies, and the actual processing should be part of Prepare().

public void Extract(RenderContext context)

Parameters

context RenderContext

Flush(RenderDrawContext)

Finalizes the render features work and releases temporary resources if necessary.

public void Flush(RenderDrawContext context)

Parameters

context RenderDrawContext

Initialize(RenderContext)

Initializes the render system.

public void Initialize(RenderContext context)

Parameters

context RenderContext

Prepare(RenderDrawContext)

Performs most of the work (computation and resource preparation). Later game simulation might be running during that step.

public void Prepare(RenderDrawContext context)

Parameters

context RenderDrawContext

RemoveRenderObject(RenderObject)

Removes a RenderObject from the rendering.

public void RemoveRenderObject(RenderObject renderObject)

Parameters

renderObject RenderObject

Reset()

Reset render objects and features. Should be called at beginning of Extract phase.

public void Reset()

Events

RenderStageSelectorsChanged

public event Action RenderStageSelectorsChanged

Event Type

Action