Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 2.92 KB

README.md

File metadata and controls

63 lines (48 loc) · 2.92 KB
Raw

Heaps/HashLink native binding for Dear ImGui

Build & Install

First, make sure that HashLink, CMake and a C/C++ compiler are installed on your system.

Then the native extension needs to be built with these commands:

cd extension
mkdir build
cd build

cmake ..
cmake --build .

It builds a the target hdll file, and copy it to the root of the project.

Another method is to build it inside Visual Studio Code with CMake Tools extension installed, so you don't have to deal with the command line.

To add this library to your project, you need to include these files:

  • The previously compiled hlimgui.hdll file.
  • imgui/ImGuiDrawable.hx: this class derives from the standard Heaps Drawable class and contains/displays all ImGui widgets.
  • imgui/ImGui.hx: interface to the native extension.

See Main.hx to see how to implement this library.

Supported ImGui features

Most of the ImGui functionalities are supported and binded. Look at https://github.com/ocornut/imgui to get documentation on exposed functions AND how ImGui works.

Here is a list of unsupported features and changes:

  • Custom fonts aren't implemented.
  • As Haxe doesn't support function overloading, so if two original functions have the same name, the second one in Haxe has a suffix 2 to disguish it. For example:
public static function treeNode(label : String) : Bool {return false;}
public static function treeNode2(str_id : String, label : String) : Bool {return false;}

  • ImGui has several functions which take a variable number of parameters in order to format strings. This feature isn't supported in Haxe, so all string formatting must be done in Haxe before passing it to ImGui.

  • InputText function takes a byte buffer as parameter. This needs to be converted to a string like this example:

var input_text_buffer = new hl.Bytes(128);
if (ImGui.inputText('Text', input_text_buffer, 128)) {
    var st = @:privateAccess String.fromUTF8(input_text_buffer);
    trace(st);
}

  • The function setIniFilename doesn't exist in ImGui, it has been added to modify the filename of the default ini file saved by ImGui (pass null to turn off this feature).

  • Due to type conversions between Haxe and ImGui, editing the object returned from getStyle does not immediately update the default styles. The setStyle method has been added to provide that functionality. For example:

var style:ImGuiStyle = ImGui.getStyle();
style.WindowBorderSize = 0;
style.WindowRounding = 0;
ImGui.setStyle(style);

Bugs

If you find bugs, please report them on the GitHub project page. Most of the binded functions have been tested, but as it's a new library some bugs might remain.

Thanks

I would like to thanks Aidan63 for their Haxe/cpp binding. I have borrowed all the structure declaration code which remains the same between the two bindings.