screen

Documentation

Index

• Variables
• type Buffer
  • func NewBuffer(rows, cols int) *Buffer
• type CellReader
• type Screen
  • func NewScreen(rows, cols int, updates Updates) (*Screen, error)
  • func (s *Screen) AppendCell(pos state.Pos, r rune) error
  • func (s *Screen) BeginTx() state.ModifyTx
  • func (s *Screen) ClearRect(r state.Rect) error
  • func (s *Screen) GetCell(row, col int) *ScreenCell
  • func (s *Screen) MoveCursor(pos state.Pos) error
  • func (s *Screen) Output(data []byte) error
  • func (s *Screen) Resize(rows, cols int, lines []state.LineInfo) error
  • func (s *Screen) RowString(row int) string
  • func (s *Screen) ScrollRect(r state.ScrollRect) error
  • func (s *Screen) SetCell(pos state.Pos, val state.CellRune) error
  • func (s *Screen) SetPenProp(prop state.PenAttr, val interface{}, ps state.PenState) error
  • func (s *Screen) SetTermProp(prop state.TermAttr, val interface{}) error
  • func (s *Screen) StringEvent(kind string, data []byte) error
  • func (s *Screen) WriteToFile(path string) error
• type ScreenCell
  • func (s *ScreenCell) Pen() *ScreenPen
  • func (s *ScreenCell) Value() (rune, []rune)
• type ScreenPen
• type ScrollBack
• type Tx
  • func (tx *Tx) AppendCell(pos state.Pos, r rune) error
  • func (tx *Tx) Close() error
  • func (tx *Tx) SetCell(pos state.Pos, val state.CellRune) error
• type Updates

Variables

var ErrOutOfBounds = errors.New("position of out bounds")

Types

type Buffer

type Buffer struct {
	// contains filtered or unexported fields
}

func NewBuffer

func NewBuffer(rows, cols int) *Buffer

type CellReader

type CellReader interface {
	GetCell(row, col int) *ScreenCell
}

type Screen

type Screen struct {
	// contains filtered or unexported fields
}

func NewScreen

func NewScreen(rows, cols int, updates Updates) (*Screen, error)

func (*Screen) AppendCell

func (s *Screen) AppendCell(pos state.Pos, r rune) error

func (*Screen) BeginTx

func (s *Screen) BeginTx() state.ModifyTx

func (*Screen) ClearRect

func (s *Screen) ClearRect(r state.Rect) error

func (*Screen) GetCell

func (s *Screen) GetCell(row, col int) *ScreenCell

func (*Screen) MoveCursor

func (s *Screen) MoveCursor(pos state.Pos) error

func (*Screen) Output

func (s *Screen) Output(data []byte) error

func (*Screen) Resize

func (s *Screen) Resize(rows, cols int, lines []state.LineInfo) error

func (*Screen) RowString

func (s *Screen) RowString(row int) string

func (*Screen) ScrollRect

func (s *Screen) ScrollRect(r state.ScrollRect) error

func (*Screen) SetCell

func (s *Screen) SetCell(pos state.Pos, val state.CellRune) error

func (*Screen) SetPenProp

func (s *Screen) SetPenProp(prop state.PenAttr, val interface{}, ps state.PenState) error

func (*Screen) SetTermProp

func (s *Screen) SetTermProp(prop state.TermAttr, val interface{}) error

func (*Screen) StringEvent

func (s *Screen) StringEvent(kind string, data []byte) error

func (*Screen) WriteToFile

func (s *Screen) WriteToFile(path string) error

type ScreenCell

type ScreenCell struct {
	// contains filtered or unexported fields
}

func (*ScreenCell) Pen

func (s *ScreenCell) Pen() *ScreenPen

func (*ScreenCell) Value

func (s *ScreenCell) Value() (rune, []rune)

type ScreenPen

type ScreenPen struct {
	state.PenState
}

type ScrollBack

type ScrollBack interface {
	AddScrollBack(row []rune) error
}

type Tx

type Tx struct {
	// contains filtered or unexported fields
}

func (*Tx) AppendCell

func (tx *Tx) AppendCell(pos state.Pos, r rune) error

func (*Tx) Close

func (tx *Tx) Close() error

func (*Tx) SetCell

func (tx *Tx) SetCell(pos state.Pos, val state.CellRune) error

type Updates

type Updates interface {
	DamageDone(r state.Rect, cr CellReader) error
	MoveCursor(p state.Pos) error
	SetTermProp(attr state.TermAttr, val interface{}) error
	Output(data []byte) error
	StringEvent(kind string, data []byte) error
}