cui

Documentation

Index

• type Point
• type Rect
• type Screen
  • func NewScreen() (*Screen, error)
  • func (screen *Screen) Close() error
  • func (screen *Screen) Flush() error
  • func (screen *Screen) Lock()
  • func (screen *Screen) Run() error
  • func (screen *Screen) Size() (width, height int)
  • func (screen *Screen) Unlock()
  • func (screen *Screen) Write(data []byte) (int, error)

Types

type Point

type Point struct{ X, Y int }

Point is a 2D coordinate in console

X is the column
Y is the row

type Rect

type Rect struct{ Min, Max Point }

Rect is a 2D rectangle in console, excluding Max edge

type Screen

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

Screen is a writable area on screen

func NewScreen

func NewScreen() (*Screen, error)

NewScreen returns a new screen, only one screen can be use at a time.

func (*Screen) Close

func (screen *Screen) Close() error

Close closes the screen.

func (*Screen) Flush

func (screen *Screen) Flush() error

Flush flushes pending content to the console and clears for new frame.

func (*Screen) Lock

func (screen *Screen) Lock()

Lock screen for exclusive rendering

func (*Screen) Run

func (screen *Screen) Run() error

Run runs the event loop

func (*Screen) Size

func (screen *Screen) Size() (width, height int)

Size returns the current size of the screen.

func (*Screen) Unlock

func (screen *Screen) Unlock()

Unlock screen

func (*Screen) Write

func (screen *Screen) Write(data []byte) (int, error)

Write writes to the screen.