ketraterm-render-cache/io.github.ketraterm.render.cache/TerminalRenderCache

TerminalRenderCache

class TerminalRenderCache(columns: Int, rows: Int, rowCapacityReserve: Int) : TerminalRenderFrameConsumer

Caller-owned primitive cache for render frames.

This cache consumes TerminalRenderFrameReader and stores copied primitive row data after the frame callback returns. It deliberately contains no backend-specific glyph runs, font state, paint objects, selection model, or UI timer logic. Swing, Compose, and other renderers can build their local layout and paint caches from this primitive data.

Cell and row planes may have spare capacity when rowCapacityReserve is non-zero. Only the prefix addressed by columns and rows is part of the current frame. The reserve lets renderers change a viewport's logical row count, for example while smooth-scroll overscan is active, without replacing the primitive arrays in the frame-update hot path.

This cache is mutable and requires caller confinement or external serialization. Array properties expose cache-owned storage for allocation-free reading. Do not mutate their contents or retain them across updates/reset, which may reuse or replace storage. Caches borrowed from a publisher are read-only for the duration of its reader lease.

Parameters

columns

initial cache width in cells.

rows

initial cache height in rows.

rowCapacityReserve

spare rows retained whenever primitive storage is allocated; must be non-negative.

Constructors

TerminalRenderCache

constructor(columns: Int, rows: Int, rowCapacityReserve: Int)

constructor(columns: Int, rows: Int)

Creates a cache whose primitive planes exactly fit its initial shape.

Properties

activeBuffer

var activeBuffer: TerminalRenderBufferKind

Last copied active buffer kind.

attrWords

var attrWords: LongArray

Copied primary public render attribute words in row-major order.

clusterCodepoints

var clusterCodepoints: IntArray

Packed codepoint storage referenced by clusterRefs.

clusterRefs

var clusterRefs: LongArray

Copied cluster references in row-major order. Zero means no cluster; other values pack a codepoint offset in the high 32 bits and a codepoint length in the low 32 bits.

codeWords

var codeWords: IntArray

Copied code words in row-major order. See TerminalRenderFrame.copyLine.

columns

var columns: Int

Cached visible width in cells.

contentGeneration

var contentGeneration: Long

Last copied TerminalRenderFrame.contentGeneration, including a reader's conservative fallback.

cursor

val cursor: TerminalRenderCursor?

Convenience cursor snapshot for tests and compatibility callers.

cursorBlinking

var cursorBlinking: Boolean

Last copied cursor blinking mode.

cursorChangedOnLastUpdate

var cursorChangedOnLastUpdate: Boolean

Whether the most recent updateFrom call changed the cursor state.

cursorColumn

var cursorColumn: Int

Last copied cursor column.

cursorGeneration

var cursorGeneration: Long

Last copied cursor generation.

cursorRow

var cursorRow: Int

Last copied cursor row.

cursorShape

var cursorShape: TerminalRenderCursorShape

Last copied cursor shape.

cursorVisible

var cursorVisible: Boolean

Last copied cursor visibility.

discardedCount

var discardedCount: Long

History lines discarded due to capacity wrapping since initialization.

extraAttrWords

var extraAttrWords: LongArray

Copied optional public extra-attribute words in row-major order.

flags

var flags: IntArray

Copied public render cell flags in row-major order.

frameGeneration

var frameGeneration: Long

Last copied frame generation.

graphicsGeneration

var graphicsGeneration: Long

Last copied image/placement generation, meaningful only while hasFrame is true. Compare for equality and qualify it by source identity and viewport mapping.

hasBlinkingText

var hasBlinkingText: Boolean

Whether any copied visible row contains SGR blinking text.

hasFrame

var hasFrame: Boolean

Whether this cache contains a successfully copied frame from its current source.

historyContentGeneration

var historyContentGeneration: Long

Last copied retained-history replacement/reflow generation.

historySize

var historySize: Int

Retained history lines reported by the most recent frame.

hyperlinkIds

var hyperlinkIds: IntArray

Copied optional hyperlink identifiers in row-major order. Zero means no hyperlink.

images

val images: TerminalRenderImages

Copied placements borrowed with this cache and replaced on update or reset. Individual TerminalRenderImage resources are immutable and may be retained.

lineGenerations

var lineGenerations: LongArray

Cached per-row render generations.

lineHasBlinkingText

var lineHasBlinkingText: BooleanArray

Cached per-row marker for visible cells carrying the SGR blink attribute.

lineIds

var lineIds: LongArray

Cached per-row stable logical line identities.

lineWrapped

var lineWrapped: BooleanArray

Cached per-row soft-wrap flags.