vt

package module

Go to main page

Versions in this module

v0

v0.5.1

Sep 5, 2026

Changes in this version

+ const DamageScrollDown

v0.5.0

Sep 5, 2026

Changes in this version

+ var ErrHistoryCorrupt = errors.New("corrupt compressed history page")

+ var ErrHistoryRowTooLarge = errors.New("history row exceeds logical byte capacity")

+ var ErrInvalidHistoryConfig = errors.New("invalid history configuration")

+ var NewCellPayload = core.NewCellPayload

+ type CellPayload = core.CellPayload

+ type CellSource = core.CellSource

type DecodeStats

+ func MeasureHistoryBlob(data []byte) (DecodeStats, error)

type History

+ func (h *History) ByteCap() uint64

+ func (h *History) CompressIdle(maxPages int) (int, error)

+ func (h *History) CompressionStats() HistoryCompressionStats

+ func (h *History) Limits() HistoryConfig

+ func (h *History) LogicalBytes() uint64

+ func (h *History) SetLimits(config HistoryConfig) error

type HistoryChunk

+ func (c *HistoryChunk) CheckInvariants() error

+ func (c *HistoryChunk) Restore() error

+ type HistoryCompressionStats struct

+ ColdPages int

+ CompressedBytes uint64

+ ResidentLogicalBytes uint64

+ Restores uint64

type HistoryConfig

+ MaxBytes uint64

+ func (c HistoryConfig) Validate() error

type HistorySnapshotView

+ func (v HistorySnapshotView) LogicalBytes() uint64

type HistoryView

+ func (v HistoryView) Cell(x, y int) renderer.Cell

+ func (v HistoryView) CopyRow(y int, dst []renderer.Cell) int

+ func (v HistoryView) LogicalBytes() uint64

+ func (v HistoryView) RowWidth(y int) int

type Screen

+ func (s *Screen) Cell(x, y int) renderer.Cell

+ func (s *Screen) Columns() int

+ func (s *Screen) RowCells(y int) []renderer.Cell

+ func (s *Screen) Rows() int

type ScreenSnapshot

+ func (s ScreenSnapshot) Cell(x, y int) renderer.Cell

v0.4.2

Aug 27, 2026

v0.4.1

Aug 26, 2026

v0.4.0

Aug 26, 2026

Changes in this version

+ type Geometry struct

+ Cols int

+ PixelHeight int

+ PixelWidth int

+ Rows int

+ func (g Geometry) PixelsKnown() bool

+ func (g Geometry) Valid() bool

type Screen

+ func (s *Screen) Geometry() Geometry

+ func (s *Screen) GraphicsSnapshot() *graphics.Snapshot

+ func (s *Screen) SetGeometry(geometry Geometry)

type ScreenSnapshot

+ func (s ScreenSnapshot) Graphics() *graphics.Snapshot

v0.3.0

Aug 18, 2026

v0.2.1

Aug 9, 2026

v0.2.0

Aug 9, 2026

v0.1.0

Aug 9, 2026

Changes in this version

+ const AttrBlink

+ const AttrDim

+ const AttrStrikethrough

+ const AttrUnderline

+ const ColorSchemeReportDark

+ const ColorSchemeReportLight

+ const DamageClear

+ const DamageFullRedraw

+ const DamageScrollUp

+ const DamageText

+ const UnderlineCurly

+ const UnderlineDashed

+ const UnderlineDotted

+ const UnderlineDouble

+ const UnderlineNone

+ const UnderlineSingle

+ var BlankCell = vtcore.BlankCell

+ var DefaultStyle = vtcore.DefaultStyle

+ var ErrHistoryRowTooWide = errors.New("history row exceeds cell capacity")

+ var FullRedraw = vtcore.FullRedraw

+ var NewFrame = vtcore.NewFrame

+ func MarshalEmptyHistoryTail() ([]byte, error)

+ func MarshalHistory(view HistoryView) ([]byte, error)

+ func MarshalHistoryChunk(chunk *HistoryChunk) ([]byte, error)

+ func MarshalHistoryTail(view HistorySnapshotView) ([]byte, error)

+ func MarshalSealedHistory(view HistoryView) ([][]byte, []byte, error)

+ func RuneWidth(r rune) int

+ type Cell = vtcore.Cell

+ type CursorSnapshot struct

+ Col int

+ Row int

+ Style int

+ StyleSet bool

+ Visible bool

+ type Damage = vtcore.Damage

+ type DamageCapture struct

+ Damage []renderer.Damage

+ Generation uint64

+ type DamageKind = vtcore.DamageKind

+ type DecodeStats struct

+ Bytes uint64

+ Cells uint64

+ Chunks uint64

+ Rows uint64

+ Styles uint64

+ func PreflightHistoryBlob(data []byte) (DecodeStats, error)

+ func (s *DecodeStats) Add(other DecodeStats) bool

+ type Frame = vtcore.Frame

+ type History struct

+ func HistoryFromBlobs(config HistoryConfig, sealed [][]byte, tail []byte) (*History, error)

+ func NewHistory(config HistoryConfig) *History

+ func (h *History) Append(row []renderer.Cell, bound LineBound) error

+ func (h *History) AppendWithID(row []renderer.Cell, bound LineBound, id RowID) error

+ func (h *History) Cap() int

+ func (h *History) CellCap() int

+ func (h *History) Cells() int

+ func (h *History) Len() int

+ func (h *History) NextRowID() RowID

+ func (h *History) SealAndView() HistoryView

+ func (h *History) SnapshotView() HistorySnapshotView

+ func (h *History) View() HistoryView

+ type HistoryChunk struct

+ func (c *HistoryChunk) RowID(i int) RowID

+ type HistoryConfig struct

+ ChunkRows int

+ MaxCells int

+ MaxRows int

+ type HistorySnapshotView struct

+ func (v HistorySnapshotView) Cells() int

+ func (v HistorySnapshotView) Chunk(i int) *HistoryChunk

+ func (v HistorySnapshotView) ChunkCount() int

+ func (v HistorySnapshotView) Len() int

+ func (v HistorySnapshotView) NextRowID() RowID

+ func (v HistorySnapshotView) Tail() HistoryView

+ type HistoryView struct

+ func UnmarshalHistory(data []byte) (HistoryView, error)

+ func (v HistoryView) BorrowedRow(i int) []renderer.Cell

+ func (v HistoryView) Bound(i int) LineBound

+ func (v HistoryView) Cells() int

+ func (v HistoryView) Chunk(i int) *HistoryChunk

+ func (v HistoryView) ChunkCount() int

+ func (v HistoryView) FindRowID(id RowID) int

+ func (v HistoryView) Len() int

+ func (v HistoryView) NextRowID() RowID

+ func (v HistoryView) Range(yield func([]renderer.Cell) bool)

+ func (v HistoryView) Row(i int) []renderer.Cell

+ func (v HistoryView) RowID(i int) RowID

+ type LineBound struct

+ End int

+ Soft bool

+ type ModeSnapshot struct

+ AlternateScreen bool

+ BracketedPaste bool

+ ColorSchemeMode bool

+ MouseSGR bool

+ MouseTracking int

+ SynchronizedUpdate bool

+ type RGB = vtcore.RGB

+ type RecoveryTranscriptSnapshot struct

+ func (snapshot RecoveryTranscriptSnapshot) Marshal() ([]byte, error)

+ type RowID uint64

+ type Screen struct

+ Col int

+ Frame renderer.Frame

+ OnBell func()

+ OnClipboard func(b64 string)

+ OnLineEvicted func([]renderer.Cell)

+ OnNotify func(title, body string)

+ OnProgress func(errored bool)

+ OnResponse func([]byte)

+ Row int

+ Style renderer.Style

+ func NewScreen(width, height int) *Screen

+ func NewScreenWithHistory(width, height int, config HistoryConfig) *Screen

+ func NewScreenWithRecoveryTranscript(width, height int, config HistoryConfig, sealed [][]byte, ...) (*Screen, error)

+ func (s *Screen) AcknowledgeDamage(generation uint64) bool

+ func (s *Screen) AltScreenActive() bool

+ func (s *Screen) BracketedPasteMode() bool

+ func (s *Screen) CaptureDamage() DamageCapture

+ func (s *Screen) ClearColorScheme()

+ func (s *Screen) ClearDamage()

+ func (s *Screen) ColorSchemeMode() bool

+ func (s *Screen) CursorCol() int

+ func (s *Screen) CursorRow() int

+ func (s *Screen) CursorStyle() (int, bool)

+ func (s *Screen) CursorVisible() bool

+ func (s *Screen) Damage() []renderer.Damage

+ func (s *Screen) ForceSyncEnd()

+ func (s *Screen) History() *History

+ func (s *Screen) LineBounds() []LineBound

+ func (s *Screen) MouseMode() (int, bool)

+ func (s *Screen) RecoveryTranscriptSnapshot() RecoveryTranscriptSnapshot

+ func (s *Screen) Resize(width, height int)

+ func (s *Screen) RowID(y int) RowID

+ func (s *Screen) RowIDs() []RowID

+ func (s *Screen) SetColorScheme(light bool)

+ func (s *Screen) SetDefaultColors(fg, bg renderer.RGB, ok bool)

+ func (s *Screen) Snapshot() ScreenSnapshot

+ func (s *Screen) SyncUpdateActive() bool

+ func (s *Screen) TerminalTitle() string

+ func (s *Screen) Write(data []byte)

+ type ScreenSnapshot struct

+ func (s ScreenSnapshot) BorrowedRow(y int) []renderer.Cell

+ func (s ScreenSnapshot) Bound(y int) LineBound

+ func (s ScreenSnapshot) Columns() int

+ func (s ScreenSnapshot) Cursor() CursorSnapshot

+ func (s ScreenSnapshot) Modes() ModeSnapshot

+ func (s ScreenSnapshot) NextRowID() RowID

+ func (s ScreenSnapshot) Row(y int) []renderer.Cell

+ func (s ScreenSnapshot) RowID(y int) RowID

+ func (s ScreenSnapshot) RowIDs() []RowID

+ func (s ScreenSnapshot) Rows() int

+ func (s ScreenSnapshot) Title() string

+ type Style = vtcore.Style

+ type StyleAttrs = vtcore.StyleAttrs

+ type UnderlineStyle = vtcore.UnderlineStyle

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL