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

TerminalColorPalette

Immutable resolved terminal color palette.

Colors are stored as packed ARGB integers so painting code can resolve cell foreground and background colors without allocating platform color objects per cell.

Parameters

indexedColors

256-entry indexed palette in packed ARGB form.

Constructors

TerminalColorPalette

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

constructor()

Creates the built-in dark palette with host-controlled selection presentation.

Types

Companion

object Companion

Properties

boldAsBright

val boldAsBright: Boolean

whether indexed ANSI 0..7 foreground colors should use bright variants 8..15 when bold is active.

colorBehavior

val colorBehavior: Int

Rendering behavior flags from TerminalColorBehavior, independent of fallback ARGB values.

cursorBackground

val cursorBackground: Int

cursor background ARGB color.

cursorForeground

val cursorForeground: Int

cursor foreground ARGB color.

defaultBackground

val defaultBackground: Int

default background ARGB color.

defaultForeground

val defaultForeground: Int

default foreground ARGB color.

isDark

val isDark: Boolean

host-declared dark/light theme preference, independent of individual color values. Defaults to the built-in dark fallback; hosts with light or custom themes must supply their preference explicitly.

selectionBackground

val selectionBackground: Int

selection background ARGB color.

selectionForeground

val selectionForeground: Int

selection foreground ARGB color.

Functions

background

fun background(attrWord: Long): Int

Resolves the background color for attrWord.

copy

fun copy(defaultForeground: Int = this.defaultForeground, defaultBackground: Int = this.defaultBackground, selectionForeground: Int = this.selectionForeground, selectionBackground: Int = this.selectionBackground, cursorForeground: Int = this.cursorForeground, cursorBackground: Int = this.cursorBackground, indexedColors: IntArray = indexedColorStorage, boldAsBright: Boolean = this.boldAsBright, isDark: Boolean = this.isDark): TerminalColorPalette

Creates a palette with selected properties replaced.

copyIndexedColorsInto

fun copyIndexedColorsInto(destination: IntArray, offset: Int = 0)

Copies the indexed palette into destination.

copyWithColorBehavior

fun copyWithColorBehavior(colorBehavior: Int, defaultForeground: Int = this.defaultForeground, defaultBackground: Int = this.defaultBackground, selectionForeground: Int = this.selectionForeground, selectionBackground: Int = this.selectionBackground, cursorForeground: Int = this.cursorForeground, cursorBackground: Int = this.cursorBackground, indexedColors: IntArray = indexedColorStorage, boldAsBright: Boolean = this.boldAsBright, isDark: Boolean = this.isDark): TerminalColorPalette

Creates a palette replacing colorBehavior and selected colors together.

equals

open operator override fun equals(other: Any?): Boolean

foreground

fun foreground(attrWord: Long): Int

Resolves the foreground color for attrWord.

hashCode

open override fun hashCode(): Int

indexedColor

fun indexedColor(index: Int): Int

Returns an indexed palette color without exposing mutable palette storage.

toIndexedColorsArray

fun toIndexedColorsArray(): IntArray

Returns a newly allocated copy of the indexed palette.

toString

open override fun toString(): String