GhosttyKittyGraphicsImageData enum

Queryable data kinds for ghostty_kitty_graphics_image_get().

@ingroup kitty_graphics

Inheritance

• Object
• Enum
• GhosttyKittyGraphicsImageData

Available extensions

• EnumName

Values

GHOSTTY_KITTY_IMAGE_DATA_INVALID → const GhosttyKittyGraphicsImageData

Invalid / sentinel value.

const GhosttyKittyGraphicsImageData(0)

GHOSTTY_KITTY_IMAGE_DATA_ID → const GhosttyKittyGraphicsImageData

The image ID.

Output type: uint32_t *

const GhosttyKittyGraphicsImageData(1)

GHOSTTY_KITTY_IMAGE_DATA_NUMBER → const GhosttyKittyGraphicsImageData

The image number.

Output type: uint32_t *

const GhosttyKittyGraphicsImageData(2)

GHOSTTY_KITTY_IMAGE_DATA_WIDTH → const GhosttyKittyGraphicsImageData

Image width in pixels.

Output type: uint32_t *

const GhosttyKittyGraphicsImageData(3)

GHOSTTY_KITTY_IMAGE_DATA_HEIGHT → const GhosttyKittyGraphicsImageData

Image height in pixels.

Output type: uint32_t *

const GhosttyKittyGraphicsImageData(4)

GHOSTTY_KITTY_IMAGE_DATA_FORMAT → const GhosttyKittyGraphicsImageData

Pixel format of the image. Never GHOSTTY_KITTY_IMAGE_FORMAT_PNG; PNG payloads are decoded to RGBA before storage.

Output type: GhosttyKittyImageFormat *

const GhosttyKittyGraphicsImageData(5)

GHOSTTY_KITTY_IMAGE_DATA_COMPRESSION → const GhosttyKittyGraphicsImageData

Compression of the image. Always GHOSTTY_KITTY_IMAGE_COMPRESSION_NONE; compressed payloads are inflated before storage.

Output type: GhosttyKittyImageCompression *

const GhosttyKittyGraphicsImageData(6)

GHOSTTY_KITTY_IMAGE_DATA_DATA_PTR → const GhosttyKittyGraphicsImageData

Borrowed pointer to the raw pixel data. Valid as long as the underlying terminal is not mutated. Returns GHOSTTY_NO_VALUE when the image metadata is resident but its pixel payload is pending.

The data is always fully decoded, uncompressed pixels in the format reported by GHOSTTY_KITTY_IMAGE_DATA_FORMAT: zlib payloads are inflated and PNG payloads are decoded to RGBA at transmission time, before the image is stored. Consumers can upload this directly to the GPU without any decode step.

For an animated image (Kitty graphics animation, actions a=f/a=a) this is the pixel data of the current animation frame. The image's GHOSTTY_KITTY_IMAGE_DATA_GENERATION changes whenever the current frame changes, so generation-keyed caches remain coherent.

Output type: const uint8_t **

const GhosttyKittyGraphicsImageData(7)

GHOSTTY_KITTY_IMAGE_DATA_DATA_LEN → const GhosttyKittyGraphicsImageData

Length of the raw pixel data in bytes. Always equal to width * height * bytes-per-pixel for the reported format. For a pending image, this is the expected length reserved against the storage limit even though DATA_PTR is not available yet.

Output type: size_t *

const GhosttyKittyGraphicsImageData(8)

GHOSTTY_KITTY_IMAGE_DATA_GENERATION → const GhosttyKittyGraphicsImageData

Generation stamp assigned when this image was added to (or replaced in) the storage. A changed generation for a given image ID means the pixel contents may have changed even when the dimensions, format, and data length are identical (e.g. a retransmission of the same image ID), so texture caches must key staleness on this value rather than on size heuristics.

Stamps are unique and monotonically increasing process-wide and are drawn from the same sequence as GHOSTTY_KITTY_GRAPHICS_DATA_GENERATION. Never zero for a stored image, so zero can be used as an "empty" sentinel by callers. Pending payload completion preserves this value to retain image age; consumers detect that completion through GHOSTTY_KITTY_GRAPHICS_DATA_GENERATION and retry DATA_PTR.

Output type: uint64_t *

const GhosttyKittyGraphicsImageData(9)

GHOSTTY_KITTY_IMAGE_DATA_MAX_VALUE → const GhosttyKittyGraphicsImageData

const GhosttyKittyGraphicsImageData(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) → GhosttyKittyGraphicsImageData

Constants

values → const List<GhosttyKittyGraphicsImageData>

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