pigui

Documentation

Overview

Package pigui offers a minimal API for building GUIs.

Index

• type DrawEvent
  • func (e DrawEvent) StopPropagation()
• type Element
  • func Attach(parent *Element, x, y, w, h int) *Element
  • func New() *Element
  • func (e *Element) Area() pi.IntArea
  • func (e *Element) Attach(child *Element)
  • func (e *Element) Detach(child *Element)
  • func (e *Element) Draw()
  • func (e *Element) Update()
• type Event
• type UpdateEvent
  • func (e UpdateEvent) StopPropagation()

Types

type DrawEvent

type DrawEvent struct {
	Element    *Element
	HasPointer bool

	Pressed bool
	// contains filtered or unexported fields
}

func (DrawEvent) StopPropagation

func (e DrawEvent) StopPropagation()

call it if you don't want the event to be propagated to children

type Element

type Element struct {
	OnDraw     func(DrawEvent)
	OnUpdate   func(UpdateEvent)
	OnPressed  func(Event)
	OnReleased func(Event)
	OnTapped   func(Event)
	// contains filtered or unexported fields
}

func Attach

func Attach(parent *Element, x, y, w, h int) *Element

Attach attaches a new element with the specified size to the parent.

It returns the newly created element.

func New

func New() *Element

New creates a new GUI root element.

To update and draw the element along with its children, add it to your game loop by calling Element.Update and Element.Draw.

func (*Element) Area

func (e *Element) Area() pi.IntArea

func (*Element) Attach

func (e *Element) Attach(child *Element)

Attach re-attaches an existing element to the parent e.

func (*Element) Detach

func (e *Element) Detach(child *Element)

Detach detaches the specified child element from e.

func (*Element) Draw

func (e *Element) Draw()

Draw should be called from within pi.Draw or by any subscriber listening to piloop.EventDraw events

func (*Element) Update

func (e *Element) Update()

Update should be called from within pi.Update or by any subscriber listening to piloop.EventUpdate events

type Event

type Event struct {
	Element    *Element
	HasPointer bool
}

type UpdateEvent

type UpdateEvent struct {
	Element    *Element
	HasPointer bool
	// contains filtered or unexported fields
}

func (UpdateEvent) StopPropagation

func (e UpdateEvent) StopPropagation()

call it if you don't want the event to be propagated to children