Class Overlay
A surface that's rendered on top of a host surface.
Implements
Inherited Members
Namespace: SadConsole.Components
Assembly: SadConsole.dll
Syntax
public class Overlay : UpdateComponent, IComponent
Constructors
Overlay()
Declaration
public Overlay()
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
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. |