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

TerminalRenderCellFlags

object TerminalRenderCellFlags

Public render cell flag bit set.

Valid combinations are:

Properties

const val CLUSTER: Int

This cell contains a grapheme cluster delivered through TerminalRenderClusterSink.

const val CODEPOINT: Int

The corresponding code word contains a Unicode scalar value.

const val EMPTY: Int

No glyph should be drawn for this cell.

const val WIDE_LEADING: Int

This cell is the leading cell of a width-2 glyph or cluster.

const val WIDE_TRAILING: Int

This cell is the trailing continuation cell of a width-2 glyph or cluster. Renderers must not draw text for this cell.

const val WRAP_PADDING: Int

Artificial final-column blank inserted when a width-2 glyph moves to the next physical row. Valid only with EMPTY, at the last column of a row whose TerminalRenderFrame.lineWrapped is true.

Functions

isValidCombination

fun isValidCombination(flags: Int): Boolean

Returns whether flags is one of the valid public render cell flag combinations.