新闻

⭐️⭐️⭐️ - 2023/4/20 发布开源软件 MediaEditor Community，该软件基于imgui（本分支）。

特性

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

添加了 Obj 文件加载器和 3D 模型渲染，配合 ImGuizmo 小部件，无需使用 OpenGL/Vulkan API（仅使用 c++ 和 ImGui 顶点 API）
imgui_orient
ImCoolBar(https://github.com/aiekick/ImCoolBar)
ImGuiTexInspect(https://github.com/andyborrell/imgui_tex_inspect)
ImGuiZmo(https://github.com/CedricGuillemet/ImGuizmo)
imGuIZMO.quat(https://github.com/BrutPitt/imGuIZMO.quat)
implot(https://github.com/epezent/implot)
ImGuiFileDialog(https://github.com/aiekick/ImGuiFileDialog/tree/Lib_Only)
ImGuiTabWindow(https://github.com/Flix01/imgui/tree/imgui_with_addons)
Markdown(https://github.com/juliettef/imgui_markdown)
MemoryEditor(http://www.github.com/ocornut/imgui_club)
ImGui 节点编辑器(https://github.com/thedmd/imgui-node-editor/tree/feature/blueprint-next)
TextEditor 和其他小部件(https://github.com/Flix01/imgui/tree/imgui_with_addons/addons)
自定义切换小部件(https://github.com/cmdwtf/imgui_toggle)
热键(https://github.com/CedricGuillemet/ImHotKey)
图像检查(https://github.com/CedricGuillemet/imgInspect)
曲线编辑(https://github.com/CedricGuillemet/ImGuizmo)
ImSpinner(https://github.com/dalerank/imspinner)
饼状菜单(https://gist.github.com/thennequin/64b4b996ec990c6ddc13a48c6a0ba68c)
贝塞尔曲线小部件
2D 滑块和 3D 滑块小部件
ImSpectrogram（音频频谱图小部件）
颜色选择器小部件
颜色带小部件
颜色环小部件
多种旋钮小部件
immat 用于模拟 OpenCV Mat（CodeWin 团队）
单色中文字体（小型黑体/楷体/宋体/更纱黑体）
卡尔曼算法测试
其他小部件
ImGui::Piano（MIDI 键盘）
ImGui::ImSpline
ImVulkanShader
虚拟键盘(https://github.com/Flix01/imgui)

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

===== Dear ImGui

"给某人状态，他们某天可能会有bug；但教他们如何在两个需要保持同步的独立位置表示状态，他们就会终生与bug相伴。" -ryg

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

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

简介 - 用法 - 工作原理 - 发布与更新日志 - 演示 - 入门与集成
画廊 - 支持、常见问题 - 如何帮助 - 资助与赞助商 - 致谢 - 许可证
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版本的演示应用程序二进制文件：

imgui-demo-binaries-20240105.zip（Windows，1.90.1 WIP，构建于2024/01/05，master分支）或较旧的二进制文件。

演示应用程序不支持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 页面:

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

更多链接和想法请参见 Wiki。

展示

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

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

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


自定义引擎 erhe (docking 分支)	Wonder Boy: The Dragon's Trap (2017) 的自定义引擎
自定义引擎 (未命名)	Tracy 性能分析器 (github)

支持、常见问题 (FAQ)

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

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

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

请参阅: 即将到来的变更。

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

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

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

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

我应该使用哪个版本？

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

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

如何提供帮助

我怎样才能提供帮助？

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

赞助商

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

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

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

PVS-Studio 用于静态分析。
GitHub actions 用于持续集成系统。
OpenCppCoverage 用于代码覆盖率分析。

致谢

由 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 许可证）。
嵌入了 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。