renderer

Documentation

Index

• type Renderer
  • func NewRenderer(ctx context.Context, info *terminfo.Terminfo, initialSize geom.Size, ...) *Renderer
  • func (r *Renderer) Kill()
  • func (r *Renderer) Read(p []byte) (n int, err error)
  • func (r *Renderer) Resize(size geom.Size) error
  • func (r *Renderer) Send(msg mux.Msg)
  • func (r *Renderer) Write(data []byte) (n int, err error)

Types

type Renderer

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

A Renderer produces the stream of bytes necessary to render a Screen to a destination terminal. Conceptually, it is the opposite of a Screen, which takes a Stream and feeds it to a virtual terminal emulator. A Renderer takes a Screen and makes a Stream. This is useful because a Stream may produce many more writes than are actually necessary to change the screen; a Renderer can make optimizations to only update the parts of the screen that have changed.

func NewRenderer

func NewRenderer(
	ctx context.Context,
	info *terminfo.Terminfo,
	initialSize geom.Size,
	screen mux.Screen,
) *Renderer

func (*Renderer) Kill

func (r *Renderer) Kill()

func (*Renderer) Read

func (r *Renderer) Read(p []byte) (n int, err error)

func (*Renderer) Resize

func (r *Renderer) Resize(size geom.Size) error

func (*Renderer) Send

func (r *Renderer) Send(msg mux.Msg)

func (*Renderer) Write

func (r *Renderer) Write(data []byte) (n int, err error)