termimage

type Environment struct {
	Term          string
	TermProgram   string
	LCTerminal    string
	KittyWindowID string
	ColorTerm     string
	Tmux          string
	Screen        string

	ForcedProtocol string
	Debug          bool
	DebugFile      string
}

type Mode string

type Protocol string

type Request struct {
	Path     string
	MaxCols  int
	MaxRows  int
	Mode     Mode
	Protocol Protocol

	// Background is used by text-based renderers when compositing transparent
	// pixels. If nil or transparent, a dark terminal-style fallback is used.
	Background color.Color

	// AllowEscapeUploads is reserved for callers that want to explicitly document
	// whether they can emit Upload out-of-band. Protocol selection currently uses
	// Protocol=ansi/none for text-only operation.
	AllowEscapeUploads bool

	// CellWidthPx/CellHeightPx optionally override terminal cell pixel size.
	// When zero, the renderer tries to detect the size and falls back to 10x20.
	CellWidthPx  int
	CellHeightPx int

	// SliceStartRow/SliceRows request a vertical cell slice of the scaled image.
	// This is used by redrawable viewport integrations that need to display only
	// the visible portion of an image. Zero SliceRows means render the full image.
	SliceStartRow int
	SliceRows     int
}

type Result struct {
	Protocol Protocol

	// Upload contains terminal control bytes that must be emitted directly to the
	// terminal, outside any line-wrapping/slicing viewport content.
	Upload string
	// Place contains terminal control bytes that create/update the visible image
	// placement after Upload has completed. It is separate for redrawable viewport
	// integrations that need to gate placeholders until both transmit and
	// placement commands have been flushed.
	Place string
	// Display is safe for the requested output surface. For Kitty viewport mode it
	// is only the Unicode placeholder grid. For ANSI it is ordinary ANSI text.
	Display string
	// Full is a one-shot convenience string equal to Upload + Place + Display.
	Full string

	WidthCells  int
	HeightCells int

	ImageID     uint32
	PlacementID uint32

	TextFallback string
	CacheKey     string
	Warnings     []string
}

type Strategy struct {
	Protocol Protocol
	Name     string
	Warnings []string
}