screen

Documentation

Index

• type Display
  • func NewDisplay(bgStyle tcell.Style) (*Display, error)
  • func (d *Display) Close()
  • func (d *Display) Draw(elem dtb.Displayer)
  • func (d *Display) ListenForKey() (rune, bool)
  • func (d *Display) ListenForNumber() (int, error)
  • func (d *Display) ReceiveErr() (error, bool)
  • func (d *Display) Start()

Types

type Display

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

Display represents a display that can draw elements to the screen.

func NewDisplay

func NewDisplay(bgStyle tcell.Style) (*Display, error)

NewDisplay creates a new display with the given background style.

Parameters:

• bgStyle: The background style of the display.

Returns:

• *Display: The new display.
• error: An error if the display could not be created.

func (*Display) Close

func (d *Display) Close()

Close closes the display.

func (*Display) Draw

func (d *Display) Draw(elem dtb.Displayer)

Draw draws an element to the display.

Parameters:

• elem: The element to draw.

func (*Display) ListenForKey

func (d *Display) ListenForKey() (rune, bool)

ListenForKey listens for a key event.

Returns:

• rune: The key.
• bool: True if the key was received, false otherwise.

func (*Display) ListenForNumber

func (d *Display) ListenForNumber() (int, error)

ListenForNumber listens for a number.

Returns:

• int: The number.
• error: An error if the number could not be received.

func (*Display) ReceiveErr

func (d *Display) ReceiveErr() (error, bool)

ReceiveErr receives an error from the display.

Returns:

• error: The error.
• bool: True if the error was received, false otherwise.

func (*Display) Start

func (d *Display) Start()

Start starts the display.