Overlay Class

Definition

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

public sealed class Overlay : UpdateComponent, IComponent, IDisposable

public Overlay()

Internal use.

public IRenderStep? RenderStep

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.

A surface that’s sized to match.

public ScreenSurface? Surface { get; }

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

public bool ClearOnAdd { get; set; }

Called when the component is added to a host.

public override void OnAdded(IScreenObject host)

host IScreenObject
The host that added the component.

Called when the component is removed from the host.

public override void OnRemoved(IScreenObject host)

host IScreenObject
The host that removed the component.

Called by a host on the update frame.

public override void Update(IScreenObject host, TimeSpan delta)

host IScreenObject
The host calling the component.

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

protected void Dispose(bool disposing)

disposing bool

protected ~Overlay()

public void Dispose()