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

Package-level declarations

Types

TerminalColorPalette

class TerminalColorPalette(val defaultForeground: Int = 0xFFFFFFFF.toInt(), val defaultBackground: Int = 0xFF000000.toInt(), val selectionForeground: Int = 0xFFFFFFFF.toInt(), val selectionBackground: Int = 0xFF000000.toInt(), val cursorForeground: Int = 0xFF000000.toInt(), val cursorBackground: Int = 0xFFFFFFFF.toInt(), indexedColors: IntArray = defaultIndexedColors(), val boldAsBright: Boolean = true)

Immutable resolved terminal color palette.

TerminalRenderAttrs

object TerminalRenderAttrs

Stable public render attribute word decoder and packer.

TerminalRenderBufferKind

enum TerminalRenderBufferKind : Enum<TerminalRenderBufferKind>

Identifies the visible terminal screen buffer.

TerminalRenderCellFlags

object TerminalRenderCellFlags

Public render cell flag bit set.

TerminalRenderClusterDataSink

fun interface TerminalRenderClusterDataSink

Receives grapheme cluster code points while a row is copied.

TerminalRenderClusterSink

fun interface TerminalRenderClusterSink

Receives grapheme cluster text while a row is copied.

TerminalRenderColorKind

object TerminalRenderColorKind

Color encoding kind used by TerminalRenderAttrs.

TerminalRenderCursor

data class TerminalRenderCursor(val column: Int, val row: Int, val visible: Boolean, val blinking: Boolean, val shape: TerminalRenderCursorShape, val generation: Long)

Stable public cursor overlay model for renderers.

TerminalRenderCursorShape

enum TerminalRenderCursorShape : Enum<TerminalRenderCursorShape>

Renderer-facing cursor shape.

TerminalRenderCursorSink

fun interface TerminalRenderCursorSink

Receives primitive cursor overlay state from a short-lived render frame.

TerminalRenderExtraAttrs

object TerminalRenderExtraAttrs

Stable public render extra-attribute word decoder and packer.

TerminalRenderFrame

interface TerminalRenderFrame

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

TerminalRenderFrameConsumer

fun interface TerminalRenderFrameConsumer

Receives a short-lived TerminalRenderFrame during a render read callback.

TerminalRenderFrameReader

interface TerminalRenderFrameReader

Provides a short-lived render frame view.

TerminalRenderUnderline

object TerminalRenderUnderline

Public render underline style identifiers.