Class WindowRenderStep

Renders the dimmed background screen when a window is modal.

Inheritance
object
WindowRenderStep
Implements
Inherited Members
Namespace: SadConsole.Renderers
Assembly: SadConsole.Host.MonoGame.dll
Syntax
public class WindowRenderStep : IRenderStep, IDisposable

Constructors

WindowRenderStep()

Declaration
public WindowRenderStep()

Properties

Name

The name of the render step.

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

SortOrder

Indicates priority related to other steps. Lowest runs first.

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

Methods

Composing(IRenderer, IScreenSurface)

Does nothing.

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

Dispose()

Does nothing.

Declaration
public void Dispose()

Refresh(IRenderer, IScreenSurface, bool, bool)

Does nothing.

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

Render(IRenderer, IScreenSurface)

Called when building draw calls for the render pipeline.

Declaration
public 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
public void Reset()

SetData(object)

Not used.

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

Implements

Extension Methods