youi

README

youi

youi is an experimental UI library for Go projects using a OpenGL backend for a consistent look across platformers rather than aiming for a native look'n'feel.

Install

go get -u github.com/hamcha/youi/...

Compatibility

youi is currently targeting OpenGL 3.3 core, which should work on most hardware from 2008 onwards:

• All Apple hardware from 2007/2008 and newer
• Sixth generation Intel HD Graphics and newer (except on Windows, where you need at least 7th)
• NVIDIA Graphics cards G80 (GeForce 8 series) and newer
• AMD Graphics cards R600 (Radeon HD 2000 series) and newer

Actual support may be affected by which OS drivers are installed.

License

The code for this project is licensed under the ISC license, full text provided in the LICENSE file.

This project depends on third party libraries, you can see their licenses in their relative files:

• LICENSE-go-gl for the go-gl project
• LICENSE-ftl for freetype2 and Freetype-Go
• LICENSE-texpack for texpack
• LICENSE-goresources for resources-go

Documentation

Index

• Variables
• func RegisterComponent(namespace, name string, provider components.ComponentProvider)
• type ComponentMap
  • func Components() (out ComponentMap)
  • func (c ComponentMap) String() (out string)
• type Form
  • func MakeForm(window *opengl.Window) *Form
  • func (f *Form) Draw()
  • func (f *Form) LoadYUML(reader io.Reader) error

Variables

var (
	ErrUnknownNamespace = errors.New("YUML namespace \"%s\" not found (have you forgot to register its components?)")
	ErrUnknownComponent = errors.New("YUML component \"%s\" not found in namespace \"%s\"")
)

Component errors

var (
	ErrYUMLRootMustBePage  = errors.New("YUML root must be <Page>")
	ErrCouldNotMakeElement = errors.New("Could not make element \"%s\"")
)

Functions

func RegisterComponent

func RegisterComponent(namespace, name string, provider components.ComponentProvider)

RegisterComponent registers a component under a namespace and name so it can be used in YUML code

Types

type ComponentMap

type ComponentMap map[string][]string

func Components

func Components() (out ComponentMap)

Components returns a map of all registered components

func (ComponentMap) String

func (c ComponentMap) String() (out string)

type Form

type Form struct {
	Root *builtin.Page
	// contains filtered or unexported fields
}

func MakeForm

func MakeForm(window *opengl.Window) *Form

func (*Form) Draw

func (f *Form) Draw()

func (*Form) LoadYUML

func (f *Form) LoadYUML(reader io.Reader) error