Interface IConsoleDriver

Namespace

SharpConsoleUI.Drivers

Assembly

SharpConsoleUI.dll

Defines the interface for console drivers that handle low-level console input/output operations.

public interface IConsoleDriver

Extension Methods

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>, Func<TTgt, TSrc>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>)

Remarks

Console drivers abstract the platform-specific console functionality, providing a unified interface for keyboard input, mouse events, screen resizing, and console output.

Properties

ScreenSize

Gets the current size of the console screen.

Size ScreenSize { get; }

Property Value

Size

A Size representing the width and height of the console in characters.

Methods

Clear()

Clears the console screen or buffer.

void Clear()

FillCells(int, int, int, char, Color, Color)

Fills a horizontal run of cells at the specified position with the given character and colors.

void FillCells(int x, int y, int width, char character, Color fg, Color bg)

Parameters

x int

The starting horizontal position (column).

y int

The vertical position (row).

width int

The number of cells to fill.

character char

The character to fill with.

fg Color

The foreground color.

bg Color

The background color.

Flush()

Flushes any buffered output to the console.

void Flush()

Remarks

For buffered render modes, this triggers the actual rendering to the console. For direct render modes, this may be a no-op.

GetDirtyCharacterCount()

Gets the count of dirty characters in the rendering buffer.

int GetDirtyCharacterCount()

Returns

int

The number of dirty characters, or 0 if not using buffered rendering.

Initialize(ConsoleWindowSystem)

Initializes the driver with a reference to the window system. Called by ConsoleWindowSystem after state services are created.

void Initialize(ConsoleWindowSystem windowSystem)

Parameters

windowSystem ConsoleWindowSystem

The window system instance

InvalidateFrontBuffer()

Forces the next flush to re-emit every cell (used by watchdog recovery to repair the screen after stray terminal output). No-op for drivers that do not diff-render.

void InvalidateFrontBuffer()

ResetCursorShape()

Resets the cursor to the default shape.

void ResetCursorShape()

SetCursorPosition(int, int)

Sets the cursor position on the console screen.

void SetCursorPosition(int x, int y)

Parameters

x int

The column position (0-based).

y int

The row position (0-based).

SetCursorShape(CursorShape)

Sets the cursor shape/style.

void SetCursorShape(CursorShape shape)

Parameters

shape CursorShape

The desired cursor shape.

SetCursorShape(CursorShape, CursorBlink)

Sets the cursor shape/style together with its blink behavior.

void SetCursorShape(CursorShape shape, CursorBlink blink)

Parameters

shape CursorShape

The desired cursor shape.

blink CursorBlink

The desired blink behavior.

Remarks

The default implementation ignores blink and delegates to SetCursorShape(CursorShape) so existing drivers keep working.

SetCursorVisible(bool)

Sets the visibility of the cursor.

void SetCursorVisible(bool visible)

Parameters

visible bool

True to show the cursor, false to hide it.

SetNarrowCell(int, int, char, Color, Color)

Sets a single cell at the specified position with the given character and colors.

void SetNarrowCell(int x, int y, char character, Color fg, Color bg)

Parameters

x int

The horizontal position (column).

y int

The vertical position (row).

character char

The character to write.

fg Color

The foreground color.

bg Color

The background color.

Start()

Starts the console driver, initializing input handling and enabling mouse/keyboard events.

void Start()

Stop()

Stops the console driver, disabling input handling and restoring the console to its original state.

void Stop()

WriteBufferRegion(int, int, CharacterBuffer, int, int, int, Color)

Copies a horizontal strip of cells from a CharacterBuffer directly to the console output buffer, bypassing ANSI string serialization and parsing.

void WriteBufferRegion(int destX, int destY, CharacterBuffer source, int srcX, int srcY, int width, Color fallbackBg)

Parameters

destX int

Destination screen X position.

destY int

Destination screen Y position.

source CharacterBuffer

The source CharacterBuffer.

srcX int

Source X offset within the buffer.

srcY int

Source Y (row) within the buffer.

width int

Number of cells to write.

fallbackBg Color

Background color for padding when source is out of bounds.

WriteClipboardOsc52(string)

Writes a pre-built OSC 52 clipboard escape sequence to the terminal output stream (under the driver's output lock). Default no-op for drivers without terminal output.

void WriteClipboardOsc52(string sequence)

Parameters

sequence string

The full escape sequence (already encoded/wrapped).

Events

KeyPressed

Occurs when a key is pressed on the keyboard.

event EventHandler<ConsoleKeyInfo> KeyPressed

Event Type

EventHandler<ConsoleKeyInfo>

MouseEvent

Occurs when a mouse event is detected.

event IConsoleDriver.MouseEventHandler? MouseEvent

Event Type

IConsoleDriver.MouseEventHandler

Paste

Occurs when a bracketed-paste block is received (delivered atomically).

event EventHandler<string>? Paste

Event Type

EventHandler<string>

ScreenResized

Occurs when the console screen is resized. Low-level driver event: fires on a background thread, before the framework repositions windows, and requires the subscriber to marshal to the UI thread and invalidate manually. Application code should prefer WindowResized, which fires on the UI thread after reposition and re-invalidates automatically.

event EventHandler<Size>? ScreenResized

Event Type

EventHandler<Size>