imgui-java

JNI based binding for Dear ImGui with no dependencies, ready to use pre-compiled binaries and a renderer for LWJGL3.

Please read Binding Notice to get more info about java-specific things of the API.
See official documentation and wiki to get more info about how to do things in Dear ImGui.

imgui-java provides all the data you need to render Dear ImGui. If, for some reason, you want to use your own backend renderer, see how things are done in ImGuiImplGl3.

Binding has the next versioning semantic: imguiVersion-bindingVersion.
For example 1.74-0.1 means that imgui-java uses 1.74 version of Dear ImGui and binding itself has the version 0.1.

Some of the very specific features are still in a wip state.

How to Try

Make sure you have installed Java 8 or higher.

You can try Dear ImGui with Java by yourself in a three simple steps:

git clone --branch v1.76-0.8.1 https://github.com/SpaiR/imgui-java.git
cd imgui-java
gradlew :imgui-lwjgl3:startExample

That's all! You will start an example app ImGuiGlfwExample. Feel free to modify ExampleUi class to try different Dear ImGui widgets in action.

How to Use

repositories {
    jcenter()
    mavenCentral()
}

ext {
    lwjglVersion = '3.2.3'
    imguiVersion = '1.76-0.8.1'
}

dependencies {
    implementation "io.imgui.java:binding:$imguiVersion"
    implementation "io.imgui.java:lwjgl3:$imguiVersion"

    // Include all available natives, but it's likely that you want something specific
    runtimeOnly "io.imgui.java:natives-windows:$imguiVersion"
    runtimeOnly "io.imgui.java:natives-windows-x86:$imguiVersion"
    runtimeOnly "io.imgui.java:natives-linux:$imguiVersion"
    runtimeOnly "io.imgui.java:natives-linux-x86:$imguiVersion"

    implementation platform("org.lwjgl:lwjgl-bom:$lwjglVersion")

    ['', '-opengl', '-glfw'].each {
        implementation "org.lwjgl:lwjgl$it:$lwjglVersion"

        // Include all available natives, but it's likely that you want something specific
        runtimeOnly "org.lwjgl:lwjgl$it::natives-windows"
        runtimeOnly "org.lwjgl:lwjgl$it::natives-windows-x86"
        runtimeOnly "org.lwjgl:lwjgl$it::natives-linux"
    }
}

Alternatively you can download imgui-java binaries manually from the release page. You'll need to provide a VM option: imgui.library.path or java.library.path. It should point to the folder where you've placed downloaded binaries.

You are ready to use imgui-java binding!

Using FreeType

Dear ImGui by default uses an stb_strutype library to render a fonts atlas. It's possible to use FreeType instead to get better fonts quality. See an example in ImGuiGlfwExample. Read more

Binding Notice

• All Dear ImGui methods are available in camelCase, not in PascalCase.
• To pass ImVec2/ImVec4 - provide two/four float numbers. To get ImVec2/ImVec4 - provide a destination object.
• To get an input/output to/from Dear ImGui - use primitive wrappers: ImBool, ImInt etc.
• Due to the Java and JNI restrictions we can't provide a fully fledged callbacks to the ImGui::InputText* methods. To replace some of the features use an ImGuiInputTextData class.
• Read javadoc and sources comments to get more info.

How to Build

To build native libraries you should install mingw-w64 and ant. Modify GenerateLibs to build specific binaries you need. After everything is configured, run gradlew :imgui-binding:generateLibs. That will build native libraries and place them in imgui-binding/build/libsNative folder.

Credits

This binding is partly based on the work of xpenatan and his version jDear-imgui.

License

See the LICENSE file for license rights and limitations (Apache-2.0).