Class SurfaceRenderStep
Draws a IScreenSurface object.
Inherited Members
Namespace: SadConsole.Renderers
Assembly: SadConsole.Host.MonoGame.dll
Syntax
public class SurfaceRenderStep : IRenderStep, IDisposable, IRenderStepTexture
Constructors
SurfaceRenderStep()
Declaration
public SurfaceRenderStep()
Properties
BackingTexture
The cached texture of the drawn surface.
Declaration
public RenderTarget2D? BackingTexture { get; }
Property Value
Type | Description |
---|---|
RenderTarget2D |
CachedTexture
The texture created by the render step.
Declaration
public ITexture? CachedTexture { get; }
Property Value
Type | Description |
---|---|
ITexture |
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()
Dispose(bool)
Disposes the object.
Declaration
protected void Dispose(bool disposing)
Parameters
~SurfaceRenderStep()
Finalizes the object for collection.
Declaration
protected ~SurfaceRenderStep()
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 | |
bool | isForced |
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 an alternative IScreenSurface to render. If null, the surface associated with the parent renderer is drawn.
Declaration
public void SetData(object data)
Parameters
Type | Name | Description |
---|---|---|
object | data |