Interface IRenderStep

A rendering step processed by an IRenderer.

Inherited Members
Namespace: SadConsole.Renderers
Assembly: SadConsole.dll
Syntax
public interface IRenderStep : IDisposable

Properties

Name

The name of the render step.

Declaration
string Name { get; }
Property Value
Type Description
string

SortOrder

Indicates priority related to other steps. Lowest runs first.

Declaration
uint SortOrder { get; set; }
Property Value
Type Description
uint

Methods

Composing(IRenderer, IScreenSurface)

Called when the renderer needs to redraw the Output texture.

Declaration
void Composing(IRenderer renderer, IScreenSurface screenObject)
Parameters
Type Name Description
IRenderer renderer

The renderer the render step is using.
IScreenSurface screenObject

The surface associated with the renderer. This may be null.

OnHostUpdated(IScreenObject)

Called when various states in the host change.

Declaration
void OnHostUpdated(IScreenObject host)
Parameters
Type Name Description
IScreenObject host

The host that uses this component.

Refresh(IRenderer, IScreenSurface, bool, bool)

Called to redraw the render step if needed.

Declaration
bool Refresh(IRenderer renderer, IScreenSurface screenObject, bool backingTextureChanged, bool isForced)
Parameters
Type Name Description
IRenderer renderer

The renderer the render step is using.
IScreenSurface screenObject

The surface associated with the renderer. This may be null.
bool backingTextureChanged

true to indicate the Output changed; otherwise false.
bool isForced

true when refresh is being forced; otherwise false.
Returns
Type Description
bool

true when the step is going to draw something new and is requesting a Composing(IRenderer, IScreenSurface) step; otherwise false.

Render(IRenderer, IScreenSurface)

Called when building draw calls for the render pipeline.

Declaration
void Render(IRenderer renderer, IScreenSurface screenObject)
Parameters
Type Name Description
IRenderer renderer

The renderer the render step is using.
IScreenSurface screenObject

The surface associated with the renderer. This may be null.

Reset()

Called when the step should reset any state or texture information.

Declaration
void Reset()

SetData(object)

Adds supplemental data to the render step.

Declaration
void SetData(object data)
Parameters
Type Name Description
object data

The data to add to the step.

Extension Methods