render.h

Go to the documentation of this file.

 
#ifndef GHOSTTY_VT_RENDER_H
#define GHOSTTY_VT_RENDER_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <ghostty/vt/allocator.h>
#include <ghostty/vt/color.h>
#include <ghostty/vt/terminal.h>
#include <ghostty/vt/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif


typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_DIRTY_FALSE = 0,

  GHOSTTY_RENDER_STATE_DIRTY_PARTIAL = 1,

  GHOSTTY_RENDER_STATE_DIRTY_FULL = 2,
  GHOSTTY_RENDER_STATE_DIRTY_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateDirty;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_CURSOR_VISUAL_STYLE_BAR = 0,

  GHOSTTY_RENDER_STATE_CURSOR_VISUAL_STYLE_BLOCK = 1,

  GHOSTTY_RENDER_STATE_CURSOR_VISUAL_STYLE_UNDERLINE = 2,

  GHOSTTY_RENDER_STATE_CURSOR_VISUAL_STYLE_BLOCK_HOLLOW = 3,
  GHOSTTY_RENDER_STATE_CURSOR_VISUAL_STYLE_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateCursorVisualStyle;

typedef struct {
  uint16_t above;

  uint16_t below;
} GhosttyRenderStateOverscan;

typedef struct {
  uint64_t bits[2];
} GhosttyRenderStateRowId;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_DATA_INVALID = 0,

  GHOSTTY_RENDER_STATE_DATA_COLS = 1,

  GHOSTTY_RENDER_STATE_DATA_ROWS = 2,

  GHOSTTY_RENDER_STATE_DATA_DIRTY = 3,

  GHOSTTY_RENDER_STATE_DATA_ROW_ITERATOR = 4,

  GHOSTTY_RENDER_STATE_DATA_COLOR_BACKGROUND = 5,

  GHOSTTY_RENDER_STATE_DATA_COLOR_FOREGROUND = 6,

  GHOSTTY_RENDER_STATE_DATA_COLOR_CURSOR = 7,

  GHOSTTY_RENDER_STATE_DATA_COLOR_CURSOR_HAS_VALUE = 8,

  GHOSTTY_RENDER_STATE_DATA_COLOR_PALETTE = 9,

  GHOSTTY_RENDER_STATE_DATA_CURSOR_VISUAL_STYLE = 10,

  GHOSTTY_RENDER_STATE_DATA_CURSOR_VISIBLE = 11,

  GHOSTTY_RENDER_STATE_DATA_CURSOR_BLINKING = 12,

  GHOSTTY_RENDER_STATE_DATA_CURSOR_PASSWORD_INPUT = 13,

  GHOSTTY_RENDER_STATE_DATA_CURSOR_VIEWPORT_HAS_VALUE = 14,

  GHOSTTY_RENDER_STATE_DATA_CURSOR_VIEWPORT_X = 15,

  GHOSTTY_RENDER_STATE_DATA_CURSOR_VIEWPORT_Y = 16,

  GHOSTTY_RENDER_STATE_DATA_CURSOR_VIEWPORT_WIDE_TAIL = 17,

  GHOSTTY_RENDER_STATE_DATA_CURSOR = 18,

  GHOSTTY_RENDER_STATE_DATA_COLORS = 19,

  GHOSTTY_RENDER_STATE_DATA_OVERSCAN = 20,

  GHOSTTY_RENDER_STATE_DATA_OVERSCAN_REQUEST = 21,

  GHOSTTY_RENDER_STATE_DATA_IMAGE_ITERATOR = 22,

  GHOSTTY_RENDER_STATE_DATA_IMAGE_PLACEMENTS_GENERATION = 23,
  GHOSTTY_RENDER_STATE_DATA_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateData;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_OPTION_DIRTY = 0,

  GHOSTTY_RENDER_STATE_OPTION_OVERSCAN = 1,
  GHOSTTY_RENDER_STATE_OPTION_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateOption;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_IMAGE_PROTOCOL_KITTY = 0,
  GHOSTTY_IMAGE_PROTOCOL_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyImageProtocol;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_IMAGE_LAYER_BELOW_BACKGROUND = 0,

  GHOSTTY_RENDER_STATE_IMAGE_LAYER_BELOW_TEXT = 1,

  GHOSTTY_RENDER_STATE_IMAGE_LAYER_ABOVE_TEXT = 2,
  GHOSTTY_RENDER_STATE_IMAGE_LAYER_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateImageLayer;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_KITTY_PLACEMENT_KIND_VIRTUAL = 0,

  GHOSTTY_RENDER_STATE_KITTY_PLACEMENT_KIND_RELATIVE = 1,

  GHOSTTY_RENDER_STATE_KITTY_PLACEMENT_KIND_FIXED = 2,
  GHOSTTY_RENDER_STATE_KITTY_PLACEMENT_KIND_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateKittyPlacementKind;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_IMAGE_DATA_INVALID = 0,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_PROTOCOL = 1,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_IMAGE_ID = 2,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_IMAGE_GENERATION = 3,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_LAYER = 4,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_Z = 5,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_VIEWPORT_COL = 6,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_VIEWPORT_ROW = 7,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_GRID_COLS = 8,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_GRID_ROWS = 9,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_CELL_OFFSET_X = 10,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_CELL_OFFSET_Y = 11,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_PIXEL_WIDTH = 12,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_PIXEL_HEIGHT = 13,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_SOURCE_X = 14,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_SOURCE_Y = 15,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_SOURCE_WIDTH = 16,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_SOURCE_HEIGHT = 17,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_KITTY_PLACEMENT_ID = 18,

  GHOSTTY_RENDER_STATE_IMAGE_DATA_KITTY_KIND = 19,
  GHOSTTY_RENDER_STATE_IMAGE_DATA_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateImageData;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_ROW_DATA_INVALID = 0,

  GHOSTTY_RENDER_STATE_ROW_DATA_DIRTY = 1,

  GHOSTTY_RENDER_STATE_ROW_DATA_RAW = 2,

  GHOSTTY_RENDER_STATE_ROW_DATA_CELLS = 3,

  GHOSTTY_RENDER_STATE_ROW_DATA_SELECTION = 4,

  GHOSTTY_RENDER_STATE_ROW_DATA_CELLS_RAW = 5,

  GHOSTTY_RENDER_STATE_ROW_DATA_VIEWPORT_Y = 6,

  GHOSTTY_RENDER_STATE_ROW_DATA_ID = 7,
  GHOSTTY_RENDER_STATE_ROW_DATA_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateRowData;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_ROW_OPTION_DIRTY = 0,
  GHOSTTY_RENDER_STATE_ROW_OPTION_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateRowOption;

typedef struct {
  size_t size;

  uint16_t start_x;

  uint16_t end_x;
} GhosttyRenderStateRowSelection;

typedef struct {
  size_t size;

  bool viewport_has_value;

  uint16_t viewport_x;

  uint16_t viewport_y;

  bool wide_tail;

  bool visible;

  bool blinking;

  bool password_input;

  GhosttyRenderStateCursorVisualStyle visual_style;
} GhosttyRenderStateCursor;

typedef struct {
  size_t size;

  GhosttyColorRgb background;

  GhosttyColorRgb foreground;

  GhosttyColorRgb cursor;

  bool cursor_has_value;

  GhosttyColorRgb palette[256];
} GhosttyRenderStateColors;

GHOSTTY_API GhosttyResult ghostty_render_state_new(const GhosttyAllocator* allocator,
                                       GhosttyRenderState* state);

GHOSTTY_API void ghostty_render_state_free(GhosttyRenderState state);

GHOSTTY_API GhosttyResult ghostty_render_state_update(GhosttyRenderState state,
                                          GhosttyTerminal terminal);

GHOSTTY_API GhosttyResult ghostty_render_state_begin_update(GhosttyRenderState state,
                                                GhosttyTerminal terminal);

GHOSTTY_API GhosttyResult ghostty_render_state_end_update(GhosttyRenderState state);

GHOSTTY_API GhosttyResult ghostty_render_state_clean(GhosttyRenderState state);

GHOSTTY_API GhosttyResult ghostty_render_state_get(GhosttyRenderState state,
                                        GhosttyRenderStateData data,
                                        void* out);

GHOSTTY_API GhosttyResult ghostty_render_state_get_multi(
    GhosttyRenderState state,
    size_t count,
    const GhosttyRenderStateData* keys,
    void** values,
    size_t* out_written);

GHOSTTY_API GhosttyResult ghostty_render_state_set(GhosttyRenderState state,
                                       GhosttyRenderStateOption option,
                                       const void* value);

GHOSTTY_API GhosttyResult ghostty_render_state_row_iterator_new(
    const GhosttyAllocator* allocator,
    GhosttyRenderStateRowIterator* out_iterator);

GHOSTTY_API void ghostty_render_state_row_iterator_free(GhosttyRenderStateRowIterator iterator);

GHOSTTY_API bool ghostty_render_state_row_iterator_next(GhosttyRenderStateRowIterator iterator);

GHOSTTY_API bool ghostty_render_state_row_iterator_next_dirty(
    GhosttyRenderStateRowIterator iterator,
    uint16_t* out_y);

GHOSTTY_API GhosttyResult ghostty_render_state_row_get(
    GhosttyRenderStateRowIterator iterator,
    GhosttyRenderStateRowData data,
    void* out);

GHOSTTY_API GhosttyResult ghostty_render_state_row_get_multi(
    GhosttyRenderStateRowIterator iterator,
    size_t count,
    const GhosttyRenderStateRowData* keys,
    void** values,
    size_t* out_written);

GHOSTTY_API GhosttyResult ghostty_render_state_row_set(
    GhosttyRenderStateRowIterator iterator,
    GhosttyRenderStateRowOption option,
    const void* value);

GHOSTTY_API GhosttyResult ghostty_render_state_row_cells_new(
    const GhosttyAllocator* allocator,
    GhosttyRenderStateRowCells* out_cells);

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_INVALID = 0,

  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_RAW = 1,

  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_STYLE = 2,

  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_GRAPHEMES_LEN = 3,

  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_GRAPHEMES_BUF = 4,

  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_BG_COLOR = 5,

  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_FG_COLOR = 6,

  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_SELECTED = 7,

  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_HAS_STYLING = 8,

  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_GRAPHEMES_UTF8 = 9,
  GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyRenderStateRowCellsData;

GHOSTTY_API bool ghostty_render_state_row_cells_next(GhosttyRenderStateRowCells cells);

GHOSTTY_API GhosttyResult ghostty_render_state_row_cells_select(
    GhosttyRenderStateRowCells cells, uint16_t x);

GHOSTTY_API GhosttyResult ghostty_render_state_row_cells_get(
    GhosttyRenderStateRowCells cells,
    GhosttyRenderStateRowCellsData data,
    void* out);

GHOSTTY_API GhosttyResult ghostty_render_state_row_cells_get_multi(
    GhosttyRenderStateRowCells cells,
    size_t count,
    const GhosttyRenderStateRowCellsData* keys,
    void** values,
    size_t* out_written);

GHOSTTY_API void ghostty_render_state_row_cells_free(GhosttyRenderStateRowCells cells);

GHOSTTY_API GhosttyResult ghostty_render_state_image_iterator_new(
    const GhosttyAllocator* allocator,
    GhosttyRenderStateImageIterator* out_iterator);

GHOSTTY_API void ghostty_render_state_image_iterator_free(
    GhosttyRenderStateImageIterator iterator);

GHOSTTY_API bool ghostty_render_state_image_iterator_next(
    GhosttyRenderStateImageIterator iterator);

GHOSTTY_API GhosttyResult ghostty_render_state_image_get(
    GhosttyRenderStateImageIterator iterator,
    GhosttyRenderStateImageData data,
    void* out);

GHOSTTY_API GhosttyResult ghostty_render_state_image_get_multi(
    GhosttyRenderStateImageIterator iterator,
    size_t count,
    const GhosttyRenderStateImageData* keys,
    void** values,
    size_t* out_written);

 
#ifdef __cplusplus
}
#endif
 
#endif /* GHOSTTY_VT_RENDER_H */