TerminalRenderFrameReader

Provides a short-lived render frame view.

The frame passed to consumer is valid only during the callback. Implementations may hold a terminal mutation lock while invoking consumer. Consumers must copy anything they need before returning.

Functions

Link copied to clipboard

Invokes consumer with a render frame view whose lifetime is limited to this call.

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

Invokes consumer with a render frame for a caller-owned scrollback viewport.

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

Invokes consumer with a render frame for a caller-owned scrollback viewport that may contain more rows than the live terminal grid.