screen.h File Reference

#include <stdbool.h>
#include <stdint.h>
#include <ghostty/vt/color.h>
#include <ghostty/vt/types.h>

Go to the source code of this file.

Data Structures
struct	GhosttyCellsView

Typedefs
typedef uint64_t	GhosttyCell
typedef uint64_t	GhosttyRow

Enumerations
enum	GhosttyCellContentTag { GHOSTTY_CELL_CONTENT_CODEPOINT = 0 , GHOSTTY_CELL_CONTENT_CODEPOINT_GRAPHEME = 1 , GHOSTTY_CELL_CONTENT_BG_COLOR_PALETTE = 2 , GHOSTTY_CELL_CONTENT_BG_COLOR_RGB = 3 , GHOSTTY_CELL_CONTENT_TAG_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }
enum	GhosttyCellWide { GHOSTTY_CELL_WIDE_NARROW = 0 , GHOSTTY_CELL_WIDE_WIDE = 1 , GHOSTTY_CELL_WIDE_SPACER_TAIL = 2 , GHOSTTY_CELL_WIDE_SPACER_HEAD = 3 , GHOSTTY_CELL_WIDE_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }
enum	GhosttyCellSemanticContent { GHOSTTY_CELL_SEMANTIC_OUTPUT = 0 , GHOSTTY_CELL_SEMANTIC_INPUT = 1 , GHOSTTY_CELL_SEMANTIC_PROMPT = 2 , GHOSTTY_CELL_SEMANTIC_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }
enum	GhosttyCellData {   GHOSTTY_CELL_DATA_INVALID = 0 , GHOSTTY_CELL_DATA_CODEPOINT = 1 , GHOSTTY_CELL_DATA_CONTENT_TAG = 2 , GHOSTTY_CELL_DATA_WIDE = 3 ,   GHOSTTY_CELL_DATA_HAS_TEXT = 4 , GHOSTTY_CELL_DATA_HAS_STYLING = 5 , GHOSTTY_CELL_DATA_STYLE_ID = 6 , GHOSTTY_CELL_DATA_HAS_HYPERLINK = 7 ,   GHOSTTY_CELL_DATA_PROTECTED = 8 , GHOSTTY_CELL_DATA_SEMANTIC_CONTENT = 9 , GHOSTTY_CELL_DATA_COLOR_PALETTE = 10 , GHOSTTY_CELL_DATA_COLOR_RGB = 11 ,   GHOSTTY_CELL_DATA_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }
enum	GhosttyRowSemanticPrompt { GHOSTTY_ROW_SEMANTIC_NONE = 0 , GHOSTTY_ROW_SEMANTIC_PROMPT = 1 , GHOSTTY_ROW_SEMANTIC_PROMPT_CONTINUATION = 2 , GHOSTTY_ROW_SEMANTIC_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }
enum	GhosttyRowData {   GHOSTTY_ROW_DATA_INVALID = 0 , GHOSTTY_ROW_DATA_WRAP = 1 , GHOSTTY_ROW_DATA_WRAP_CONTINUATION = 2 , GHOSTTY_ROW_DATA_GRAPHEME = 3 ,   GHOSTTY_ROW_DATA_STYLED = 4 , GHOSTTY_ROW_DATA_HYPERLINK = 5 , GHOSTTY_ROW_DATA_SEMANTIC_PROMPT = 6 , GHOSTTY_ROW_DATA_KITTY_VIRTUAL_PLACEHOLDER = 7 ,   GHOSTTY_ROW_DATA_DIRTY = 8 , GHOSTTY_ROW_DATA_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }

Functions
GHOSTTY_API GhosttyResult	ghostty_cell_get (GhosttyCell cell, GhosttyCellData data, void *out)
GHOSTTY_API GhosttyResult	ghostty_cell_get_multi (GhosttyCell cell, size_t count, const GhosttyCellData *keys, void **values, size_t *out_written)
GHOSTTY_API GhosttyResult	ghostty_row_get (GhosttyRow row, GhosttyRowData data, void *out)
GHOSTTY_API GhosttyResult	ghostty_row_get_multi (GhosttyRow row, size_t count, const GhosttyRowData *keys, void **values, size_t *out_written)

Detailed Description

Terminal screen cell and row types.

Definition in file screen.h.