Class UISurfaceProgram

Runs an interface as a surface program: it draws straight into the session’s cell surface and takes input as events, with no escape sequences either way. Start it with TerminalSession.RunSurface.

Assembly: DarkEffekt.Terminal.UI

Declaration

public sealed class UISurfaceProgram : ISurfaceProgram, ISurfaceSlots, ITerminalInput

Implements:
DarkEffekt.Terminal.ISurfaceProgram, DarkEffekt.Terminal.ISurfaceSlots, DarkEffekt.Terminal.ITerminalInput

Properties

UI

Declaration

public TerminalUI UI { get; }

Methods

Start(ISurfaceHost)

Declaration

public void Start(ISurfaceHost host)

Parameters

Type	Name
DarkEffekt.Terminal.ISurfaceHost	host

Stop()

Declaration

public void Stop()

Tick(float)

Called once a frame, before the session draws. Draw here, then call Invalidate on the surface.

Declaration

public void Tick(float deltaSeconds)

Parameters

Type	Name
System.Single	deltaSeconds

OnResize(int, int)

The surface was resized and blanked.

Declaration

public void OnResize(int cols, int rows)

Parameters

Type	Name
System.Int32	cols
System.Int32	rows

GetSlots(List<SurfaceSlot>)

Adds the slots visible this frame to the list.

Declaration

public void GetSlots(List<SurfaceSlot> into)

Parameters

Type	Name
System.Collections.Generic.List<DarkEffekt.Terminal.SurfaceSlot>	into

SlotBound(string, bool)

A texture was bound to a slot name, or removed from it.

Declaration

public void SlotBound(string name, bool bound)

Parameters

Type	Name
System.String	name
System.Boolean	bound

OnKey(in TermKeyEvent)

A non-text key: arrows, function keys, Enter, Tab, and the rest of DarkEffekt.Terminal.TermKey.

Declaration

public void OnKey(in TermKeyEvent e)

Parameters

Type	Name
DarkEffekt.Terminal.TermKeyEvent	e

OnChar(char, TermModifiers)

A typed character, or a letter held with Ctrl or Alt.

Declaration

public void OnChar(char c, TermModifiers modifiers)

Parameters

Type	Name
System.Char	c
DarkEffekt.Terminal.TermModifiers	modifiers

OnPaste(string)

Text pasted from the clipboard.

Declaration

public void OnPaste(string text)

Parameters

Type	Name
System.String	text

OnMouse(in TermMouseEvent)

Declaration

public void OnMouse(in TermMouseEvent e)

Parameters

Type	Name
DarkEffekt.Terminal.TermMouseEvent	e

OnFocus(bool)

The terminal gained or lost keyboard focus.

Declaration

public void OnFocus(bool focused)

Parameters

Type	Name
System.Boolean	focused

Implements

• DarkEffekt.Terminal.ISurfaceProgram
• DarkEffekt.Terminal.ISurfaceSlots
• DarkEffekt.Terminal.ITerminalInput