ketraterm-render-api/io.github.ketraterm.render.api/TerminalRenderFrame

TerminalRenderFrame

Short-lived primitive view of the terminal's render state for one viewport.

A frame exposes stable public render encodings, not core internal storage. Consumers should copy rows into caller-owned primitive arrays during the enclosing TerminalRenderFrameReader.readRenderFrame callback.

Properties

activeBuffer

abstract val activeBuffer: TerminalRenderBufferKind

Currently active terminal screen buffer.

columns

abstract val columns: Int

Number of visible columns in each render row.

cursor

abstract val cursor: TerminalRenderCursor

Current render cursor overlay state.

discardedCount

open val discardedCount: Long

Number of history lines discarded due to ring buffer capacity wrapping.

frameGeneration

abstract val frameGeneration: Long

Monotonic generation that changes on any visually relevant mutation.

historySize

open val historySize: Int

Number of retained off-screen history lines available in this frame.

palette

open val palette: TerminalColorPalette

Currently active resolved color palette.

rows

abstract val rows: Int

Number of visible render rows.

scrollbackOffset

open val scrollbackOffset: Int

Clamped scrollback offset used by this frame, in lines from the live bottom viewport. Zero means the frame is pinned to the newest output.

structureGeneration

abstract val structureGeneration: Long

Generation that changes when terminal-owned row mapping or shape changes.

Functions

copyCursor

open fun copyCursor(sink: TerminalRenderCursorSink)

Copies the current cursor overlay state into sink.

copyLine

abstract fun copyLine(row: Int, codeWords: IntArray, codeOffset: Int = 0, attrWords: LongArray, attrOffset: Int = 0, flags: IntArray, flagOffset: Int = 0, extraAttrWords: LongArray? = null, extraAttrOffset: Int = 0, hyperlinkIds: IntArray? = null, hyperlinkOffset: Int = 0, clusterSink: TerminalRenderClusterSink? = null, clusterDataSink: TerminalRenderClusterDataSink? = null)

Copies one visible row into caller-owned primitive arrays.

lineGeneration

abstract fun lineGeneration(row: Int): Long

Returns the generation for visible row.

lineId

open fun lineId(row: Int): Long

Returns the stable logical line identity for visible row.

lineWrapped

abstract fun lineWrapped(row: Int): Boolean

Reports whether visible row soft-wraps into the next row.