IRenderStep Interface

Definition

A rendering step processed by an IRenderer.

public interface IRenderStep : IDisposable

The name of the render step.

string Name { get; }

Indicates priority related to other steps. Lowest runs first.

uint SortOrder { get; set; }

Adds supplemental data to the render step.

void SetData(object data)

data object
The data to add to the step.

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

void Reset()

Called to redraw the render step if needed.

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.

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.

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.

Called when various states in the host change.

void OnHostUpdated(IScreenObject host)

host IScreenObject
The host that uses this component.