Project Icon

imgui-java

Dear ImGui的Java绑定提供高效JNI接口

imgui-java是Dear ImGui的JNI绑定项目,为Java开发者提供高效和功能完整的接口。该项目支持多视口和停靠功能,集成FreeType字体渲染,并包含多个实用扩展。它提供LWJGL3实现和高级抽象层,便于快速开发GUI应用。imgui-java是一个灵活的Java GUI开发框架,适用于各类图形界面项目。

ImGui Java

基于JNI的 Dear ImGui 绑定

Github 所有发布版本 CI
Maven Central binding javadoc app javadoc


特性

  • 基于JNI
    使用生成的JNI代码实现原生通信层。无依赖,无问题。
  • 小巧高效
    绑定具有小内存占用,并使用直接原生调用工作。
  • 功能齐全
    所有公共API都经过精心实现,以Java使用为导向。
  • 多视口 / 停靠分支
    绑定完全支持多视口停靠
  • FreeType字体渲染器
    FreeType字体渲染器提供更好的字体质量。查看如何使用
  • 扩展
    绑定包含了几个有用的Dear ImGui扩展查看完整列表

要了解如何使用ImGui Java,请阅读官方文档wiki。 绑定采用C++ API for Java,但几乎所有内容都可以以相同的方式使用。

ImGui Java有一个可直接使用的GLFW和OpenGL API实现,使用LWJGL3库。参见imgui-lwjgl3模块。
该实现是可选的。Dear ImGui的优势在于完全可移植性,所以可以自由复制粘贴类或编写自己的实现。

此外,还有一个imgui-app模块,它提供了高级抽象层
它将所有底层代码隐藏在一个可扩展的类中。使用它,您可以立即构建GUI应用程序。

支持

ko-fi

您可以支持该项目以激励其进一步发展。

如何尝试

确保您已安装JDK 8或更高版本。

演示

您可以通过三个简单的步骤自行尝试绑定:

git clone git@github.com:SpaiR/imgui-java.git
cd imgui-java
./gradlew :example:run

查看example模块以尝试其他小部件的实际效果。

如何使用

LWJGL中的ImGui YouTube视频GamesWithGabe制作。
您可以将此视频作为基本的逐步教程。它展示了如何使用jar文件集成绑定。
Gradle和Maven依赖也可以用于此目的。

请注意,集成本身是一个非常灵活的过程。它可以以不同的方式完成。如果您只需要GUI框架,请使用Application模块。 否则,如果您需要更多控制,最好不仅仅是重复步骤,而是要理解每个步骤的作用。

对于macOS M芯片用户

macOS版本的绑定编译为通用二进制文件。这意味着您可以在x86_64和aarch64平台上使用它,无需任何额外操作。

应用程序

如果您不关心OpenGL和其他底层内容,那么可以使用imgui-app模块中的应用程序层。 它是一个单jar解决方案,包括:GLFW、OpenGL和Dear ImGui本身。 所以您只需要一行依赖类路径中的一个jar就可以让一切工作。 您不需要添加单独的LWJGL或原生库依赖,因为它们已经包含在内。

如果您只关心GUI本身,应用程序模块是最佳选择。

同时,Application提供了覆盖其任何生命周期方法的选项。 这意味着如果您寻求更多底层控制,也可以获得。

示例

一个非常简单的应用程序可能如下所示:

import imgui.ImGui;
import imgui.app.Application;
import imgui.app.Configuration;

public class Main extends Application {
    @Override
    protected void configure(Configuration config) {
        config.setTitle("Dear ImGui 真棒!");
    }

    @Override
    public void process() {
        ImGui.text("你好,世界!");
    }

    public static void main(String[] args) {
        launch(new Main());
    }
}

阅读imgui.app.Application javadoc以了解它在底层是如何工作的。

依赖

Maven Central

Gradle
repositories {
    mavenCentral()
}

dependencies {
    implementation "io.github.spair:imgui-java-app:${version}"
}
Maven ``` io.github.spair imgui-java-app ${version} ```
原始Jar文件
  1. 前往发布页面;
  2. 下载java-libraries.zip;
  3. 获取imgui-app-${version}-all.jar;
  4. 将jar文件添加到你的classpath中。

带有all标识符的jar文件已经包含了bindinglwjgl3模块。 如果你使用的是不带all标识符的jar文件,请同时添加相应的jar文件。

无论是带还是不带all标识符的jar文件,都已经包含了所有必需的本地库。

Java模块系统

如果使用Java 9模块,你需要引入imgui.app模块。

绑定

不使用imgui-app模块而直接使用绑定需要手动将其"附加"到应用程序中。 你可以参考imgui-app模块来了解具体的操作方法。

依赖

Maven Central

为简单起见,Gradle / Maven的依赖示例仅展示了如何添加Windows平台的本地库。你可以自由添加其他平台。

本地二进制文件系统
imgui-java-natives-windowsWindows
imgui-java-natives-linuxLinux
imgui-java-natives-macosmacOS

请注意,你还需要添加LWJGL库的依赖。下面的示例也展示了如何添加这些依赖。

Gradle
repositories {
    mavenCentral()
}

ext {
    lwjglVersion = '3.3.3'
    imguiVersion = "${version}"
}

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

    ['', '-opengl', '-glfw'].each {
        implementation "org.lwjgl:lwjgl$it:$lwjglVersion"
        implementation "org.lwjgl:lwjgl$it::natives-windows"
    }
    
    implementation "io.github.spair:imgui-java-binding:$imguiVersion"
    implementation "io.github.spair:imgui-java-lwjgl3:$imguiVersion"
    
    implementation "io.github.spair:imgui-java-natives-windows:$imguiVersion"
}
Maven
<properties>
    <lwjgl.version>3.3.1</lwjgl.version>
    <imgui.java.version>${version}</imgui.java.version>
</properties>

<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>
    <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-windows</classifier>
    </dependency>
    <dependency>
        <groupId>org.lwjgl</groupId>
        <artifactId>lwjgl-glfw</artifactId>
        <classifier>natives-windows</classifier>
    </dependency>
    <dependency>
        <groupId>org.lwjgl</groupId>
        <artifactId>lwjgl-opengl</artifactId>
        <classifier>natives-windows</classifier>
    </dependency>
    
    <dependency>
        <groupId>io.github.spair</groupId>
        <artifactId>imgui-java-binding</artifactId>
        <version>${imgui.java.version}</version>
    </dependency>
    <dependency>
        <groupId>io.github.spair</groupId>
        <artifactId>imgui-java-lwjgl3</artifactId>
        <version>${imgui.java.version}</version>
    </dependency>
    <dependency>
        <groupId>io.github.spair</groupId>
        <artifactId>imgui-java-natives-windows</artifactId>
        <version>${imgui.java.version}</version>
    </dependency>
</dependencies>
原始Jar文件
  1. 前往发布页面;
  2. 下载java-libraries.zipnative-libraries.zip;
  3. java-libraries中获取imgui-binding-${version}.jarimgui-lwjgl3-${version}.jar,以及从native-libraries压缩包中获取所需操作系统的二进制库;
  4. 将jar文件添加到你的classpath中;
  5. 提供一个VM选项,指定native-libraries压缩包中文件的位置。

VM选项示例:

  • -Dimgui.library.path=${路径}
  • -Djava.library.path=${路径}

imgui.library.pathjava.library.path是等效的,区别在于java.library.path是JVM提供本地库的标准选项。

Java模块系统

如果使用Java 9模块,ImGui Java有自动模块名:

包名模块名
imgui-java-appimgui.app
imgui-java-bindingimgui.binding
imgui-java-lwjgl3imgui.lwjgl3
imgui-java-natives-windowsimgui.natives.windows
imgui-java-natives-linuximgui.natives.linux
imgui-java-natives-macosimgui.natives.macos

扩展

所有扩展都已包含在绑定中,可以直接使用。 有关如何使用它们的更多信息,请参阅example模块中的示例。

FreeType

默认情况下,Dear ImGui 使用 stb-truetype 来渲染字体。但是,还有一个选项可以使用 FreeType 字体渲染器。 要了解它们之间的区别,请访问 imgui_freetype 页面。

这个绑定也支持 FreeType 选项。 FreeType 被静态预编译到库中,这意味着它默认启用,没有禁用选项。 因此,你可以在字体配置中自由使用 ImGuiFreeTypeBuilderFlags

如果你不想使用 FreeType 字体渲染器,你需要构建自己的二进制文件并使用它们。

绑定说明

绑定是考虑到 Java 使用而制作的。原始库的某些地方已经为此进行了调整。
例如,在 C++ 中需要传递引用值的地方,在 Java 中你需要传递原始类型的包装器:ImIntImFloat 等。

一个重要的事情是原生结构体的工作方式。它们都有一个指向本地分配内存的公共字段指针。
通过更改指针,可以使用相同的 Java 实例来处理不同的本地结构体。
大多数情况下,你可以忽略这一点,只需以常规方式使用对象即可。

阅读 javadoc 和源代码注释以获取更多关于如何执行特定操作的信息。

如何构建本地库

确保你已经下载了 git 子模块。可以通过以下方式实现:

  • 克隆仓库时:git clone --recurse-submodules https://github.com/SpaiR/imgui-java.git
  • 仓库克隆后:git submodule initgit submodule update

Windows

  • 确保你已安装并在 PATH 中可用
  • 使用以下命令构建:./gradlew imgui-binding:generateLibs -Denvs=windows -Dlocal
  • 使用以下命令运行:./gradlew example:run -PlibPath="../imgui-binding/build/libsNative/windows64"
  • 始终使用 -Dlocal 标志。

Linux

  • 安装依赖项:openjdk8mingw-w64-gccant。(包名可能因系统而异。)
  • 使用以下命令构建:./gradlew imgui-binding:generateLibs -Denvs=linux -Dlocal
  • 使用以下命令运行:./gradlew example:run -PlibPath=../imgui-binding/build/libsNative/linux64

macOS

  • 检查"Linux"部分中的依赖项,并确保已安装。
  • 使用以下命令构建:./gradlew imgui-binding:generateLibs -Denvs=macos -Dlocal
  • 使用以下命令运行:./gradlew example:run -PlibPath=../imgui-binding/build/libsNative/macosx64

macOS (arm64)

  • 检查"Linux"部分中的依赖项,并确保已安装。
  • 使用以下命令构建:./gradlew imgui-binding:generateLibs -Denvs=macosarm64 -Dlocal
  • 使用以下命令运行:./gradlew example:run -PlibPath=../imgui-binding/build/libsNative/macosxarm64

envs 参数中可以使用以下值:windowslinuxmacosmacosarm64

-Dlocal 是可选的,表示本地库将在 ./imgui-binding/build/ 文件夹下构建。否则将使用 /tmp/imgui 文件夹。

FreeType

要构建带有 FreeType 的库版本,你需要先运行 buildSrc/scripts/vendor_freetype.sh 脚本。 这个脚本会配置 FreeType 库以静态编译到你的项目中。

许可证

有关许可权利和限制(MIT),请参阅 LICENSE 文件。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

稿定AI

稿定设计 是一个多功能的在线设计和创意平台,提供广泛的设计工具和资源,以满足不同用户的需求。从专业的图形设计师到普通用户,无论是进行图片处理、智能抠图、H5页面制作还是视频剪辑,稿定设计都能提供简单、高效的解决方案。该平台以其用户友好的界面和强大的功能集合,帮助用户轻松实现创意设计。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号