KetraTerm
API · DevelopmentAll versions

withKeyFormatOption

fun withKeyFormatOption(bits: Long, resource: Int, value: Int): Long

Returns bits with one XTFMTKEYS resource replaced, preserving all other bits. This pure primitive operation does not publish or mutate an input state.

Return

updated packed word, ready for an independent TerminalInputState to publish.

Parameters

bits

original coherent packed mode snapshot.

resource

a supported XtermKeyResource identifier; string-action resource 5 is excluded.

value

0 for the default xterm report format, or 1 for CSI-u.

Throws

if the resource or value is unsupported.