Class Overlay

A surface that's rendered on top of a host surface.

Inheritance
object
UpdateComponent
Overlay
Implements
Inherited Members
Namespace: SadConsole.Components
Assembly: SadConsole.dll
Syntax
public sealed class Overlay : UpdateComponent, IComponent, IDisposable

Constructors

Overlay()

Declaration
public Overlay()

Fields

RenderStep

Internal use.

Declaration
public IRenderStep? RenderStep
Field Value
Type Description
IRenderStep
Remarks

The render step used to draw the overlay. This render step is added to the host object and should draw the Surface of the Overlay component.

Properties

ClearOnAdd

When true, clears the Surface property when this object is added to a IScreenSurface.

Declaration
public bool ClearOnAdd { get; set; }
Property Value
Type Description
bool

Surface

A surface that's sized to match.

Declaration
public ScreenSurface? Surface { get; }
Property Value
Type Description
ScreenSurface

Methods

Dispose()

Declaration
public void Dispose()

Dispose(bool)

Declaration
protected void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

~Overlay()

Declaration
protected ~Overlay()

OnAdded(IScreenObject)

Called when the component is added to a host.

Declaration
public override void OnAdded(IScreenObject host)
Parameters
Type Name Description
IScreenObject host

The host that added the component.
Overrides

OnRemoved(IScreenObject)

Called when the component is removed from the host.

Declaration
public override void OnRemoved(IScreenObject host)
Parameters
Type Name Description
IScreenObject host

The host that removed the component.
Overrides

Update(IScreenObject, TimeSpan)

Called by a host on the update frame.

Declaration
public override void Update(IScreenObject host, TimeSpan delta)
Parameters
Type Name Description
IScreenObject host

The host calling the component.
TimeSpan delta

The time that has elapsed since this method was last called.
Overrides

Implements

Extension Methods