Skip to content

ReflowResult

Namespace: Hex1b.Reflow

Assembly: Hex1b.dll

Result returned from containing the reflowed terminal state.

csharp
public readonly record struct ReflowResult : IEquatable<ReflowResult>

Implements

Constructors

ReflowResult(TerminalCell[][], ReflowScrollbackRow[], int, int, int?, int?)

Result returned from containing the reflowed terminal state.

Parameters:

  • ScreenRows (TerminalCell[][]): The new screen buffer rows after reflow. Must contain exactly NewHeight rows, each with exactly NewWidth cells.
  • ScrollbackRows (ReflowScrollbackRow[]): The new scrollback rows after reflow, ordered oldest to newest. May be larger or smaller than the input scrollback (promotion/demotion).
  • CursorX (Int32): The cursor column position (0-based) after reflow.
  • CursorY (Int32): The cursor row position (0-based) after reflow.
  • NewSavedCursorX (Nullable<Int32>): The reflowed DECSC saved cursor column, or null if not reflowed.
  • NewSavedCursorY (Nullable<Int32>): The reflowed DECSC saved cursor row, or null if not reflowed.
csharp
public ReflowResult(TerminalCell[][] ScreenRows, ReflowScrollbackRow[] ScrollbackRows, int CursorX, int CursorY, int? NewSavedCursorX = null, int? NewSavedCursorY = null)

Properties

CursorX

The cursor column position (0-based) after reflow.

Returns: Int32

csharp
public int CursorX { get; init; }

CursorY

The cursor row position (0-based) after reflow.

Returns: Int32

csharp
public int CursorY { get; init; }

NewSavedCursorX

The reflowed DECSC saved cursor column, or null if not reflowed.

Returns: Nullable<Int32>

csharp
public int? NewSavedCursorX { get; init; }

NewSavedCursorY

The reflowed DECSC saved cursor row, or null if not reflowed.

Returns: Nullable<Int32>

csharp
public int? NewSavedCursorY { get; init; }

ScreenRows

The new screen buffer rows after reflow. Must contain exactly NewHeight rows, each with exactly NewWidth cells.

Returns: TerminalCell[][]

csharp
public TerminalCell[][] ScreenRows { get; init; }

ScrollbackRows

The new scrollback rows after reflow, ordered oldest to newest. May be larger or smaller than the input scrollback (promotion/demotion).

Returns: ReflowScrollbackRow[]

csharp
public ReflowScrollbackRow[] ScrollbackRows { get; init; }

Released under the MIT License.