haxeui-kha is the Kha backend for HaxeUI.


haxeui-kha has a dependency to haxeui-core, and so that too must be installed. Once haxeui-core is installed, haxeui-kha can be installed using:

haxelib install haxeui-kha


haxeui-kha also has a dependancy on Kha, this can be installed in an empty directory via git using the following commands:

git init
git submodule add https://github.com/KTXSoftware/Kha
git submodule update --init --recursive

HaxeUI comes with a set of command line tools that can also perform this step for you using:
haxelib run haxeui-core install kha


The simplest method to create a new Kha application that is HaxeUI ready is to use the HaxeUI command line tools. These tools will allow you to start a new project rapidly with HaxeUI support baked in. To create a new skeleton application using haxeui-kha run the following command in the folder where Kha has been installed:

haxelib run haxeui-core create kha

If however you already have an existing application, then incorporating HaxeUI into that application is straightforward:


Simply add the following lines to your khamake.js and rebuild your project files.


Toolkit initialisation and usage

The Kha system itself must be initialised and a render loop started. This can be done by using code similar to:

class Main {
    public static function main() {
        kha.System.start({}, function ( _ ) {
            kha.Assets.loadEverything(function() {

                final screen = haxe.ui.core.Screen.instance;
                final ui = haxe.ui.macros.ComponentMacros.buildComponent("ui.xml");


                kha.System.notifyOnFrames(function( framebuffers: Array ) {
                    final fb = framebuffers[0];
                    final g2 = fb.g2;
                    g2.begin(true, kha.Color.White);

Once the toolkit is initialised you can add components using the methods specified here.

Kha specifics

As well as using the generic Screen.instance.addComponent, it is also possible to render a component to a specific surface use the components special renderTo function. Eg:

Keep up to date with HaxeUI!

Get the latest from our social networks.