Skip to main content

Crate libghostty_vt_sys

Crate libghostty_vt_sys 

Source

Macros§

sized
Initialize a “sized” FFI object.

Structs§

GhosttyAllocator
Custom memory allocator.
GhosttyAllocatorVtable
Function table for custom memory allocator operations.
GhosttyColorRgb
RGB color value.
GhosttyDeviceAttributes
Device attributes response data for all three DA levels.
GhosttyDeviceAttributesPrimary
Primary device attributes (DA1) response data.
GhosttyDeviceAttributesSecondary
Secondary device attributes (DA2) response data.
GhosttyDeviceAttributesTertiary
Tertiary device attributes (DA3) response data.
GhosttyFormatter
GhosttyFormatterScreenExtra
Extra screen state to include in styled output.
GhosttyFormatterTerminalExtra
Extra terminal state to include in styled output.
GhosttyFormatterTerminalOptions
Options for creating a terminal formatter.
GhosttyGridRef
A resolved reference to a terminal cell position.
GhosttyKeyEncoder
GhosttyKeyEvent
GhosttyMouseEncoder
GhosttyMouseEncoderSize
Mouse encoder size and geometry context.
GhosttyMouseEvent
GhosttyMousePosition
Mouse position in surface-space pixels.
GhosttyOscCommand
GhosttyOscParser
GhosttyPoint
Tagged union for a point in the terminal grid.
GhosttyPointCoordinate
A coordinate in the terminal grid.
GhosttyRenderState
GhosttyRenderStateColors
Render-state color information.
GhosttyRenderStateRowCells
GhosttyRenderStateRowIterator
GhosttySgrAttribute
SGR attribute (tagged union).
GhosttySgrParser
GhosttySgrUnknown
Unknown SGR attribute data.
GhosttySizeReportSize
Terminal size information for encoding size reports.
GhosttyString
A borrowed byte string (pointer + length).
GhosttyStyle
Terminal cell style.
GhosttyStyleColor
Style color (tagged union).
GhosttyTerminal
GhosttyTerminalOptions
Terminal initialization options.
GhosttyTerminalScrollViewport
Tagged union for scroll viewport behavior.
GhosttyTerminalScrollbar
Scrollbar state for the terminal viewport.

Constants§

EXPORTED_API_SYMBOLS
Canonical list of exported libghostty-vt C functions represented by checked-in bindings.
GHOSTTY_COLOR_NAMED_BLACK
GHOSTTY_COLOR_NAMED_BLUE
GHOSTTY_COLOR_NAMED_BRIGHT_BLACK
GHOSTTY_COLOR_NAMED_BRIGHT_BLUE
GHOSTTY_COLOR_NAMED_BRIGHT_CYAN
GHOSTTY_COLOR_NAMED_BRIGHT_GREEN
GHOSTTY_COLOR_NAMED_BRIGHT_MAGENTA
GHOSTTY_COLOR_NAMED_BRIGHT_RED
GHOSTTY_COLOR_NAMED_BRIGHT_WHITE
GHOSTTY_COLOR_NAMED_BRIGHT_YELLOW
GHOSTTY_COLOR_NAMED_CYAN
GHOSTTY_COLOR_NAMED_GREEN
GHOSTTY_COLOR_NAMED_MAGENTA
GHOSTTY_COLOR_NAMED_RED
GHOSTTY_COLOR_NAMED_WHITE
GHOSTTY_COLOR_NAMED_YELLOW
GHOSTTY_DA_CONFORMANCE_LEVEL_2
GHOSTTY_DA_CONFORMANCE_LEVEL_3
GHOSTTY_DA_CONFORMANCE_LEVEL_4
GHOSTTY_DA_CONFORMANCE_LEVEL_5
GHOSTTY_DA_CONFORMANCE_VT100
GHOSTTY_DA_CONFORMANCE_VT101
GHOSTTY_DA_CONFORMANCE_VT102
GHOSTTY_DA_CONFORMANCE_VT125
GHOSTTY_DA_CONFORMANCE_VT131
GHOSTTY_DA_CONFORMANCE_VT132
GHOSTTY_DA_CONFORMANCE_VT220
GHOSTTY_DA_CONFORMANCE_VT240
GHOSTTY_DA_CONFORMANCE_VT320
GHOSTTY_DA_CONFORMANCE_VT340
GHOSTTY_DA_CONFORMANCE_VT420
GHOSTTY_DA_CONFORMANCE_VT510
GHOSTTY_DA_CONFORMANCE_VT520
GHOSTTY_DA_CONFORMANCE_VT525
GHOSTTY_DA_DEVICE_TYPE_VT100
GHOSTTY_DA_DEVICE_TYPE_VT220
GHOSTTY_DA_DEVICE_TYPE_VT240
GHOSTTY_DA_DEVICE_TYPE_VT320
GHOSTTY_DA_DEVICE_TYPE_VT330
GHOSTTY_DA_DEVICE_TYPE_VT340
GHOSTTY_DA_DEVICE_TYPE_VT382
GHOSTTY_DA_DEVICE_TYPE_VT420
GHOSTTY_DA_DEVICE_TYPE_VT510
GHOSTTY_DA_DEVICE_TYPE_VT520
GHOSTTY_DA_DEVICE_TYPE_VT525
GHOSTTY_DA_FEATURE_ANSI_COLOR
GHOSTTY_DA_FEATURE_ANSI_TEXT_LOCATOR
GHOSTTY_DA_FEATURE_CLIPBOARD
GHOSTTY_DA_FEATURE_COLUMNS_132
GHOSTTY_DA_FEATURE_HORIZONTAL_SCROLLING
GHOSTTY_DA_FEATURE_LOCATOR
GHOSTTY_DA_FEATURE_NATIONAL_REPLACEMENT
GHOSTTY_DA_FEATURE_PRINTER
GHOSTTY_DA_FEATURE_RECTANGULAR_EDITING
GHOSTTY_DA_FEATURE_REGIS
GHOSTTY_DA_FEATURE_SELECTIVE_ERASE
GHOSTTY_DA_FEATURE_SIXEL
GHOSTTY_DA_FEATURE_TECHNICAL_CHARACTERS
GHOSTTY_DA_FEATURE_TERMINAL_STATE
GHOSTTY_DA_FEATURE_USER_DEFINED_KEYS
GHOSTTY_DA_FEATURE_WINDOWING
GHOSTTY_KITTY_KEY_ALL
GHOSTTY_KITTY_KEY_DISABLED
GHOSTTY_KITTY_KEY_DISAMBIGUATE
GHOSTTY_KITTY_KEY_REPORT_ALL
GHOSTTY_KITTY_KEY_REPORT_ALTERNATES
GHOSTTY_KITTY_KEY_REPORT_ASSOCIATED
GHOSTTY_KITTY_KEY_REPORT_EVENTS
GHOSTTY_MODS_ALT
GHOSTTY_MODS_ALT_SIDE
GHOSTTY_MODS_CAPS_LOCK
GHOSTTY_MODS_CTRL
GHOSTTY_MODS_CTRL_SIDE
GHOSTTY_MODS_NUM_LOCK
GHOSTTY_MODS_SHIFT
GHOSTTY_MODS_SHIFT_SIDE
GHOSTTY_MODS_SUPER
GHOSTTY_MODS_SUPER_SIDE
GhosttyBuildInfo_GHOSTTY_BUILD_INFO_INVALID
Invalid data type. Never results in any data extraction.
GhosttyBuildInfo_GHOSTTY_BUILD_INFO_KITTY_GRAPHICS
Whether Kitty graphics protocol support is available.
GhosttyBuildInfo_GHOSTTY_BUILD_INFO_OPTIMIZE
The optimization mode the library was built with.
GhosttyBuildInfo_GHOSTTY_BUILD_INFO_SIMD
Whether SIMD-accelerated code paths are enabled.
GhosttyBuildInfo_GHOSTTY_BUILD_INFO_TMUX_CONTROL_MODE
Whether tmux control mode support is available.
GhosttyCellContentTag_GHOSTTY_CELL_CONTENT_BG_COLOR_PALETTE
No text; background color from palette.
GhosttyCellContentTag_GHOSTTY_CELL_CONTENT_BG_COLOR_RGB
No text; background color as RGB.
GhosttyCellContentTag_GHOSTTY_CELL_CONTENT_CODEPOINT
A single codepoint (may be zero for empty).
GhosttyCellContentTag_GHOSTTY_CELL_CONTENT_CODEPOINT_GRAPHEME
A codepoint that is part of a multi-codepoint grapheme cluster.
GhosttyCellData_GHOSTTY_CELL_DATA_CODEPOINT
The codepoint of the cell (0 if empty or bg-color-only).
GhosttyCellData_GHOSTTY_CELL_DATA_COLOR_PALETTE
The palette index for the cell’s background color. Only valid when content_tag is GHOSTTY_CELL_CONTENT_BG_COLOR_PALETTE.
GhosttyCellData_GHOSTTY_CELL_DATA_COLOR_RGB
The RGB value for the cell’s background color. Only valid when content_tag is GHOSTTY_CELL_CONTENT_BG_COLOR_RGB.
GhosttyCellData_GHOSTTY_CELL_DATA_CONTENT_TAG
The content tag describing what kind of content is in the cell.
GhosttyCellData_GHOSTTY_CELL_DATA_HAS_HYPERLINK
Whether the cell has a hyperlink.
GhosttyCellData_GHOSTTY_CELL_DATA_HAS_STYLING
Whether the cell has non-default styling.
GhosttyCellData_GHOSTTY_CELL_DATA_HAS_TEXT
Whether the cell has text to render.
GhosttyCellData_GHOSTTY_CELL_DATA_INVALID
Invalid data type. Never results in any data extraction.
GhosttyCellData_GHOSTTY_CELL_DATA_PROTECTED
Whether the cell is protected.
GhosttyCellData_GHOSTTY_CELL_DATA_SEMANTIC_CONTENT
The semantic content type of the cell (from OSC 133).
GhosttyCellData_GHOSTTY_CELL_DATA_STYLE_ID
The style ID for the cell (for use with style lookups).
GhosttyCellData_GHOSTTY_CELL_DATA_WIDE
The wide property of the cell.
GhosttyCellSemanticContent_GHOSTTY_CELL_SEMANTIC_INPUT
Content that is part of user input.
GhosttyCellSemanticContent_GHOSTTY_CELL_SEMANTIC_OUTPUT
Regular output content, such as command output.
GhosttyCellSemanticContent_GHOSTTY_CELL_SEMANTIC_PROMPT
Content that is part of a shell prompt.
GhosttyCellWide_GHOSTTY_CELL_WIDE_NARROW
Not a wide character, cell width 1.
GhosttyCellWide_GHOSTTY_CELL_WIDE_SPACER_HEAD
Spacer at end of soft-wrapped line for a wide character.
GhosttyCellWide_GHOSTTY_CELL_WIDE_SPACER_TAIL
Spacer after wide character. Do not render.
GhosttyCellWide_GHOSTTY_CELL_WIDE_WIDE
Wide character, cell width 2.
GhosttyColorScheme_GHOSTTY_COLOR_SCHEME_DARK
GhosttyColorScheme_GHOSTTY_COLOR_SCHEME_LIGHT
GhosttyFocusEvent_GHOSTTY_FOCUS_GAINED
Terminal window gained focus
GhosttyFocusEvent_GHOSTTY_FOCUS_LOST
Terminal window lost focus
GhosttyFormatterFormat_GHOSTTY_FORMATTER_FORMAT_HTML
HTML with inline styles.
GhosttyFormatterFormat_GHOSTTY_FORMATTER_FORMAT_PLAIN
Plain text (no escape sequences).
GhosttyFormatterFormat_GHOSTTY_FORMATTER_FORMAT_VT
VT sequences preserving colors, styles, URLs, etc.
GhosttyKeyAction_GHOSTTY_KEY_ACTION_PRESS
Key was pressed
GhosttyKeyAction_GHOSTTY_KEY_ACTION_RELEASE
Key was released
GhosttyKeyAction_GHOSTTY_KEY_ACTION_REPEAT
Key is being repeated (held down)
GhosttyKeyEncoderOption_GHOSTTY_KEY_ENCODER_OPT_ALT_ESC_PREFIX
Terminal DEC mode 1036: alt sends escape prefix (value: bool)
GhosttyKeyEncoderOption_GHOSTTY_KEY_ENCODER_OPT_CURSOR_KEY_APPLICATION
Terminal DEC mode 1: cursor key application mode (value: bool)
GhosttyKeyEncoderOption_GHOSTTY_KEY_ENCODER_OPT_IGNORE_KEYPAD_WITH_NUMLOCK
Terminal DEC mode 1035: ignore keypad with numlock (value: bool)
GhosttyKeyEncoderOption_GHOSTTY_KEY_ENCODER_OPT_KEYPAD_KEY_APPLICATION
Terminal DEC mode 66: keypad key application mode (value: bool)
GhosttyKeyEncoderOption_GHOSTTY_KEY_ENCODER_OPT_KITTY_FLAGS
Kitty keyboard protocol flags (value: GhosttyKittyKeyFlags bitmask)
GhosttyKeyEncoderOption_GHOSTTY_KEY_ENCODER_OPT_MACOS_OPTION_AS_ALT
macOS option-as-alt setting (value: GhosttyOptionAsAlt)
GhosttyKeyEncoderOption_GHOSTTY_KEY_ENCODER_OPT_MODIFY_OTHER_KEYS_STATE_2
xterm modifyOtherKeys mode 2 (value: bool)
GhosttyKey_GHOSTTY_KEY_A
GhosttyKey_GHOSTTY_KEY_ALT_LEFT
GhosttyKey_GHOSTTY_KEY_ALT_RIGHT
GhosttyKey_GHOSTTY_KEY_ARROW_DOWN
GhosttyKey_GHOSTTY_KEY_ARROW_LEFT
GhosttyKey_GHOSTTY_KEY_ARROW_RIGHT
GhosttyKey_GHOSTTY_KEY_ARROW_UP
GhosttyKey_GHOSTTY_KEY_AUDIO_VOLUME_DOWN
GhosttyKey_GHOSTTY_KEY_AUDIO_VOLUME_MUTE
GhosttyKey_GHOSTTY_KEY_AUDIO_VOLUME_UP
GhosttyKey_GHOSTTY_KEY_B
GhosttyKey_GHOSTTY_KEY_BACKQUOTE
GhosttyKey_GHOSTTY_KEY_BACKSLASH
GhosttyKey_GHOSTTY_KEY_BACKSPACE
GhosttyKey_GHOSTTY_KEY_BRACKET_LEFT
GhosttyKey_GHOSTTY_KEY_BRACKET_RIGHT
GhosttyKey_GHOSTTY_KEY_BROWSER_BACK
GhosttyKey_GHOSTTY_KEY_BROWSER_FAVORITES
GhosttyKey_GHOSTTY_KEY_BROWSER_FORWARD
GhosttyKey_GHOSTTY_KEY_BROWSER_HOME
GhosttyKey_GHOSTTY_KEY_BROWSER_REFRESH
GhosttyKey_GHOSTTY_KEY_BROWSER_SEARCH
GhosttyKey_GHOSTTY_KEY_BROWSER_STOP
GhosttyKey_GHOSTTY_KEY_C
GhosttyKey_GHOSTTY_KEY_CAPS_LOCK
GhosttyKey_GHOSTTY_KEY_COMMA
GhosttyKey_GHOSTTY_KEY_CONTEXT_MENU
GhosttyKey_GHOSTTY_KEY_CONTROL_LEFT
GhosttyKey_GHOSTTY_KEY_CONTROL_RIGHT
GhosttyKey_GHOSTTY_KEY_CONVERT
GhosttyKey_GHOSTTY_KEY_COPY
GhosttyKey_GHOSTTY_KEY_CUT
GhosttyKey_GHOSTTY_KEY_D
GhosttyKey_GHOSTTY_KEY_DELETE
GhosttyKey_GHOSTTY_KEY_DIGIT_0
GhosttyKey_GHOSTTY_KEY_DIGIT_1
GhosttyKey_GHOSTTY_KEY_DIGIT_2
GhosttyKey_GHOSTTY_KEY_DIGIT_3
GhosttyKey_GHOSTTY_KEY_DIGIT_4
GhosttyKey_GHOSTTY_KEY_DIGIT_5
GhosttyKey_GHOSTTY_KEY_DIGIT_6
GhosttyKey_GHOSTTY_KEY_DIGIT_7
GhosttyKey_GHOSTTY_KEY_DIGIT_8
GhosttyKey_GHOSTTY_KEY_DIGIT_9
GhosttyKey_GHOSTTY_KEY_E
GhosttyKey_GHOSTTY_KEY_EJECT
GhosttyKey_GHOSTTY_KEY_END
GhosttyKey_GHOSTTY_KEY_ENTER
GhosttyKey_GHOSTTY_KEY_EQUAL
GhosttyKey_GHOSTTY_KEY_ESCAPE
GhosttyKey_GHOSTTY_KEY_F
GhosttyKey_GHOSTTY_KEY_F1
GhosttyKey_GHOSTTY_KEY_F2
GhosttyKey_GHOSTTY_KEY_F3
GhosttyKey_GHOSTTY_KEY_F4
GhosttyKey_GHOSTTY_KEY_F5
GhosttyKey_GHOSTTY_KEY_F6
GhosttyKey_GHOSTTY_KEY_F7
GhosttyKey_GHOSTTY_KEY_F8
GhosttyKey_GHOSTTY_KEY_F9
GhosttyKey_GHOSTTY_KEY_F10
GhosttyKey_GHOSTTY_KEY_F11
GhosttyKey_GHOSTTY_KEY_F12
GhosttyKey_GHOSTTY_KEY_F13
GhosttyKey_GHOSTTY_KEY_F14
GhosttyKey_GHOSTTY_KEY_F15
GhosttyKey_GHOSTTY_KEY_F16
GhosttyKey_GHOSTTY_KEY_F17
GhosttyKey_GHOSTTY_KEY_F18
GhosttyKey_GHOSTTY_KEY_F19
GhosttyKey_GHOSTTY_KEY_F20
GhosttyKey_GHOSTTY_KEY_F21
GhosttyKey_GHOSTTY_KEY_F22
GhosttyKey_GHOSTTY_KEY_F23
GhosttyKey_GHOSTTY_KEY_F24
GhosttyKey_GHOSTTY_KEY_F25
GhosttyKey_GHOSTTY_KEY_FN
GhosttyKey_GHOSTTY_KEY_FN_LOCK
GhosttyKey_GHOSTTY_KEY_G
GhosttyKey_GHOSTTY_KEY_H
GhosttyKey_GHOSTTY_KEY_HELP
GhosttyKey_GHOSTTY_KEY_HOME
GhosttyKey_GHOSTTY_KEY_I
GhosttyKey_GHOSTTY_KEY_INSERT
GhosttyKey_GHOSTTY_KEY_INTL_BACKSLASH
GhosttyKey_GHOSTTY_KEY_INTL_RO
GhosttyKey_GHOSTTY_KEY_INTL_YEN
GhosttyKey_GHOSTTY_KEY_J
GhosttyKey_GHOSTTY_KEY_K
GhosttyKey_GHOSTTY_KEY_KANA_MODE
GhosttyKey_GHOSTTY_KEY_L
GhosttyKey_GHOSTTY_KEY_LAUNCH_APP_1
GhosttyKey_GHOSTTY_KEY_LAUNCH_APP_2
GhosttyKey_GHOSTTY_KEY_LAUNCH_MAIL
GhosttyKey_GHOSTTY_KEY_M
GhosttyKey_GHOSTTY_KEY_MEDIA_PLAY_PAUSE
GhosttyKey_GHOSTTY_KEY_MEDIA_SELECT
GhosttyKey_GHOSTTY_KEY_MEDIA_STOP
GhosttyKey_GHOSTTY_KEY_MEDIA_TRACK_NEXT
GhosttyKey_GHOSTTY_KEY_MEDIA_TRACK_PREVIOUS
GhosttyKey_GHOSTTY_KEY_META_LEFT
GhosttyKey_GHOSTTY_KEY_META_RIGHT
GhosttyKey_GHOSTTY_KEY_MINUS
GhosttyKey_GHOSTTY_KEY_N
GhosttyKey_GHOSTTY_KEY_NON_CONVERT
GhosttyKey_GHOSTTY_KEY_NUMPAD_0
GhosttyKey_GHOSTTY_KEY_NUMPAD_1
GhosttyKey_GHOSTTY_KEY_NUMPAD_2
GhosttyKey_GHOSTTY_KEY_NUMPAD_3
GhosttyKey_GHOSTTY_KEY_NUMPAD_4
GhosttyKey_GHOSTTY_KEY_NUMPAD_5
GhosttyKey_GHOSTTY_KEY_NUMPAD_6
GhosttyKey_GHOSTTY_KEY_NUMPAD_7
GhosttyKey_GHOSTTY_KEY_NUMPAD_8
GhosttyKey_GHOSTTY_KEY_NUMPAD_9
GhosttyKey_GHOSTTY_KEY_NUMPAD_ADD
GhosttyKey_GHOSTTY_KEY_NUMPAD_BACKSPACE
GhosttyKey_GHOSTTY_KEY_NUMPAD_BEGIN
GhosttyKey_GHOSTTY_KEY_NUMPAD_CLEAR
GhosttyKey_GHOSTTY_KEY_NUMPAD_CLEAR_ENTRY
GhosttyKey_GHOSTTY_KEY_NUMPAD_COMMA
GhosttyKey_GHOSTTY_KEY_NUMPAD_DECIMAL
GhosttyKey_GHOSTTY_KEY_NUMPAD_DELETE
GhosttyKey_GHOSTTY_KEY_NUMPAD_DIVIDE
GhosttyKey_GHOSTTY_KEY_NUMPAD_DOWN
GhosttyKey_GHOSTTY_KEY_NUMPAD_END
GhosttyKey_GHOSTTY_KEY_NUMPAD_ENTER
GhosttyKey_GHOSTTY_KEY_NUMPAD_EQUAL
GhosttyKey_GHOSTTY_KEY_NUMPAD_HOME
GhosttyKey_GHOSTTY_KEY_NUMPAD_INSERT
GhosttyKey_GHOSTTY_KEY_NUMPAD_LEFT
GhosttyKey_GHOSTTY_KEY_NUMPAD_MEMORY_ADD
GhosttyKey_GHOSTTY_KEY_NUMPAD_MEMORY_CLEAR
GhosttyKey_GHOSTTY_KEY_NUMPAD_MEMORY_RECALL
GhosttyKey_GHOSTTY_KEY_NUMPAD_MEMORY_STORE
GhosttyKey_GHOSTTY_KEY_NUMPAD_MEMORY_SUBTRACT
GhosttyKey_GHOSTTY_KEY_NUMPAD_MULTIPLY
GhosttyKey_GHOSTTY_KEY_NUMPAD_PAGE_DOWN
GhosttyKey_GHOSTTY_KEY_NUMPAD_PAGE_UP
GhosttyKey_GHOSTTY_KEY_NUMPAD_PAREN_LEFT
GhosttyKey_GHOSTTY_KEY_NUMPAD_PAREN_RIGHT
GhosttyKey_GHOSTTY_KEY_NUMPAD_RIGHT
GhosttyKey_GHOSTTY_KEY_NUMPAD_SEPARATOR
GhosttyKey_GHOSTTY_KEY_NUMPAD_SUBTRACT
GhosttyKey_GHOSTTY_KEY_NUMPAD_UP
GhosttyKey_GHOSTTY_KEY_NUM_LOCK
GhosttyKey_GHOSTTY_KEY_O
GhosttyKey_GHOSTTY_KEY_P
GhosttyKey_GHOSTTY_KEY_PAGE_DOWN
GhosttyKey_GHOSTTY_KEY_PAGE_UP
GhosttyKey_GHOSTTY_KEY_PASTE
GhosttyKey_GHOSTTY_KEY_PAUSE
GhosttyKey_GHOSTTY_KEY_PERIOD
GhosttyKey_GHOSTTY_KEY_POWER
GhosttyKey_GHOSTTY_KEY_PRINT_SCREEN
GhosttyKey_GHOSTTY_KEY_Q
GhosttyKey_GHOSTTY_KEY_QUOTE
GhosttyKey_GHOSTTY_KEY_R
GhosttyKey_GHOSTTY_KEY_S
GhosttyKey_GHOSTTY_KEY_SCROLL_LOCK
GhosttyKey_GHOSTTY_KEY_SEMICOLON
GhosttyKey_GHOSTTY_KEY_SHIFT_LEFT
GhosttyKey_GHOSTTY_KEY_SHIFT_RIGHT
GhosttyKey_GHOSTTY_KEY_SLASH
GhosttyKey_GHOSTTY_KEY_SLEEP
GhosttyKey_GHOSTTY_KEY_SPACE
GhosttyKey_GHOSTTY_KEY_T
GhosttyKey_GHOSTTY_KEY_TAB
GhosttyKey_GHOSTTY_KEY_U
GhosttyKey_GHOSTTY_KEY_UNIDENTIFIED
GhosttyKey_GHOSTTY_KEY_V
GhosttyKey_GHOSTTY_KEY_W
GhosttyKey_GHOSTTY_KEY_WAKE_UP
GhosttyKey_GHOSTTY_KEY_X
GhosttyKey_GHOSTTY_KEY_Y
GhosttyKey_GHOSTTY_KEY_Z
GhosttyModeReportState_GHOSTTY_MODE_REPORT_NOT_RECOGNIZED
Mode is not recognized
GhosttyModeReportState_GHOSTTY_MODE_REPORT_PERMANENTLY_RESET
Mode is permanently reset
GhosttyModeReportState_GHOSTTY_MODE_REPORT_PERMANENTLY_SET
Mode is permanently set
GhosttyModeReportState_GHOSTTY_MODE_REPORT_RESET
Mode is reset (disabled)
GhosttyModeReportState_GHOSTTY_MODE_REPORT_SET
Mode is set (enabled)
GhosttyMouseAction_GHOSTTY_MOUSE_ACTION_MOTION
Mouse moved.
GhosttyMouseAction_GHOSTTY_MOUSE_ACTION_PRESS
Mouse button was pressed.
GhosttyMouseAction_GHOSTTY_MOUSE_ACTION_RELEASE
Mouse button was released.
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_EIGHT
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_ELEVEN
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_FIVE
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_FOUR
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_LEFT
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_MIDDLE
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_NINE
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_RIGHT
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_SEVEN
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_SIX
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_TEN
GhosttyMouseButton_GHOSTTY_MOUSE_BUTTON_UNKNOWN
GhosttyMouseEncoderOption_GHOSTTY_MOUSE_ENCODER_OPT_ANY_BUTTON_PRESSED
Whether any mouse button is currently pressed (value: bool).
GhosttyMouseEncoderOption_GHOSTTY_MOUSE_ENCODER_OPT_EVENT
Mouse tracking mode (value: GhosttyMouseTrackingMode).
GhosttyMouseEncoderOption_GHOSTTY_MOUSE_ENCODER_OPT_FORMAT
Mouse output format (value: GhosttyMouseFormat).
GhosttyMouseEncoderOption_GHOSTTY_MOUSE_ENCODER_OPT_SIZE
Renderer size context (value: GhosttyMouseEncoderSize).
GhosttyMouseEncoderOption_GHOSTTY_MOUSE_ENCODER_OPT_TRACK_LAST_CELL
Whether to enable motion deduplication by last cell (value: bool).
GhosttyMouseFormat_GHOSTTY_MOUSE_FORMAT_SGR
GhosttyMouseFormat_GHOSTTY_MOUSE_FORMAT_SGR_PIXELS
GhosttyMouseFormat_GHOSTTY_MOUSE_FORMAT_URXVT
GhosttyMouseFormat_GHOSTTY_MOUSE_FORMAT_UTF8
GhosttyMouseFormat_GHOSTTY_MOUSE_FORMAT_X10
GhosttyMouseTrackingMode_GHOSTTY_MOUSE_TRACKING_ANY
Any-event tracking mode.
GhosttyMouseTrackingMode_GHOSTTY_MOUSE_TRACKING_BUTTON
Button-event tracking mode.
GhosttyMouseTrackingMode_GHOSTTY_MOUSE_TRACKING_NONE
Mouse reporting disabled.
GhosttyMouseTrackingMode_GHOSTTY_MOUSE_TRACKING_NORMAL
Normal mouse mode (button press/release only).
GhosttyMouseTrackingMode_GHOSTTY_MOUSE_TRACKING_X10
X10 mouse mode.
GhosttyOptimizeMode_GHOSTTY_OPTIMIZE_DEBUG
GhosttyOptimizeMode_GHOSTTY_OPTIMIZE_RELEASE_FAST
GhosttyOptimizeMode_GHOSTTY_OPTIMIZE_RELEASE_SAFE
GhosttyOptimizeMode_GHOSTTY_OPTIMIZE_RELEASE_SMALL
GhosttyOptionAsAlt_GHOSTTY_OPTION_AS_ALT_FALSE
Option key is not treated as alt
GhosttyOptionAsAlt_GHOSTTY_OPTION_AS_ALT_LEFT
Only left option key is treated as alt
GhosttyOptionAsAlt_GHOSTTY_OPTION_AS_ALT_RIGHT
Only right option key is treated as alt
GhosttyOptionAsAlt_GHOSTTY_OPTION_AS_ALT_TRUE
Option key is treated as alt
GhosttyOscCommandData_GHOSTTY_OSC_DATA_CHANGE_WINDOW_TITLE_STR
Window title string data.
GhosttyOscCommandData_GHOSTTY_OSC_DATA_INVALID
Invalid data type. Never results in any data extraction.
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CHANGE_WINDOW_ICON
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CHANGE_WINDOW_TITLE
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CLIPBOARD_CONTENTS
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_COLOR_OPERATION
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_CHANGE_TAB_TITLE
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_COMMENT
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_GUIMACRO
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_OUTPUT_ENVIRONMENT_VARIABLE
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_PROGRESS_REPORT
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_RUN_PROCESS
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_SHOW_MESSAGE_BOX
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_SLEEP
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_WAIT_INPUT
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_CONEMU_XTERM_EMULATION
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_HYPERLINK_END
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_HYPERLINK_START
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_INVALID
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_KITTY_COLOR_PROTOCOL
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_KITTY_TEXT_SIZING
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_MOUSE_SHAPE
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_REPORT_PWD
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_SEMANTIC_PROMPT
GhosttyOscCommandType_GHOSTTY_OSC_COMMAND_SHOW_DESKTOP_NOTIFICATION
GhosttyPointTag_GHOSTTY_POINT_TAG_ACTIVE
Active area where the cursor can move.
GhosttyPointTag_GHOSTTY_POINT_TAG_HISTORY
Scrollback history only (before active area).
GhosttyPointTag_GHOSTTY_POINT_TAG_SCREEN
Full screen including scrollback.
GhosttyPointTag_GHOSTTY_POINT_TAG_VIEWPORT
Visible viewport (changes when scrolled).
GhosttyRenderStateCursorVisualStyle_GHOSTTY_RENDER_STATE_CURSOR_VISUAL_STYLE_BAR
Bar cursor (DECSCUSR 5, 6).
GhosttyRenderStateCursorVisualStyle_GHOSTTY_RENDER_STATE_CURSOR_VISUAL_STYLE_BLOCK
Block cursor (DECSCUSR 1, 2).
GhosttyRenderStateCursorVisualStyle_GHOSTTY_RENDER_STATE_CURSOR_VISUAL_STYLE_BLOCK_HOLLOW
Hollow block cursor.
GhosttyRenderStateCursorVisualStyle_GHOSTTY_RENDER_STATE_CURSOR_VISUAL_STYLE_UNDERLINE
Underline cursor (DECSCUSR 3, 4).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_COLOR_BACKGROUND
Default/current background color (GhosttyColorRgb).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_COLOR_CURSOR
Cursor color when explicitly set by terminal state (GhosttyColorRgb). Returns GHOSTTY_INVALID_VALUE if no explicit cursor color is set; use COLOR_CURSOR_HAS_VALUE to check first.
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_COLOR_CURSOR_HAS_VALUE
Whether an explicit cursor color is set (bool).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_COLOR_FOREGROUND
Default/current foreground color (GhosttyColorRgb).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_COLOR_PALETTE
The active 256-color palette (GhosttyColorRgb[256]).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_COLS
Viewport width in cells (uint16_t).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_CURSOR_BLINKING
Whether the cursor should blink based on terminal modes (bool).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_CURSOR_PASSWORD_INPUT
Whether the cursor is at a password input field (bool).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_CURSOR_VIEWPORT_HAS_VALUE
Whether the cursor is visible within the viewport (bool). If false, the cursor viewport position values are undefined.
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_CURSOR_VIEWPORT_WIDE_TAIL
Whether the cursor is on the tail of a wide character (bool). Only valid when CURSOR_VIEWPORT_HAS_VALUE is true.
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_CURSOR_VIEWPORT_X
Cursor viewport x position in cells (uint16_t). Only valid when CURSOR_VIEWPORT_HAS_VALUE is true.
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_CURSOR_VIEWPORT_Y
Cursor viewport y position in cells (uint16_t). Only valid when CURSOR_VIEWPORT_HAS_VALUE is true.
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_CURSOR_VISIBLE
Whether the cursor is visible based on terminal modes (bool).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_CURSOR_VISUAL_STYLE
The visual style of the cursor (GhosttyRenderStateCursorVisualStyle).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_DIRTY
Current dirty state (GhosttyRenderStateDirty).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_INVALID
Invalid / sentinel value.
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_ROWS
Viewport height in cells (uint16_t).
GhosttyRenderStateData_GHOSTTY_RENDER_STATE_DATA_ROW_ITERATOR
Populate a pre-allocated GhosttyRenderStateRowIterator with row data from the render state (GhosttyRenderStateRowIterator). Row data is only valid as long as the underlying render state is not updated. It is unsafe to use row data after updating the render state.
GhosttyRenderStateDirty_GHOSTTY_RENDER_STATE_DIRTY_FALSE
Not dirty at all; rendering can be skipped.
GhosttyRenderStateDirty_GHOSTTY_RENDER_STATE_DIRTY_FULL
Global state changed; renderer should redraw everything.
GhosttyRenderStateDirty_GHOSTTY_RENDER_STATE_DIRTY_PARTIAL
Some rows changed; renderer can redraw incrementally.
GhosttyRenderStateOption_GHOSTTY_RENDER_STATE_OPTION_DIRTY
Set dirty state (GhosttyRenderStateDirty).
GhosttyRenderStateRowCellsData_GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_BG_COLOR
The resolved background color of the cell (GhosttyColorRgb). Flattens the three possible sources: content-tag bg_color_rgb, content-tag bg_color_palette (looked up in the palette), or the style’s bg_color. Returns GHOSTTY_INVALID_VALUE if the cell has no background color, in which case the caller should use whatever default background color it wants (e.g. the terminal background).
GhosttyRenderStateRowCellsData_GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_FG_COLOR
The resolved foreground color of the cell (GhosttyColorRgb). Resolves palette indices through the palette. Bold color handling is not applied; the caller should handle bold styling separately. Returns GHOSTTY_INVALID_VALUE if the cell has no explicit foreground color, in which case the caller should use whatever default foreground color it wants (e.g. the terminal foreground).
GhosttyRenderStateRowCellsData_GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_GRAPHEMES_BUF
Write grapheme codepoints into a caller-provided buffer (uint32_t*). The buffer must be at least graphemes_len elements. The base codepoint is written first, followed by any extra codepoints.
GhosttyRenderStateRowCellsData_GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_GRAPHEMES_LEN
The total number of grapheme codepoints including the base codepoint (uint32_t). Returns 0 if the cell has no text.
GhosttyRenderStateRowCellsData_GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_INVALID
Invalid / sentinel value.
GhosttyRenderStateRowCellsData_GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_RAW
The raw cell value (GhosttyCell).
GhosttyRenderStateRowCellsData_GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_STYLE
The style for the current cell (GhosttyStyle).
GhosttyRenderStateRowData_GHOSTTY_RENDER_STATE_ROW_DATA_CELLS
Populate a pre-allocated GhosttyRenderStateRowCells with cell data for the current row (GhosttyRenderStateRowCells). Cell data is only valid as long as the underlying render state is not updated. It is unsafe to use cell data after updating the render state.
GhosttyRenderStateRowData_GHOSTTY_RENDER_STATE_ROW_DATA_DIRTY
Whether the current row is dirty (bool).
GhosttyRenderStateRowData_GHOSTTY_RENDER_STATE_ROW_DATA_INVALID
Invalid / sentinel value.
GhosttyRenderStateRowData_GHOSTTY_RENDER_STATE_ROW_DATA_RAW
The raw row value (GhosttyRow).
GhosttyRenderStateRowOption_GHOSTTY_RENDER_STATE_ROW_OPTION_DIRTY
Set dirty state for the current row (bool).
GhosttyResult_GHOSTTY_INVALID_VALUE
Operation failed due to invalid value
GhosttyResult_GHOSTTY_OUT_OF_MEMORY
Operation failed due to failed allocation
GhosttyResult_GHOSTTY_OUT_OF_SPACE
Operation failed because the provided buffer was too small
GhosttyResult_GHOSTTY_SUCCESS
Operation completed successfully
GhosttyRowData_GHOSTTY_ROW_DATA_DIRTY
Whether this row is dirty and requires a redraw.
GhosttyRowData_GHOSTTY_ROW_DATA_GRAPHEME
Whether any cells in this row have grapheme clusters.
GhosttyRowData_GHOSTTY_ROW_DATA_HYPERLINK
Whether any cells in this row have hyperlinks (may have false positives).
GhosttyRowData_GHOSTTY_ROW_DATA_INVALID
Invalid data type. Never results in any data extraction.
GhosttyRowData_GHOSTTY_ROW_DATA_KITTY_VIRTUAL_PLACEHOLDER
Whether this row contains a Kitty virtual placeholder.
GhosttyRowData_GHOSTTY_ROW_DATA_SEMANTIC_PROMPT
The semantic prompt state of this row.
GhosttyRowData_GHOSTTY_ROW_DATA_STYLED
Whether any cells in this row have styling (may have false positives).
GhosttyRowData_GHOSTTY_ROW_DATA_WRAP
Whether this row is soft-wrapped.
GhosttyRowData_GHOSTTY_ROW_DATA_WRAP_CONTINUATION
Whether this row is a continuation of a soft-wrapped row.
GhosttyRowSemanticPrompt_GHOSTTY_ROW_SEMANTIC_NONE
No prompt cells in this row.
GhosttyRowSemanticPrompt_GHOSTTY_ROW_SEMANTIC_PROMPT
Prompt cells exist and this is a primary prompt line.
GhosttyRowSemanticPrompt_GHOSTTY_ROW_SEMANTIC_PROMPT_CONTINUATION
Prompt cells exist and this is a continuation line.
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_BG_8
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_BG_256
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_BLINK
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_BOLD
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_BRIGHT_BG_8
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_BRIGHT_FG_8
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_DIRECT_COLOR_BG
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_DIRECT_COLOR_FG
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_FAINT
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_FG_8
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_FG_256
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_INVERSE
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_INVISIBLE
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_ITALIC
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_OVERLINE
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_BG
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_BLINK
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_BOLD
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_FG
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_INVERSE
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_INVISIBLE
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_ITALIC
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_OVERLINE
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_STRIKETHROUGH
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_RESET_UNDERLINE_COLOR
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_STRIKETHROUGH
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_UNDERLINE
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_UNDERLINE_COLOR
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_UNDERLINE_COLOR_256
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_UNKNOWN
GhosttySgrAttributeTag_GHOSTTY_SGR_ATTR_UNSET
GhosttySgrUnderline_GHOSTTY_SGR_UNDERLINE_CURLY
GhosttySgrUnderline_GHOSTTY_SGR_UNDERLINE_DASHED
GhosttySgrUnderline_GHOSTTY_SGR_UNDERLINE_DOTTED
GhosttySgrUnderline_GHOSTTY_SGR_UNDERLINE_DOUBLE
GhosttySgrUnderline_GHOSTTY_SGR_UNDERLINE_NONE
GhosttySgrUnderline_GHOSTTY_SGR_UNDERLINE_SINGLE
GhosttySizeReportStyle_GHOSTTY_SIZE_REPORT_CSI_14_T
XTWINOPS text area size in pixels: ESC [ 4 ; height ; width t
GhosttySizeReportStyle_GHOSTTY_SIZE_REPORT_CSI_16_T
XTWINOPS cell size in pixels: ESC [ 6 ; height ; width t
GhosttySizeReportStyle_GHOSTTY_SIZE_REPORT_CSI_18_T
XTWINOPS text area size in characters: ESC [ 8 ; rows ; cols t
GhosttySizeReportStyle_GHOSTTY_SIZE_REPORT_MODE_2048
In-band size report (mode 2048): ESC [ 48 ; rows ; cols ; height ; width t
GhosttyStyleColorTag_GHOSTTY_STYLE_COLOR_NONE
GhosttyStyleColorTag_GHOSTTY_STYLE_COLOR_PALETTE
GhosttyStyleColorTag_GHOSTTY_STYLE_COLOR_RGB
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_ACTIVE_SCREEN
The currently active screen.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_COLS
Terminal width in cells.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_CURSOR_PENDING_WRAP
Whether the cursor has a pending wrap (next print will soft-wrap).
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_CURSOR_STYLE
The current SGR style of the cursor.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_CURSOR_VISIBLE
Whether the cursor is visible (DEC mode 25).
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_CURSOR_X
Cursor column position (0-indexed).
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_CURSOR_Y
Cursor row position within the active area (0-indexed).
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_HEIGHT_PX
The total height of the terminal in pixels.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_INVALID
Invalid data type. Never results in any data extraction.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_KITTY_KEYBOARD_FLAGS
Current Kitty keyboard protocol flags.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_MOUSE_TRACKING
Whether any mouse tracking mode is active.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_PWD
The terminal’s current working directory as set by escape sequences (e.g. OSC 7).
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_ROWS
Terminal height in cells.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_SCROLLBACK_ROWS
The number of scrollback rows (total rows minus viewport rows).
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_SCROLLBAR
Scrollbar state for the terminal viewport.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_TITLE
The terminal title as set by escape sequences (e.g. OSC 0/2).
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_TOTAL_ROWS
The total number of rows in the active screen including scrollback.
GhosttyTerminalData_GHOSTTY_TERMINAL_DATA_WIDTH_PX
The total width of the terminal in pixels.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_BELL
Callback invoked when the terminal receives a BEL character (0x07). Set to NULL to ignore bell events.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_COLOR_SCHEME
Callback invoked in response to a color scheme device status report query (CSI ? 996 n). Return true and fill the out pointer to report the current scheme, or return false to silently ignore. Set to NULL to ignore color scheme queries.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_DEVICE_ATTRIBUTES
Callback invoked in response to a device attributes query (CSI c, CSI > c, or CSI = c). Return true and fill the out pointer with response data, or return false to silently ignore. Set to NULL to ignore device attributes queries.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_ENQUIRY
Callback invoked when the terminal receives an ENQ character (0x05). Set to NULL to send no response.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_PWD
Set the terminal working directory manually.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_SIZE
Callback invoked in response to XTWINOPS size queries (CSI 14/16/18 t). Set to NULL to silently ignore size queries.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_TITLE
Set the terminal title manually.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_TITLE_CHANGED
Callback invoked when the terminal title changes via escape sequences (e.g. OSC 0 or OSC 2). Set to NULL to ignore title change events.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_USERDATA
Opaque userdata pointer passed to all callbacks.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_WRITE_PTY
Callback invoked when the terminal needs to write data back to the pty (e.g. in response to a DECRQM query or device status report). Set to NULL to ignore such sequences.
GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_XTVERSION
Callback invoked when the terminal receives an XTVERSION query (CSI > q). Set to NULL to report the default “libghostty” string.
GhosttyTerminalScreen_GHOSTTY_TERMINAL_SCREEN_ALTERNATE
The alternate screen.
GhosttyTerminalScreen_GHOSTTY_TERMINAL_SCREEN_PRIMARY
The primary (normal) screen.
GhosttyTerminalScrollViewportTag_GHOSTTY_SCROLL_VIEWPORT_BOTTOM
Scroll to the bottom (active area).
GhosttyTerminalScrollViewportTag_GHOSTTY_SCROLL_VIEWPORT_DELTA
Scroll by a delta amount (up is negative).
GhosttyTerminalScrollViewportTag_GHOSTTY_SCROLL_VIEWPORT_TOP
Scroll to the top of the scrollback.

Functions§

ghostty_alloc
Allocate a buffer of len bytes.
ghostty_build_info
Query a compile-time build configuration value.
ghostty_cell_get
Get data from a cell.
ghostty_color_rgb_get
Get the RGB color components.
ghostty_focus_encode
Encode a focus event into a terminal escape sequence.
ghostty_formatter_format_alloc
Run the formatter and return an allocated buffer with the output.
ghostty_formatter_format_buf
Run the formatter and produce output into the caller-provided buffer.
ghostty_formatter_free
Free a formatter instance.
ghostty_formatter_terminal_new
Create a formatter for a terminal’s active screen.
ghostty_free
Free memory that was allocated by a libghostty-vt function.
ghostty_grid_ref_cell
Get the cell from a grid reference.
ghostty_grid_ref_graphemes
Get the grapheme cluster codepoints for the cell at the grid reference’s position.
ghostty_grid_ref_row
Get the row from a grid reference.
ghostty_grid_ref_style
Get the style of the cell at the grid reference’s position.
ghostty_key_encoder_encode
Encode a key event into a terminal escape sequence.
ghostty_key_encoder_free
Free a key encoder instance.
ghostty_key_encoder_new
Create a new key encoder instance.
ghostty_key_encoder_setopt
Set an option on the key encoder.
ghostty_key_encoder_setopt_from_terminal
Set encoder options from a terminal’s current state.
ghostty_key_event_free
Free a key event instance.
ghostty_key_event_get_action
Get the key action (press, release, repeat).
ghostty_key_event_get_composing
Get whether the key event is part of a composition sequence.
ghostty_key_event_get_consumed_mods
Get the consumed modifiers bitmask.
ghostty_key_event_get_key
Get the physical key code.
ghostty_key_event_get_mods
Get the modifier keys bitmask.
ghostty_key_event_get_unshifted_codepoint
Get the unshifted Unicode codepoint.
ghostty_key_event_get_utf8
Get the UTF-8 text generated by the key event.
ghostty_key_event_new
Create a new key event instance.
ghostty_key_event_set_action
Set the key action (press, release, repeat).
ghostty_key_event_set_composing
Set whether the key event is part of a composition sequence.
ghostty_key_event_set_consumed_mods
Set the consumed modifiers bitmask.
ghostty_key_event_set_key
Set the physical key code.
ghostty_key_event_set_mods
Set the modifier keys bitmask.
ghostty_key_event_set_unshifted_codepoint
Set the unshifted Unicode codepoint.
ghostty_key_event_set_utf8
Set the UTF-8 text generated by the key event.
ghostty_mode_report_encode
Encode a DECRPM (DEC Private Mode Report) response sequence.
ghostty_mouse_encoder_encode
Encode a mouse event into a terminal escape sequence.
ghostty_mouse_encoder_free
Free a mouse encoder instance.
ghostty_mouse_encoder_new
Create a new mouse encoder instance.
ghostty_mouse_encoder_reset
Reset internal encoder state.
ghostty_mouse_encoder_setopt
Set an option on the mouse encoder.
ghostty_mouse_encoder_setopt_from_terminal
Set encoder options from a terminal’s current state.
ghostty_mouse_event_clear_button
Clear the event button.
ghostty_mouse_event_free
Free a mouse event instance.
ghostty_mouse_event_get_action
Get the event action.
ghostty_mouse_event_get_button
Get the event button.
ghostty_mouse_event_get_mods
Get keyboard modifiers held during the event.
ghostty_mouse_event_get_position
Get the event position in surface-space pixels.
ghostty_mouse_event_new
Create a new mouse event instance.
ghostty_mouse_event_set_action
Set the event action.
ghostty_mouse_event_set_button
Set the event button.
ghostty_mouse_event_set_mods
Set keyboard modifiers held during the event.
ghostty_mouse_event_set_position
Set the event position in surface-space pixels.
ghostty_osc_command_data
Extract data from an OSC command.
ghostty_osc_command_type
Get the type of an OSC command.
ghostty_osc_end
Finalize OSC parsing and retrieve the parsed command.
ghostty_osc_free
Free an OSC parser instance.
ghostty_osc_new
Create a new OSC parser instance.
ghostty_osc_next
Parse the next byte in an OSC sequence.
ghostty_osc_reset
Reset an OSC parser instance to its initial state.
ghostty_paste_is_safe
Check if paste data is safe to paste into the terminal.
ghostty_render_state_colors_get
Get the current color information from a render state.
ghostty_render_state_free
Free a render state instance.
ghostty_render_state_get
Get a value from a render state.
ghostty_render_state_new
Create a new render state instance.
ghostty_render_state_row_cells_free
Free a row cells instance.
ghostty_render_state_row_cells_get
Get a value from the current cell in a render-state row cells iterator.
ghostty_render_state_row_cells_new
Create a new row cells instance.
ghostty_render_state_row_cells_next
Move a render-state row cells iterator to the next cell.
ghostty_render_state_row_cells_select
Move a render-state row cells iterator to a specific column.
ghostty_render_state_row_get
Get a value from the current row in a render-state row iterator.
ghostty_render_state_row_iterator_free
Free a render-state row iterator.
ghostty_render_state_row_iterator_new
Create a new row iterator instance.
ghostty_render_state_row_iterator_next
Move a render-state row iterator to the next row.
ghostty_render_state_row_set
Set an option on the current row in a render-state row iterator.
ghostty_render_state_set
Set an option on a render state.
ghostty_render_state_update
Update a render state instance from a terminal.
ghostty_row_get
Get data from a row.
ghostty_sgr_attribute_tag
Get the tag from an SGR attribute.
ghostty_sgr_attribute_value
Get the value from an SGR attribute.
ghostty_sgr_free
Free an SGR parser instance.
ghostty_sgr_new
Create a new SGR parser instance.
ghostty_sgr_next
Get the next SGR attribute.
ghostty_sgr_reset
Reset an SGR parser instance to the beginning of the parameter list.
ghostty_sgr_set_params
Set SGR parameters for parsing.
ghostty_sgr_unknown_full
Get the full parameter list from an unknown SGR attribute.
ghostty_sgr_unknown_partial
Get the partial parameter list from an unknown SGR attribute.
ghostty_size_report_encode
Encode a terminal size report into an escape sequence.
ghostty_style_default
Get the default style.
ghostty_style_is_default
Check if a style is the default style.
ghostty_terminal_free
Free a terminal instance.
ghostty_terminal_get
Get data from a terminal instance.
ghostty_terminal_grid_ref
Resolve a point in the terminal grid to a grid reference.
ghostty_terminal_mode_get
Get the current value of a terminal mode.
ghostty_terminal_mode_set
Set the value of a terminal mode.
ghostty_terminal_new
Create a new terminal instance.
ghostty_terminal_reset
Perform a full reset of the terminal (RIS).
ghostty_terminal_resize
Resize the terminal to the given dimensions.
ghostty_terminal_scroll_viewport
Scroll the terminal viewport.
ghostty_terminal_set
Set an option on the terminal.
ghostty_terminal_vt_write
Write VT-encoded data to the terminal for processing.

Type Aliases§

GhosttyBuildInfo
Build info data types that can be queried.
GhosttyCell
Opaque cell value.
GhosttyCellContentTag
Cell content tag.
GhosttyCellData
Cell data types.
GhosttyCellSemanticContent
Semantic content type of a cell.
GhosttyCellWide
Cell wide property.
GhosttyColorPaletteIndex
Palette color index (0-255).
GhosttyColorScheme
Color scheme reported in response to a CSI ? 996 n query.
GhosttyFocusEvent
Focus event types for focus reporting mode (mode 1004).
GhosttyFormatterFormat
Output format.
GhosttyFormatter_ptr
Opaque handle to a formatter instance.
GhosttyKey
Physical key codes.
GhosttyKeyAction
Keyboard input event types.
GhosttyKeyEncoderOption
Key encoder option identifiers.
GhosttyKeyEncoder_ptr
Opaque handle to a key encoder instance.
GhosttyKeyEvent_ptr
Opaque handle to a key event.
GhosttyKittyKeyFlags
Kitty keyboard protocol flags.
GhosttyMode
A packed 16-bit terminal mode.
GhosttyModeReportState
DECRPM report state values.
GhosttyMods
Keyboard modifier keys bitmask.
GhosttyMouseAction
Mouse event action type.
GhosttyMouseButton
Mouse button identity.
GhosttyMouseEncoderOption
Mouse encoder option identifiers.
GhosttyMouseEncoder_ptr
Opaque handle to a mouse encoder instance.
GhosttyMouseEvent_ptr
Opaque handle to a mouse event.
GhosttyMouseFormat
Mouse output format.
GhosttyMouseTrackingMode
Mouse tracking mode.
GhosttyOptimizeMode
Build optimization mode.
GhosttyOptionAsAlt
macOS option key behavior.
GhosttyOscCommandData
OSC command data types.
GhosttyOscCommandType
OSC command types.
GhosttyOscCommand_ptr
Opaque handle to a single OSC command.
GhosttyOscParser_ptr
Opaque handle to an OSC parser instance.
GhosttyPointTag
Point reference tag.
GhosttyRenderStateCursorVisualStyle
Visual style of the cursor.
GhosttyRenderStateData
Queryable data kinds for ghostty_render_state_get().
GhosttyRenderStateDirty
Dirty state of a render state after update.
GhosttyRenderStateOption
Settable options for ghostty_render_state_set().
GhosttyRenderStateRowCellsData
Queryable data kinds for ghostty_render_state_row_cells_get().
GhosttyRenderStateRowCells_ptr
Opaque handle to render-state row cells.
GhosttyRenderStateRowData
Queryable data kinds for ghostty_render_state_row_get().
GhosttyRenderStateRowIterator_ptr
Opaque handle to a render-state row iterator.
GhosttyRenderStateRowOption
Settable options for ghostty_render_state_row_set().
GhosttyRenderState_ptr
Opaque handle to a render state instance.
GhosttyResult
Result codes for libghostty-vt operations.
GhosttyRow
Opaque row value.
GhosttyRowData
Row data types.
GhosttyRowSemanticPrompt
Row semantic prompt state.
GhosttySgrAttributeTag
SGR attribute tags.
GhosttySgrParser_ptr
Opaque handle to an SGR parser instance.
GhosttySgrUnderline
Underline style types.
GhosttySizeReportStyle
Size report style.
GhosttyStyleColorTag
Style color tags.
GhosttyStyleId
Style identifier type.
GhosttyTerminalBellFn
Callback function type for bell.
GhosttyTerminalColorSchemeFn
Callback function type for color scheme queries (CSI ? 996 n).
GhosttyTerminalData
Terminal data types.
GhosttyTerminalDeviceAttributesFn
Callback function type for device attributes queries (DA1/DA2/DA3).
GhosttyTerminalEnquiryFn
Callback function type for enquiry (ENQ, 0x05).
GhosttyTerminalOption
Terminal option identifiers.
GhosttyTerminalScreen
Terminal screen identifier.
GhosttyTerminalScrollViewportTag
Scroll viewport behavior tag.
GhosttyTerminalSizeFn
Callback function type for size queries (XTWINOPS).
GhosttyTerminalTitleChangedFn
Callback function type for title_changed.
GhosttyTerminalWritePtyFn
Callback function type for write_pty.
GhosttyTerminalXtversionFn
Callback function type for XTVERSION.
GhosttyTerminal_ptr
Opaque handle to a terminal instance.

Unions§

GhosttyPointValue
Point value union.
GhosttySgrAttributeValue
SGR attribute value union.
GhosttyStyleColorValue
Style color value union.
GhosttyTerminalScrollViewportValue
Scroll viewport value.