Skip to content

CursorRenderStep Class

Renders a cursor.

C#
public class CursorRenderStep : IRenderStep, IDisposable

Inheritance object

Implements IRenderStep, IDisposable

C#
public CursorRenderStep()

The name of the render step.

C#
public string Name { get; }

Indicates priority related to other steps. Lowest runs first.

C#
public uint SortOrder { get; set; }

Sets the Cursor.

C#
public void SetData(object data)

data object
A Cursor object.

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

C#
public void Reset()

Refresh(IRenderer, IScreenSurface, bool, bool)

Section titled “Refresh(IRenderer, IScreenSurface, bool, bool)”

Called to redraw the render step if needed.

C#
public bool Refresh(IRenderer renderer, IScreenSurface screenObject, bool backingTextureChanged, bool isForced)

renderer IRenderer
The renderer the render step is using.

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

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

isForced bool
true when refresh is being forced; otherwise false.

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

Called when the renderer needs to redraw the Output texture.

C#
public void Composing(IRenderer renderer, IScreenSurface screenObject)

renderer IRenderer
The renderer the render step is using.

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

Called when building draw calls for the render pipeline.

C#
public void Render(IRenderer renderer, IScreenSurface screenObject)

renderer IRenderer
The renderer the render step is using.

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

C#
public void Dispose()