Documentation
¶
Overview ¶
Package terminalimage writes native images, image fonts, or color-block previews.
Index ¶
- Variables
- func CellSize(fd uintptr) (width, height int)
- func DecodePreview(ctx context.Context, source io.Reader) (image.Image, error)
- func FontPreviewColumns(bounds image.Rectangle, columns, rows int) int
- func FontSupported() bool
- func PrepareKittyOutput(ctx context.Context, out io.Writer) (context.Context, func() error)
- func ReadSaved(ctx context.Context, path string) (image.Image, error)
- func ReadSavedMatching(ctx context.Context, path string, expected [sha256.Size]byte) (image.Image, error)
- func RunKittyOutputHelper(args []string) (bool, error)
- func Write(ctx context.Context, w io.Writer, img image.Image, protocol string, ...) error
- func WriteProgress(ctx context.Context, w io.Writer, img image.Image, protocol string, ...) error
- type FontError
Constants ¶
This section is empty.
Variables ¶
var ErrSavedImageChanged = errors.New("saved image contents changed before preview")
ErrSavedImageChanged means the preview bytes differ from the completed save.
Functions ¶
func CellSize ¶ added in v1.28.0
CellSize reads the text cell dimensions from existing window metadata without sending terminal queries or consuming input. Only their ratio is significant. When dimensions are missing or ambiguous, use the conventional 1-by-2 estimate.
func DecodePreview ¶ added in v1.28.0
DecodePreview decodes temporary image bytes using the same optional-preview limits as saved images. It never writes a file or limits the API response.
func FontPreviewColumns ¶ added in v1.28.0
FontPreviewColumns also fits the gallery's immutable row allocation. Gallery placements assume cells twice as tall as wide, regardless of the font; the bitmap itself still preserves proportions within those allocated cells.
func FontSupported ¶
func FontSupported() bool
FontSupported identifies a local Apple Terminal session. Font registration and tab control must never target a remote shell or a terminal multiplexer.
func PrepareKittyOutput ¶ added in v1.36.0
PrepareKittyOutput binds the writer before a command reads input or waits for the API. Preparation errors are deferred until a preview actually uses it. Close reports helper failures only after use, preserving non-preview paths.
func ReadSaved ¶
ReadSaved decodes an optional preview. These limits protect terminal rendering; they never limit the API response or change the original saved image.
func ReadSavedMatching ¶
func ReadSavedMatching(ctx context.Context, path string, expected [sha256.Size]byte) (image.Image, error)
ReadSavedMatching previews only the response bytes recorded by a prior save. Both identity checks and decoding apply to the same bounded snapshot, so a replaced path or a rewritten open file cannot substitute another image.
func RunKittyOutputHelper ¶ added in v1.36.0
RunKittyOutputHelper handles only the private resident writer invocation. The process itself owns output. Parent death exits it even during a blocked write, and the parent can always kill and reap its direct child on failure.
func Write ¶
Write displays img at the requested width in terminal cells, preserving its aspect ratio. The caller selects the protocol and supplies a terminal writer.
func WriteProgress ¶ added in v1.28.0
func WriteProgress(ctx context.Context, w io.Writer, img image.Image, protocol string, columns int) error
WriteProgress uses the same renderer as a final image, while leaving capacity for one final font preview. Sharp progress keeps immutable private cache files because changing their glyphs would change earlier terminal scrollback.
Source Files