API Reference
LineOutput
The line-based output for OutputMode.Stream and OutputMode.Plain: append-only lines, never any cursor movement. Stream keeps colour when the profile allows it (CI logs render ANSI); Plain never emits escape sequences. Live frames are ignored: a live session narrates events as lines instead.
Inheritance
- Object
- LineOutput
Constructors
public LineOutput(ITerminalWriter writer, TerminalProfile profile, Boolean ownsWriter = true) #Creates a line output.
Parameters
- writer ConsoleMonster.Output.ITerminalWriter
- The sink.
- profile ConsoleMonster.Capabilities.TerminalProfile
- The profile.
- ownsWriter System.Boolean = true
- Whether disposing this output disposes the writer.
Methods
public Void BeginLive() #VoidStarts live rendering (VT: alternate screen, hidden cursor). No effect for line-based outputs.
public Void Dispose() #VoidPerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public Void EndLive() #VoidEnds live rendering and restores the terminal (cursor, screen, attributes). Safe to call more than once.
public Void Invalidate() #VoidForces the next frame to be redrawn completely (after a resize or external output).
public Void RenderFrame(CellBuffer frame) #VoidDraws a full-screen frame, writing only the cells that changed since the previous frame.
Parameters
- frame ConsoleMonster.Canvas.CellBuffer
- The frame; its size is the screen size.
public Void WriteBlock(CellBuffer buffer) #VoidAppends a rendered block (print-once output) to the scrollback.
Parameters
- buffer ConsoleMonster.Canvas.CellBuffer
- The rendered block; trailing blank cells on each row are trimmed.
public Void WriteInline(StyledLine line) #VoidWrites one styled line without ending it (Write-ConsoleText -NoNewLine); the next write continues on it.
Parameters
- line ConsoleMonster.Text.StyledLine
- The line.
public Void WriteLine(StyledLine line) #VoidAppends one styled line (stream narration, captured output, summaries).
Parameters
- line ConsoleMonster.Text.StyledLine
- The line.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Boolean SupportsLiveFrames { get; } #Whether the output can redraw a live frame in place.