KetraTerm
API · DevelopmentAll versions

readRenderFrame

open override fun readRenderFrame(consumer: TerminalRenderFrameConsumer)

Reads a short-lived render frame while holding the terminal mutation lock.

UI callers should use this session-level reader rather than reading the core buffer directly, so parser output and resize cannot mutate the grid while a renderer copies primitive row data. Frames and their backing arrays are borrowed for the callback only. The callback must not block on UI work, close the session, or reenter mutation.

Parameters

consumer

the frame consumer to invoke.


open override fun readRenderFrame(scrollbackOffset: Int, consumer: TerminalRenderFrameConsumer)

Reads a render frame with a specified scrollback offset.

Parameters

scrollbackOffset

whole-row offset from the live viewport.

consumer

the frame consumer to invoke.


open override fun readRenderFrame(scrollbackOffset: Int, viewportRows: Int, consumer: TerminalRenderFrameConsumer)

Reads a render frame with a specified scrollback offset and viewport rows limit.

Parameters

scrollbackOffset

whole-row offset from the live viewport.

viewportRows

row count requested.

consumer

the frame consumer to invoke.