LayeredSurfaceRenderStep Class

Definition

public class LayeredSurfaceRenderStep : IRenderStep, IDisposable, IRenderStepTexture

Inheritance object

public LayeredSurfaceRenderStep()

The cached texture of the drawn surface.

public RenderTarget2D BackingTexture { get; }

The texture created by the render step.

public ITexture CachedTexture { get; }

The name of the render step.

public string Name { get; }

Indicates priority related to other steps. Lowest runs first.

public uint SortOrder { get; set; }

public void SetData(object data)

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

public void Reset()

Called to redraw the render step if needed.

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.

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.

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.

Disposes the object.

protected void Dispose(bool disposing)

disposing bool
true to indicate this method was called from Dispose().

public void Dispose()

Finalizes the object for collection.

protected ~LayeredSurfaceRenderStep()