GhosttyRenderStateRowCellsData enum

Queryable data kinds for ghostty_render_state_row_cells_get().

@ingroup render

Inheritance

• Object
• Enum
• GhosttyRenderStateRowCellsData

Available extensions

• EnumName

Values

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_INVALID → const GhosttyRenderStateRowCellsData

Invalid / sentinel value.

const GhosttyRenderStateRowCellsData(0)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_RAW → const GhosttyRenderStateRowCellsData

The raw cell value (GhosttyCell).

const GhosttyRenderStateRowCellsData(1)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_STYLE → const GhosttyRenderStateRowCellsData

The style for the current cell (GhosttyStyle).

const GhosttyRenderStateRowCellsData(2)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_GRAPHEMES_LEN → const GhosttyRenderStateRowCellsData

The total number of grapheme codepoints including the base codepoint (uint32_t). Returns 0 if the cell has no text.

const GhosttyRenderStateRowCellsData(3)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_GRAPHEMES_BUF → const GhosttyRenderStateRowCellsData

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.

const GhosttyRenderStateRowCellsData(4)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_BG_COLOR → const GhosttyRenderStateRowCellsData

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

const GhosttyRenderStateRowCellsData(5)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_FG_COLOR → const GhosttyRenderStateRowCellsData

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

const GhosttyRenderStateRowCellsData(6)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_SELECTED → const GhosttyRenderStateRowCellsData

Whether the cell is contained within the current selection (bool). This returns true when the cell's column is within the current row's row-local selection range, and false otherwise. Rendering policy for selected cells (colors, inversion, etc.) is left to the caller.

Renderers that can draw cells in spans may be more efficient querying GHOSTTY_RENDER_STATE_ROW_DATA_SELECTION once per row and applying that range directly, avoiding one C API call per cell for selection state.

const GhosttyRenderStateRowCellsData(7)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_HAS_STYLING → const GhosttyRenderStateRowCellsData

Whether the cell has any explicit styling (bool). This is equivalent to querying the raw cell's GHOSTTY_CELL_DATA_HAS_STYLING value, but avoids materializing the raw GhosttyCell for renderers that only need to know whether fetching the full style is necessary.

const GhosttyRenderStateRowCellsData(8)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_GRAPHEMES_UTF8 → const GhosttyRenderStateRowCellsData

Encode the current cell's full grapheme cluster as UTF-8 into a caller-provided buffer (GhosttyBuffer).

The base codepoint is encoded first, followed by any extra grapheme codepoints. Returns GHOSTTY_SUCCESS with len=0 when the cell has no text.

If ptr is NULL or cap is too small for a non-empty cell, returns GHOSTTY_OUT_OF_SPACE without writing any bytes and sets len to the required buffer size in bytes.

const GhosttyRenderStateRowCellsData(9)

GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_MAX_VALUE → const GhosttyRenderStateRowCellsData

const GhosttyRenderStateRowCellsData(2147483647)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

value → int

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromValue(int value) → GhosttyRenderStateRowCellsData

Constants

values → const List<GhosttyRenderStateRowCellsData>

A constant List of the values in this enum, in order of their declaration.