TerminalRenderExtraAttrs

Stable public render extra-attribute word decoder and packer.

This word carries less common attributes so renderers that do not need them can pass null for extraAttrWords and avoid the extra copy channel.

The bit layout is:

  • bits 0..1: underline color kind.

  • bits 2..25: underline color value.

  • bit 26: overline.

  • bits 27..63: reserved and currently zero.

Properties

Link copied to clipboard
const val DEFAULT: Long = 0

Empty extra attributes.

Functions

Link copied to clipboard
fun isOverline(word: Long): Boolean

Returns whether overline decoration is enabled.

Link copied to clipboard
fun pack(underlineColorKind: Int = TerminalRenderColorKind.DEFAULT, underlineColorValue: Int = 0, overline: Boolean = false): Long

Packs a public render extra-attribute word.

Link copied to clipboard

Returns the underline color kind.

Link copied to clipboard

Returns the underline color value.