GhosttyRenderStateRowData enum

Queryable data kinds for ghostty_render_state_row_get().

@ingroup render

Inheritance
Available extensions

Values

GHOSTTY_RENDER_STATE_ROW_DATA_INVALID → const GhosttyRenderStateRowData

Invalid / sentinel value.

const GhosttyRenderStateRowData(0)
GHOSTTY_RENDER_STATE_ROW_DATA_DIRTY → const GhosttyRenderStateRowData

Whether the current row is dirty (bool).

const GhosttyRenderStateRowData(1)
GHOSTTY_RENDER_STATE_ROW_DATA_RAW → const GhosttyRenderStateRowData

The raw row value (GhosttyRow).

const GhosttyRenderStateRowData(2)
GHOSTTY_RENDER_STATE_ROW_DATA_CELLS → const GhosttyRenderStateRowData

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.

const GhosttyRenderStateRowData(3)
GHOSTTY_RENDER_STATE_ROW_DATA_SELECTION → const GhosttyRenderStateRowData

Row-local selected cell range (GhosttyRenderStateRowSelection).

const GhosttyRenderStateRowData(4)
GHOSTTY_RENDER_STATE_ROW_DATA_CELLS_RAW → const GhosttyRenderStateRowData

A borrowed view of the raw cell values for the current row (GhosttyCellsView). One value per column, identical to querying GHOSTTY_RENDER_STATE_ROW_CELLS_DATA_RAW for each cell. The view is only valid as long as the underlying render state is not updated; it is unsafe to use after updating the render state.

This is the bulk alternative to iterating cells one at a time. It lets callers with expensive call boundaries (e.g. WebAssembly embedders) read an entire row with a single call.

Bit positions aren't protected by ABI, so callers should parse them out of the manifest from ghostty_type_json. Callers with access to the C header or without high FFI costs should use ghostty_cell_get.

const GhosttyRenderStateRowData(5)
GHOSTTY_RENDER_STATE_ROW_DATA_MAX_VALUE → const GhosttyRenderStateRowData
const GhosttyRenderStateRowData(2147483647)

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
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 setterinherited
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) GhosttyRenderStateRowData

Constants

values → const List<GhosttyRenderStateRowData>
A constant List of the values in this enum, in order of their declaration.