tinygui

README

Tiny Gui

A minimal material design based UI toolkit for Tiny Go projects.

Warning: This library is in an alpha state there is currently no API stability guarantee.

Why

Microcontrollers have limited ram and flash storage a tyical UI toolkit will will require the construction of a component tree at run time that consumes ram. This component tree often includes both the structural definition of the UI and the state of the UI components. Through careful coding a component tree could be constructed as a compile time constant but such a UI would not be very dynamic.

How

A Tiny Gui is instead created by rendering UI components in sequence programmatically in this way the component structure is guaranted to be in flash memory and through the usage of normal control flow statements (if,for) complex dynamic UIs can be constructed. This is often referred to as an immediate mode gui.

TinyGui additionaly performs zero allocations during rendering. The only memory usage is the stack during rendering and the minimal state for the components. When not actively rendering the only memory usage is the state of the components.

Basic Example

This example will toggle an LED when a button is clicked.

package toggleled

import (
	"github.com/spearson78/tinygui"
	"github.com/spearson78/tinygui/component"

	"machine"
)

//State variable to track whether LED is on or off
var LedState bool

//State for Toggle Button
var btnToggleLed component.ButtonState

//Gui Function GuiContext is provided by Tiny Gui
func ToggleLedGui(g *tinygui.GuiContext) {

	//Create button props including default values based on current theme
	btnToggleProps := component.NewButtonProps(g)

	//Set position and Size of the button
	btnToggleProps.X = 10
	btnToggleProps.Y = 10
	btnToggleProps.W = 220
	btnToggleProps.H = 50

	//Set the label of the button
	btnToggleProps.Label = "TOGGLE LED"

	//Set the style of the button
	btnToggleProps.Style = component.Contained

	//Render the Button and handle the click
	if component.Button(g, &btnToggleLed, &btnToggleProps) {
		//component.Button returns true if the button was clicked
		LedState = !LedState
		machine.LED.Set(LedState)
	}
}

See the examples and cmd folders for more examples

Screenshots

Documentation

Index

• type ClippedDisplay
  • func (r *ClippedDisplay) Display() error
  • func (r *ClippedDisplay) FillRect(x, y, w, h int16, c color.RGBA)
  • func (r *ClippedDisplay) SetPixel(x, y int16, c color.RGBA)
  • func (r *ClippedDisplay) Size() (int16, int16)
• type Component
• type Displayer
• type GuiContext
  • func (t *GuiContext) Invalidate(clearDisplay bool)
  • func (t *GuiContext) InvalidateRect(x0, y0, x1, y1 int16, clearDisplay bool)
  • func (t *GuiContext) UpdateState()
• type TinyGui
  • func New(d Displayer, t touch.Pointer, theme theme.Theme, ...) *TinyGui
  • func (t *TinyGui) DoTouchNonBlocking() *GuiContext
  • func (t *TinyGui) Init()
  • func (t *TinyGui) UpdateState()
• type TouchCalibration
• type TouchSource

Types

type ClippedDisplay

type ClippedDisplay struct {
	D        Displayer
	ClipRect image.Rectangle
}

func (*ClippedDisplay) Display

func (r *ClippedDisplay) Display() error

func (*ClippedDisplay) FillRect

func (r *ClippedDisplay) FillRect(x, y, w, h int16, c color.RGBA)

func (*ClippedDisplay) SetPixel

func (r *ClippedDisplay) SetPixel(x, y int16, c color.RGBA)

func (*ClippedDisplay) Size

func (r *ClippedDisplay) Size() (int16, int16)

type Component

type Component func(g *GuiContext)

type Displayer

type Displayer interface {
	drivers.Displayer
	FillRect(x, y, w, h int16, c color.RGBA)
}

type GuiContext

type GuiContext struct {
	Display Displayer
	Theme   theme.Theme
	Event   event.Event

	TriggerUpdateState bool
	TriggerInvalidate  bool
	ClearDisplay       bool

	InvalidX0 int16
	InvalidY0 int16
	InvalidX1 int16
	InvalidY1 int16
}

func (*GuiContext) Invalidate

func (t *GuiContext) Invalidate(clearDisplay bool)

func (*GuiContext) InvalidateRect

func (t *GuiContext) InvalidateRect(x0, y0, x1, y1 int16, clearDisplay bool)

func (*GuiContext) UpdateState

func (t *GuiContext) UpdateState()

type TinyGui

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

func New

func New(d Displayer, t touch.Pointer, theme theme.Theme, touchCalibration TouchCalibration) *TinyGui

func (*TinyGui) DoTouchNonBlocking

func (t *TinyGui) DoTouchNonBlocking() *GuiContext

func (*TinyGui) Init

func (t *TinyGui) Init()

func (*TinyGui) UpdateState

func (t *TinyGui) UpdateState()

type TouchCalibration

type TouchCalibration func(x int, y int) (int32, int32)

type TouchSource

type TouchSource interface {
	Read() (int32, int32, bool)
}