Documentation
¶
Index ¶
- Constants
- func ClearKittyImages() string
- func ConvertImageToANSI(img image.Image, defaultBGColor color.Color) string
- type CachedPreview
- type ImagePreviewCache
- type ImagePreviewer
- func (p *ImagePreviewer) ANSIRenderer(img image.Image, defaultBGColor string, maxWidth int, maxHeight int) (string, error)
- func (p *ImagePreviewer) ClearKittyImages() string
- func (p *ImagePreviewer) ImagePreview(path string, maxWidth int, maxHeight int, defaultBGColor string, ...) (string, error)
- func (p *ImagePreviewer) ImagePreviewWithRenderer(path string, maxWidth int, maxHeight int, defaultBGColor string, ...) (string, error)
- func (p *ImagePreviewer) InitTerminalCapabilities()
- func (p *ImagePreviewer) IsKittyCapable() bool
- type ImageRenderer
- type TerminalCapabilities
- type TerminalCellSize
Constants ¶
const ( DefaultPixelsPerColumn = 10 // approximate pixels per terminal column DefaultPixelsPerRow = 20 // approximate pixels per terminal row )
Terminal cell to pixel conversion constants These approximate the pixel dimensions of terminal cells
Variables ¶
This section is empty.
Functions ¶
func ClearKittyImages ¶ added in v1.3.2
func ClearKittyImages() string
ClearKittyImages clears all Kitty protocol images from the terminal
Types ¶
type CachedPreview ¶ added in v1.3.2
type CachedPreview struct {
Preview string
Timestamp time.Time
Renderer ImageRenderer
Dimensions string // "width,height,bgColor,sideAreaWidth"
}
CachedPreview represents a cached image preview
type ImagePreviewCache ¶ added in v1.3.2
type ImagePreviewCache struct {
// contains filtered or unexported fields
}
ImagePreviewCache stores cached image previews
func NewImagePreviewCache ¶ added in v1.3.2
func NewImagePreviewCache(maxEntries int, expiration time.Duration) *ImagePreviewCache
NewImagePreviewCache creates a new image preview cache
func (*ImagePreviewCache) Get ¶ added in v1.3.2
func (c *ImagePreviewCache) Get(path, dimensions string, renderer ImageRenderer) (string, bool)
Get retrieves a cached preview if available
func (*ImagePreviewCache) Set ¶ added in v1.3.2
func (c *ImagePreviewCache) Set(path, dimensions, preview string, renderer ImageRenderer)
Set stores a preview in the cache
type ImagePreviewer ¶ added in v1.3.2
type ImagePreviewer struct {
// contains filtered or unexported fields
}
ImagePreviewer encapsulates image preview functionality with caching
func NewImagePreviewer ¶ added in v1.3.2
func NewImagePreviewer() *ImagePreviewer
NewImagePreviewer creates a new ImagePreviewer with default cache settings
func NewImagePreviewerWithConfig ¶ added in v1.3.2
func NewImagePreviewerWithConfig(maxEntries int, expiration time.Duration) *ImagePreviewer
NewImagePreviewerWithConfig creates a new ImagePreviewer with custom cache configuration
func (*ImagePreviewer) ANSIRenderer ¶ added in v1.3.2
func (p *ImagePreviewer) ANSIRenderer(img image.Image, defaultBGColor string, maxWidth int, maxHeight int) (string, error)
Convert image to ansi
func (*ImagePreviewer) ClearKittyImages ¶ added in v1.3.2
func (p *ImagePreviewer) ClearKittyImages() string
ClearKittyImages clears all Kitty protocol images from the terminal
func (*ImagePreviewer) ImagePreview ¶ added in v1.3.2
func (p *ImagePreviewer) ImagePreview(path string, maxWidth int, maxHeight int, defaultBGColor string, sideAreaWidth int) (string, error)
ImagePreview generates a preview of an image file
func (*ImagePreviewer) ImagePreviewWithRenderer ¶ added in v1.3.2
func (p *ImagePreviewer) ImagePreviewWithRenderer(path string, maxWidth int, maxHeight int, defaultBGColor string, renderer ImageRenderer, sideAreaWidth int) (string, error)
ImagePreviewWithRenderer generates an image preview using the specified renderer
func (*ImagePreviewer) InitTerminalCapabilities ¶ added in v1.3.2
func (p *ImagePreviewer) InitTerminalCapabilities()
InitTerminalCapabilities initializes terminal capabilities for the ImagePreviewer
func (*ImagePreviewer) IsKittyCapable ¶ added in v1.3.2
func (p *ImagePreviewer) IsKittyCapable() bool
IsKittyCapable checks if the terminal supports Kitty graphics protocol
type ImageRenderer ¶ added in v1.3.2
type ImageRenderer int
const ( RendererANSI ImageRenderer = iota RendererKitty )
type TerminalCapabilities ¶ added in v1.3.2
type TerminalCapabilities struct {
// contains filtered or unexported fields
}
TerminalCapabilities encapsulates terminal capability detection
func NewTerminalCapabilities ¶ added in v1.3.2
func NewTerminalCapabilities() *TerminalCapabilities
NewTerminalCapabilities creates a new TerminalCapabilities instance
func (*TerminalCapabilities) GetTerminalCellSize ¶ added in v1.3.2
func (tc *TerminalCapabilities) GetTerminalCellSize() TerminalCellSize
GetTerminalCellSize returns the current terminal cell size If detection hasn't been initialized, it performs detection first
func (*TerminalCapabilities) InitTerminalCapabilities ¶ added in v1.3.2
func (tc *TerminalCapabilities) InitTerminalCapabilities()
InitTerminalCapabilities initializes all terminal capabilities detection including cell size and Kitty Graphics Protocol support This should be called early in the application startup
type TerminalCellSize ¶ added in v1.3.2
TerminalCellSize represents the pixel dimensions of terminal cells
Source Files