render.h File Reference

#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>

Go to the source code of this file.

Data Structures
struct	GhosttyRenderStateRowSelection
struct	GhosttyRenderStateCursor
struct	GhosttyRenderStateColors

Enumerations
enum	GhosttyRenderStateDirty { 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 }
enum	GhosttyRenderStateCursorVisualStyle { 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 }
enum	GhosttyRenderStateData {   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_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }
enum	GhosttyRenderStateOption { GHOSTTY_RENDER_STATE_OPTION_DIRTY = 0 , GHOSTTY_RENDER_STATE_OPTION_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }
enum	GhosttyRenderStateRowData {   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_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }
enum	GhosttyRenderStateRowOption { GHOSTTY_RENDER_STATE_ROW_OPTION_DIRTY = 0 , GHOSTTY_RENDER_STATE_ROW_OPTION_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE }
enum	GhosttyRenderStateRowCellsData {   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 }

Functions
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)
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)

Detailed Description

Render state for creating high performance renderers.

Definition in file render.h.