GhosttyKittyGraphicsData enum

Queryable data kinds for ghostty_kitty_graphics_get().

@ingroup kitty_graphics

Inheritance
Available extensions

Values

GHOSTTY_KITTY_GRAPHICS_DATA_INVALID → const GhosttyKittyGraphicsData

Invalid / sentinel value.

const GhosttyKittyGraphicsData(0)
GHOSTTY_KITTY_GRAPHICS_DATA_PLACEMENT_ITERATOR → const GhosttyKittyGraphicsData

Populate a pre-allocated placement iterator with placement data from the storage. Iterator data is only valid as long as the underlying terminal is not mutated.

Output type: GhosttyKittyGraphicsPlacementIterator *

const GhosttyKittyGraphicsData(1)
GHOSTTY_KITTY_GRAPHICS_DATA_GENERATION → const GhosttyKittyGraphicsData

Generation stamp of the last content mutation to this storage: any image transmit/replace, placement add, or delete. Zero means the storage has never been mutated (and is therefore empty).

If the generation is unchanged since a previous query, the set of placements and all image data are identical, so placement iteration and image staleness checks can be skipped entirely. Note that placement geometry may still have changed (scrolling and resizing move placements without changing the storage contents), so rendering geometry such as ghostty_kitty_graphics_placement_render_info() must still be recomputed for frames marked dirty.

Stamps are unique and monotonically increasing process-wide: a value observed from any storage never recurs for different content, even across screen switches (main vs. alternate screen have independent storages) or terminal resets. It is therefore safe to key caches on this value alone.

Output type: uint64_t *

const GhosttyKittyGraphicsData(2)
GHOSTTY_KITTY_GRAPHICS_DATA_MAX_VALUE → const GhosttyKittyGraphicsData
const GhosttyKittyGraphicsData(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) → GhosttyKittyGraphicsData

Constants

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