xel

README

Package xel

Gives GoLang applications a Window with an OpenGL (glfw) context with callbacks for Mouse and Keyboard.

Installation

go get -u github.com/amortaza/go-xel

why does go-xel exist?

xel is used by the Bellina UI Library

usage

Pay careful attention to the init() function in the example. runtime.LockOSThread() must be called in init().

package main

import (
	"github.com/amortaza/go-xel"
	"runtime"
)

func onLoop() {
	// this gets called every loop...use it wisely
}

func onAfterGL() {
	// This callback gets called after the OpenGL context has been
	// initialized.
	// All OpenGL calls are valid now
}

func onBeforeWindowDelete() {
	// Right before the window is deleted, this callback can be used
	// to free up resources.
}

func onResize(width, height int) {
	// This callback gets called for every resize of the window.
}

func onMouseMove(x, y int) {
	// This callback gets called for every movement of the mouse.
}

func onMouseButton(button xel.MouseButton, action xel.ButtonAction) {
	// This callback gets called for every press of the mouse button.
}

func onKey(key xel.KeyboardKey, action xel.ButtonAction, alt, ctrl, shift bool) {
	// This callback gets called for every press of the keyboard.
}

func init() {
	// This bit is required for GLFW.
	runtime.LockOSThread()
}

func main() {

	// Create an 800 by 600 pixel window (is this 1997 again!)
	xel.Init(100, 100, 800, 600)

	// Setup the callbacks
	xel.SetCallbacks(onAfterGL, onLoop, onBeforeWindowDelete, onResize, onMouseMove, onMouseButton, onKey)

	// Start the loop!
	xel.Loop("Hello, World!")
}

Documentation

Index

• Variables
• func Init(left, top, width, height int)
• func Loop(title string)
• func SetCallbacks(onAfterGL, onTick func(), onBeforeWindowDelete func(), ...)
• func SetMouseCursor(cursor hal.MouseCursor)

Variables

var MouseX, MouseY int

var WinWidth, WinHeight int

Functions

func Init

func Init(left, top, width, height int)

func Loop

func Loop(title string)

func SetCallbacks

func SetCallbacks(
	onAfterGL,
	onTick func(),
	onBeforeWindowDelete func(),
	onResize func(width, height int),
	onMouseMove func(x, y int),
	onMouseButton func(button hal.MouseButton, action hal.ButtonAction),
	onKey func(key hal.KeyboardKey, action hal.ButtonAction, alt, ctrl, shift bool))

func SetMouseCursor

func SetMouseCursor(cursor hal.MouseCursor)