imgui

imgui

C++即时模式GUI库 高效开发可视化工具

imgui是C++即时模式GUI库,为游戏引擎、3D应用和嵌入式系统提供轻量高效的界面开发方案。支持窗口、菜单、绘图等丰富组件,兼容多种渲染后端。易集成、低状态同步,适合快速开发调试和创作工具。在游戏行业广泛应用,性能可靠,跨平台兼容性强。

Dear ImGuiGUI库C++开源软件图形用户界面Github开源项目

新闻

⭐️⭐️⭐️ - 2023/4/20 发布开源软件 MediaEditor Community,该软件基于imgui(本分支)。

特性

Dear ImGui(https://github.com/ocornut/imgui) 的 docking/multiview 分支和堆栈布局支持分支而来,并添加了 CMake 构建脚本。 还包含以下附加组件集合:

  • 添加多语言支持(使用语言ini文件实现文本国际化)
  • 添加消息框控件
  • 添加多个垂直文本辅助API
  • 为ImDrawList添加多个扩展
  • 添加用于Vulkan计算的VkShader(CodeWin团队)
  • 添加图标集合(https://github.com/juliettef/IconFontCppHeaders)
  • 添加应用程序框架,只需几个函数即可简单创建应用
  • 为imgui添加省电模式,可通过代码配置
  • 添加Vulkan纹理支持(不太完善)
  • 新方法处理不同DPI设置的多显示器
  • 添加最新的std_image代码,包括读取/写入/调整大小
  • 添加dll加载封装
  • 添加目录遍历封装
  • 在imgui_helper.cpp中添加多个辅助工具

===== Dear ImGui

<center><b><i>"给某人状态,他们某天可能会有bug;但教他们如何在两个需要保持同步的独立位置表示状态,他们就会终生与bug相伴。"</i></b></center> <a href="https://twitter.com/rygorous/status/1507178315886444544">-ryg</a>

构建状态 静态分析状态 测试状态

<sub>(本库使用免费且宽松的许可证提供,但需要财务支持以维持持续改进。除了维护和稳定性外,还有许多理想的功能有待添加。如果您的公司正在使用Dear ImGui,请考虑与我们联系。)</sub>

企业:通过开具发票的赞助/支持合同支持持续开发和维护: <br>  电子邮件:contact @ dearimgui dot com <br>个人:在这里支持持续开发和维护。另请参阅资助页面。

简介 - 用法 - 工作原理 - 发布与更新日志 - 演示 - 入门与集成
画廊 - 支持、常见问题 - 如何帮助 - 资助与赞助商 - 致谢 - 许可证
Wiki - 扩展 - 语言绑定与框架后端 - 使用Dear ImGui的软件 - 用户评价

简介

Dear ImGui是一个轻量级的C++图形用户界面库。它输出优化的顶点缓冲区,您可以在支持3D管线的应用程序中随时渲染。它快速、可移植、与渲染器无关,并且自包含(无外部依赖)。

Dear ImGui旨在实现快速迭代赋予程序员能力以创建内容创作工具和可视化/调试工具(而非面向普通最终用户的UI)。为实现这一目标,它注重简单性和生产力,缺少一些在更高级库中常见的功能。

Dear ImGui特别适合集成到游戏引擎(用于工具开发)、实时3D应用、全屏应用、嵌入式应用,或任何操作系统功能非标准的游戏主机平台应用中。

  • 最小化状态同步。
  • 最小化用户端UI相关状态存储。
  • 最小化设置和维护。
  • 易于使用,创建动态UI以反映动态数据集。
  • 易于使用,创建代码驱动和数据驱动的工具。
  • 易于使用,创建短期临时工具和长期更复杂的工具。
  • 易于修改和改进。
  • 可移植,最小化依赖,可在目标平台运行(游戏主机、手机等)。
  • 高效的运行时和内存消耗。
  • 经过实战检验,被游戏行业的许多主要参与者使用

用法

Dear ImGui的核心包含在几个平台无关的文件中,您可以轻松地在应用程序/引擎中编译这些文件。它们是存储库根文件夹中的所有文件(imgui*.cpp,imgui*.h)。不需要特定的构建过程。您可以将.cpp文件添加到现有项目中。

backends/文件夹中提供了各种图形API和渲染平台的后端examples/文件夹中还有示例应用程序。您也可以创建自己的后端。只要您能渲染带纹理的三角形,就能渲染Dear ImGui。

有关更多详细信息,请参阅本文档的入门与集成部分。

在您的应用程序中设置好Dear ImGui后,您可以在程序循环的任何地方使用它:

ImGui::Text("你好,世界 %d", 123); if (ImGui::Button("保存")) MySaveFunction(); ImGui::InputText("字符串", buf, IM_ARRAYSIZE(buf)); ImGui::SliderFloat("浮点数", &f, 0.0f, 1.0f);

示例代码输出(深色,Segoe UI字体,FreeType) 示例代码输出(浅色,Segoe UI字体,FreeType)

// 创建一个名为"我的第一个工具"的窗口,带有菜单栏 ImGui::Begin("我的第一个工具", &my_tool_active, ImGuiWindowFlags_MenuBar); if (ImGui::BeginMenuBar()) { if (ImGui::BeginMenu("文件")) { if (ImGui::MenuItem("打开..", "Ctrl+O")) { /* 执行操作 */ } if (ImGui::MenuItem("保存", "Ctrl+S")) { /* 执行操作 */ } if (ImGui::MenuItem("关闭", "Ctrl+W")) { my_tool_active = false; } ImGui::EndMenu(); } ImGui::EndMenuBar(); } // 编辑存储为4个浮点数的颜色 ImGui::ColorEdit4("颜色", my_color); // 生成样本并绘制 float samples[100]; for (int n = 0; n < 100; n++) samples[n] = sinf(n * 0.2f + ImGui::GetTime() * 1.5f); ImGui::PlotLines("样本", samples, 100); // 在滚动区域显示内容 ImGui::TextColored(ImVec4(1,1,0,1), "重要内容"); ImGui::BeginChild("滚动"); for (int n = 0; n < 50; n++) ImGui::Text("%04d: 一些文本", n); ImGui::EndChild(); ImGui::End();

Dear ImGui允许你创建复杂的工具以及生命周期很短的工具。在极短生命周期的极端情况下:利用现代编译器的编辑并继续(热代码重载)功能,你可以在应用程序运行时添加一些小部件来调整变量,然后一分钟后就可以删除这些代码!Dear ImGui不仅仅用于调整值。你可以用它通过发出文本命令来跟踪正在运行的算法。你可以将它与你自己的反射数据一起使用,实时浏览你的数据集。你可以用它来展示引擎中某个子系统的内部结构,创建一个日志记录器、检查工具、性能分析器、调试器,甚至是一个完整的游戏制作编辑器/框架等。

工作原理

IMGUI范式通过其API尽量减少用户角度的多余状态复制、状态同步和状态保留。与传统的保留模式界面相比,它更不容易出错(代码更少,bug更少),并且适合创建动态用户界面。查看Wiki的关于IMGUI范式部分了解更多详情。

Dear ImGui输出顶点缓冲区和命令列表,你可以在应用程序中轻松渲染。渲染它们所需的绘制调用和状态更改次数相当少。由于Dear ImGui不直接了解或接触图形状态,你可以在代码的任何位置调用其函数(例如,在运行算法的中间,或在你自己的渲染过程中)。请参考examples/文件夹中的示例应用程序,了解如何将Dear ImGui集成到你现有的代码库中的说明。

一个常见的误解是将即时模式GUI误认为是即时模式渲染,这通常意味着在调用GUI函数时用一堆低效的绘制调用和状态更改来频繁访问你的驱动程序/GPU。这不是Dear ImGui的工作方式。Dear ImGui输出顶点缓冲区和一个小的绘制调用批次列表。它从不直接接触你的GPU。绘制调用批次是经过优化的,你可以稍后在你的应用程序中甚至远程渲染它们。

发布和更新日志

查看发布页面获取详细的更新日志。 阅读更新日志是了解Dear ImGui提供的功能的好方法,也许会让你想到一些你一直忽视的功能!

演示

调用ImGui::ShowDemoWindow()函数将创建一个演示窗口,展示各种功能和示例。代码始终可以在imgui_demo.cpp中查阅。这是演示的样子

你应该能够从源代码构建示例。如果不能,请告诉我们!如果你想快速了解Dear ImGui的一些功能,可以在这里下载Windows版本的演示应用程序二进制文件:

演示应用程序不支持DPI感知,因此在4K屏幕上可能会出现模糊。要在你的应用程序中实现DPI感知,你可以以不同的比例加载/重新加载字体,并使用style.ScaleAllSizes()缩放样式(参见FAQ)。

入门和集成

详情请参阅入门指南

在大多数平台上使用C++时,你应该能够不加修改地使用imgui_impl_xxxx后端的组合(例如imgui_impl_win32.cpp + imgui_impl_dx11.cpp)。如果你的引擎支持多个平台,考虑使用更多的imgui_impl_xxxx文件而不是重写它们:这将减少你的工作量,而且你可以立即运行Dear ImGui。如果你希望,_以后_可以决定使用自定义引擎函数重写自定义后端。

将Dear ImGui集成到你的自定义引擎中需要:1)连接鼠标/键盘/游戏手柄输入 2)将纹理上传到你的GPU/渲染引擎 3)提供一个可以绑定纹理并渲染带纹理三角形的渲染函数,这基本上就是后端所做的工作。examples/文件夹中包含了执行这些操作的应用程序:设置窗口并使用后端。如果你遵循入门指南,理论上应该能在不到一小时内集成Dear ImGui。务必花时间阅读FAQ、注释和示例应用程序!

官方维护的后端/绑定(在仓库中):

  • 渲染器:DirectX9、DirectX10、DirectX11、DirectX12、Metal、OpenGL/ES/ES2、SDL_Renderer、Vulkan、WebGPU。
  • 平台:GLFW、SDL2/SDL3、Win32、Glut、OSX、Android。
  • 框架:Allegro5、Emscripten。 第三方后端/绑定 wiki 页面:
  • 语言: C, C# 以及: Beef, ChaiScript, CovScript, Crystal, D, Go, Haskell, Haxe/hxcpp, Java, JavaScript, Julia, Kotlin, Lobster, Lua, Nim, Odin, Pascal, PureBasic, Python, ReaScript, Ruby, Rust, Swift, Zig...
  • 框架: AGS/Adventure Game Studio, Amethyst, Blender, bsf, Cinder, Cocos2d-x, Defold, Diligent Engine, Ebiten, Flexium, GML/Game Maker Studio, GLEQ, Godot, GTK3, Irrlicht Engine, JUCE, LÖVE+LUA, Mach Engine, Magnum, Marmalade, Monogame, NanoRT, nCine, Nim Game Lib, Nintendo 3DS/Switch/WiiU (自制), Ogre, openFrameworks, OSG/OpenSceneGraph, Orx, Photoshop, px_render, Qt/QtDirect3D, raylib, SFML, Sokol, Unity, Unreal Engine 4/5, UWP, vtk, VulkanHpp, VulkanSceneGraph, Win32 GDI, WxWidgets.
  • 许多绑定是自动生成的(通过经典的 cimgui 或更新/实验性的 dear_bindings),你可以使用它们的元数据输出为其他语言生成绑定。

实用扩展/组件 wiki 页面:

  • 自动化/测试、文本编辑器、节点编辑器、时间线编辑器、绘图、软件渲染器、远程网络访问、内存编辑器、控件等。值得注意且得到良好支持的扩展包括 ImPlotDear ImGui Test Engine

更多链接和想法请参见 Wiki

展示

使用 Dear ImGui 的示例项目: Tracy (性能分析器), ImHex (十六进制编辑器/数据分析), RemedyBG (调试器) 以及 数百个其他项目

查看更多用户提交的使用 Dear ImGui 的项目截图,请查看 展示帖

第三方组件和扩展列表,请查看 实用扩展/组件 wiki 页面。

自定义引擎 erhe (docking 分支)<BR>erheWonder Boy: The Dragon's Trap (2017) 的自定义引擎<BR>the dragon's trap
自定义引擎 (未命名)<BR>editor whiteTracy 性能分析器 (github)<BR>tracy profiler

支持、常见问题 (FAQ)

请参阅: 常见问题 (FAQ),其中回答了常见问题。

请参阅: 入门指南Wiki 获取许多链接、参考和文章。

请参阅: 关于 IMGUI 范式的文章 阅读/学习即时模式 GUI 范式。

请参阅: 即将到来的变更

请参阅: Dear ImGui 测试引擎 + 测试套件 用于自动化和测试。

为了让搜索引擎能爬取 wiki,这里有一个 可爬取的 Wiki 链接 (不适合人类阅读,原因在此)。

刚开始使用?对于首次用户在编译/链接/运行或加载字体时遇到问题,请使用 GitHub 讨论。对于任何其他问题、bug 报告、请求、反馈,请在 GitHub Issues 上发帖。请仔细阅读并填写新 Issue 模板。

付费商业客户可获得私人支持 (电子邮件: contact @ dearimgui dot com)。

我应该使用哪个版本?

我们偶尔会标记 发布版本 (附带详细的发布说明),但通常来说,同步到最新的 masterdocking 分支是安全且推荐的。该库相当稳定,报告的回归问题通常会很快得到修复。高级用户可能想使用具有 多视口停靠 功能的 docking 分支。这个分支会定期与 master 分支保持同步。

谁在使用 Dear ImGui? 查看 引用资助与赞助商使用 Dear ImGui 的软件 维基页面,了解谁在使用 Dear ImGui。如果可以的话,请添加您的游戏/软件!另外,请查看 画廊主题

如何提供帮助

我怎样才能提供帮助?

  • 查看 GitHub 论坛/问题
  • 您可以参与开发并提交拉取请求!请理解,提交 PR 的同时也意味着您在请求维护者审查您的代码,并永久接管其维护工作。PR 的制作应同时考虑最终用户的利益,也要便于维护者理解和接受。
  • 查看 维基 上的 需要帮助 页面获取更多想法。
  • 成为 资金支持者!让您的公司通过开具赞助商/维护发票或购买 Dear ImGui 测试引擎 的许可证来财务支持这个项目(请联系:omar AT dearimgui DOT com)。

赞助商

Dear ImGui 的持续开发得到了用户和私人赞助商的财务支持。 <BR>请查看 当前和过去 Dear ImGui 资金支持者和赞助商的详细列表 了解详情。 <BR>从 2014 年 11 月到 2019 年 12 月,持续开发还得到了 Patreon 用户和个人捐赠的财务支持。

感谢所有过去和现在的支持者,帮助这个项目保持活力和繁荣!

Dear ImGui 使用了为开源项目免费提供的软件和服务:

致谢

Omar Cornut 开发,以及 GitHub 上所有直接或间接的 贡献者。这个库的早期版本是在 Media Molecule 的支持下开发的,并首次在游戏 Tearaway(PS Vita)中内部使用。

经常性贡献者包括 Rokas Kupstys @rokups(2020-2022):在自动化系统和回归测试方面做了大量工作,现已在 Dear ImGui 测试引擎 中可用。

维护/支持合同、赞助发票和其他 B2B 交易由 Disco Hello 托管和处理。

Omar:"我最初在 Q-Games 发现了 IMGUI 范式,那里 Atman Binstock 在代码库中放置了他自己的简单实现,我花了相当长的时间改进和思考它。事实证明,Atman 是通过与 Casey 合作直接接触到这个概念的。当我转到 Media Molecule 时,我重写了一个新的库,试图克服我使用过的第一个库的缺陷和限制。它变成了这个库,从那时起,我花了大量时间进行迭代和改进。"

嵌入了 Tristan Grimmer 的 ProggyClean.ttf 字体(MIT 许可证)。 <br>嵌入了 Sean Barrett 的 stb_textedit.h, stb_truetype.h, stb_rect_pack.h(公共领域)。

早期版本的灵感、反馈和测试:Casey Muratori、Atman Binstock、Mikko Mononen、Emmanuel Briney、Stefan Kamoda、Anton Mikhailov、Matt Willis。同时感谢所有在 GitHub 上发布反馈、问题和补丁的人。

许可证

Dear ImGui 采用 MIT 许可证,更多信息请查看 LICENSE.txt

编辑推荐精选

问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多