Class CursorRenderStep

Renders a cursor.

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

Constructors

CursorRenderStep()

Declaration
public CursorRenderStep()

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)

Called when the renderer needs to redraw the Output texture.

Declaration
public 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.

Dispose()

Declaration
public void Dispose()

Refresh(IRenderer, IScreenSurface, bool, bool)

Called to redraw the render step if needed.

Declaration
public 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
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)

Sets the Cursor.

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

A Cursor object.

Implements

Extension Methods