JNI based binding for Dear ImGui with no dependencies, ready to use pre-compiled binaries and 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.
Binding provides all the data you need to render Dear ImGui. If, for some reason, you want to use your own backend renderer, see how ImGuiImplGl3 for reference.
Versioning semantic of the binding: 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.
Additional available features:
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.77-0.17 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.
With Gradle
repositories {
jcenter()
mavenCentral()
}
ext {
lwjglVersion = '3.2.3'
imguiVersion = '1.77-0.17'
}
switch (OperatingSystem.current()) {
case OperatingSystem.LINUX:
project.ext.natives = "natives-linux"
break
case OperatingSystem.MAC_OS:
project.ext.natives = "natives-macos"
break
case OperatingSystem.WINDOWS:
project.ext.natives = System.getProperty("os.arch").contains("64") ? "natives-windows" : "natives-windows-x86"
break
}
dependencies {
implementation "io.imgui.java:binding:$imguiVersion"
implementation "io.imgui.java:lwjgl3:$imguiVersion"
runtimeOnly "io.imgui.java:$natives:$imguiVersion"
implementation platform("org.lwjgl:lwjgl-bom:$lwjglVersion")
['', '-opengl', '-glfw'].each {
implementation "org.lwjgl:lwjgl$it:$lwjglVersion"
runtimeOnly "org.lwjgl:lwjgl$it::$natives"
}
}
With Maven
<!-- Used to import imgui-java -->
<repositories>
<repository>
<id>jcenter</id>
<url>https://jcenter.bintray.com/</url>
</repository>
</repositories>
<properties>
<lwjgl.version>3.2.3</lwjgl.version>
<imgui.java.version>1.77-0.17</imgui.java.version>
</properties>
<!-- Resolve OS version for native libraries -->
<!-- imgui-java uses the same naming convention as LWJGL3 -->
<profiles>
<profile>
<id>lwjgl-natives-linux-amd64</id>
<activation>
<os>
<family>unix</family>
<arch>amd64</arch>
</os>
</activation>
<properties>
<natives>natives-linux</natives>
</properties>
</profile>
<profile>
<id>lwjgl-natives-macos-amd64</id>
<activation>
<os>
<family>mac</family>
<arch>amd64</arch>
</os>
</activation>
<properties>
<natives>natives-macos</lwjgl.natives>
</properties>
</profile>
<profile>
<id>lwjgl-natives-windows-amd64</id>
<activation>
<os>
<family>windows</family>
<arch>amd64</arch>
</os>
</activation>
<properties>
<natives>natives-windows</natives>
</properties>
</profile>
<profile>
<id>lwjgl-natives-windows-x86</id>
<activation>
<os>
<family>windows</family>
<arch>x86</arch>
</os>
</activation>
<properties>
<natives>natives-windows-x86</natives>
</properties>
</profile>
</profiles>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.lwjgl</groupId>
<artifactId>lwjgl-bom</artifactId>
<version>${lwjgl.version}</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<!-- imgui-java -->
<dependency>
<groupId>io.imgui.java</groupId>
<artifactId>binding</artifactId>
<version>${imgui.java.version}</version>
</dependency>
<dependency>
<groupId>io.imgui.java</groupId>
<artifactId>lwjgl3</artifactId>
<version>${imgui.java.version}</version>
</dependency>
<dependency>
<groupId>io.imgui.java</groupId>
<artifactId>${natives}</artifactId>
<version>${imgui.java.version}</version>
</dependency>
<!-- LWJGL -->
<dependency>
<groupId>org.lwjgl</groupId>
<artifactId>lwjgl</artifactId>
</dependency>
<dependency>
<groupId>org.lwjgl</groupId>
<artifactId>lwjgl-glfw</artifactId>
</dependency>
<dependency>
<groupId>org.lwjgl</groupId>
<artifactId>lwjgl-opengl</artifactId>
</dependency>
<dependency>
<groupId>org.lwjgl</groupId>
<artifactId>lwjgl</artifactId>
<classifier>${natives}</classifier>
</dependency>
<dependency>
<groupId>org.lwjgl</groupId>
<artifactId>lwjgl-glfw</artifactId>
<classifier>${natives}</classifier>
</dependency>
<dependency>
<groupId>org.lwjgl</groupId>
<artifactId>lwjgl-opengl</artifactId>
<classifier>${natives}</classifier>
</dependency>
</dependencies>
With Raw Jars
- Go to the release page
- Download
imgui-binding-${version}.jar,imgui-lwjgl3-${version}.jarand binary libraries for your OS- imgui-java.dll - Windows 32bit
- imgui-java64.dll - Windows 64bit
- libimgui-java.so - Linux 32bit
- libimgui-java64.so - Linux 64bit
- libimgui-java64.dylib - MacOsX 64bit
- Add jars to your classpath.
- Provide a VM option:
imgui.library.pathorjava.library.path. It should point to the folder where you've placed downloaded native libraries.
Important!
If you're using native libs directly, 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!
Binding based on the Dear ImGui docking branch, commit: 90ea7e2f2f3c4096a58b8bd14c274d80ae63e1ce. That branch contains two important features: multi-viewports and docking.
Even if the viewport feature is still in a very experimental state, yet the docking API seems pretty stable. Thus, imgui-java exposes it and hides everything about viewports.
See an official documentation about how to work with docking.
Dear ImGui by default uses a 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
- All Dear ImGui methods are available in
camelCase, not inPascalCase. - To pass
ImVec2/ImVec4- provide two/four float numbers. To getImVec2/ImVec4- provide a destination object. - To get an input/output to/from Dear ImGui - use primitive wrappers:
ImBool,ImIntetc. - Due to the Java and JNI restrictions we can't provide a fully fledged callbacks to the
ImGui::InputTextmethods. To replace some features use an ImGuiInputTextData class. - Read javadoc and sources comments to get more info.
To build native libraries you should install mingw-w64 and ant. Modify GenerateLibs
to build specific binaries you need. After you've configured everything, run gradlew :imgui-binding:generateLibs.
That will build native libraries and place them in imgui-binding/build/libsNative folder.
Binding partly based on the work of xpenatan and his version jDear-imgui.
See the LICENSE file for license rights and limitations (Apache-2.0).