SurfaceRenderStep Class
Definition
Section titled “Definition”Draws a IScreenSurface object.
public class SurfaceRenderStep : IRenderStep, IDisposable, IRenderStepTextureInheritance object
Implements IRenderStep, IDisposable, IRenderStepTexture
Constructors
Section titled “Constructors”SurfaceRenderStep()
Section titled “SurfaceRenderStep()”public SurfaceRenderStep()Properties
Section titled “Properties”BackingTexture
Section titled “BackingTexture”The cached texture of the drawn surface.
public RenderTarget2D? BackingTexture { get; }CachedTexture
Section titled “CachedTexture”The texture created by the render step.
public ITexture? CachedTexture { get; }The name of the render step.
public string Name { get; }SortOrder
Section titled “SortOrder”Indicates priority related to other steps. Lowest runs first.
public uint SortOrder { get; set; }ComposeTint
Section titled “ComposeTint”The color applied when the sprite batch draws this surface on the renderer.
public Color ComposeTint { get; set; }Methods
Section titled “Methods”SetData(object)
Section titled “SetData(object)”Sets an alternative IScreenSurface to render. If null, the surface associated with the parent renderer is drawn.
public void SetData(object data)Parameters
Section titled “Parameters”data object
Reset()
Section titled “Reset()”Called when the step should reset any state or texture information.
public void Reset()Refresh(IRenderer, IScreenSurface, bool, bool)
Section titled “Refresh(IRenderer, IScreenSurface, bool, bool)”Called to redraw the render step if needed.
public bool Refresh(IRenderer renderer, IScreenSurface screenObject, bool backingTextureChanged, bool isForced)Parameters
Section titled “Parameters”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.
Returns
Section titled “Returns”bool
true when the step is going to draw something new and is requesting a Composing(IRenderer, IScreenSurface) step; otherwise false.
Composing(IRenderer, IScreenSurface)
Section titled “Composing(IRenderer, IScreenSurface)”Called when the renderer needs to redraw the Output texture.
public void Composing(IRenderer renderer, IScreenSurface screenObject)Parameters
Section titled “Parameters”renderer IRenderer
The renderer the render step is using.
screenObject IScreenSurface
The surface associated with the renderer. This may be null.
Render(IRenderer, IScreenSurface)
Section titled “Render(IRenderer, IScreenSurface)”Called when building draw calls for the render pipeline.
public void Render(IRenderer renderer, IScreenSurface screenObject)Parameters
Section titled “Parameters”renderer IRenderer
The renderer the render step is using.
screenObject IScreenSurface
The surface associated with the renderer. This may be null.
Dispose(bool)
Section titled “Dispose(bool)”Disposes the object.
protected void Dispose(bool disposing)Parameters
Section titled “Parameters”disposing bool
true to indicate this method was called from Dispose().
Dispose()
Section titled “Dispose()”public void Dispose()~SurfaceRenderStep()
Section titled “~SurfaceRenderStep()”Finalizes the object for collection.
protected ~SurfaceRenderStep()