ebitenui

README

Ebiten UI

A user interface engine and widget library for Ebiten

Ebiten UI is an extension to Ebiten that provides an engine to render a complete user interface, with widgets such as buttons, lists, combo boxes, and so on. It uses the retained mode model. All graphics used by Ebiten UI can be fully customized, so you can really make your UI your own.

Documentation on how to use and extend Ebiten UI is available at ebitenui.github.io.

Ebiten UI is currently under development and should not yet be used in production.

License

Ebiten UI is licensed under the MIT license.

Documentation

Overview

Package ebitenui contains the main UI type that renders a complete user interface.

Index

• type RemoveWindowFunc
• type UI
  • func (u *UI) AddWindow(w *widget.Window) RemoveWindowFunc
  • func (u *UI) Draw(screen *ebiten.Image)
  • func (u *UI) Update()

Types

type RemoveWindowFunc

type RemoveWindowFunc func()

RemoveWindowFunc is a function to remove a Window from rendering.

type UI

type UI struct {
	// Container is the root container of the UI hierarchy.
	Container *widget.Container

	// ToolTip is used to render mouse hover tool tips. It may be nil to disable rendering.
	ToolTip *widget.ToolTip

	// DragAndDrop is used to render drag widgets while dragging and dropping. It may be nil to disable rendering.
	DragAndDrop *widget.DragAndDrop
	// contains filtered or unexported fields
}

UI encapsulates a complete user interface that can be rendered onto the screen. There should only be exactly one UI per application.

func (*UI) AddWindow

func (u *UI) AddWindow(w *widget.Window) RemoveWindowFunc

AddWindow adds window w to u for rendering. It returns a function to remove w from u.

func (*UI) Draw

func (u *UI) Draw(screen *ebiten.Image)

Draw renders u onto screen. This function should be called in the Ebiten Draw function.

If screen's size changes from one frame to the next, u.Container.RequestRelayout is called.

func (*UI) Update

func (u *UI) Update()

Update updates u. This method should be called in the Ebiten Update function.