imgui_toggle 使用教程

imgui_toggle 使用教程

imgui_toggle A toggle switch widget for Dear ImGui 项目地址: https://gitcode.com/gh_mirrors/im/imgui_toggle

---

1. 项目目录结构及介绍

imgui_toggle 是一个专为 Dear ImGui 设计的小型可自定义的“开关”样式的按钮组件库。该库的目录结构简洁明了，旨在方便开发者集成和定制。下面是其主要的目录结构概述：

• main: 通常作为主分支存放最新稳定版本的代码。
• cpp 和 h: 这些文件夹包含了实现开关功能的核心源码（.cpp）和头文件（.h），如 imgui_toggle.cpp/h, imgui_toggle_renderer.cpp/h 等，是集成到你的项目中的必要文件。
• meta: 可能包含元数据或配置信息。
• editorconfig: 编辑器配置文件，用于保持代码风格一致。
• LICENSE: 许可证文件，说明了软件使用的许可证类型（0BSD）。
• EXAMPLE.md: 提供了一个详细的示例说明如何使用这些开关组件。
• imgui_offset_rect.h, imgui_toggle_math.h, imgui_toggle_palette.h 等：辅助或扩展功能的头文件。

2. 项目的启动文件介绍

在 imgui_toggle 中，并没有特定标记为“启动文件”的文件，因为它的使用方式是将其源码整合到使用 Dear ImGui 的应用程序中。要开始使用 imgui_toggle，关键在于将提供的 .cpp 文件添加到你的项目编译路径中，并在需要使用开关的地方包含 imgui_toggle.h 头文件。实际的“启动”或说是调用点，是你在自己的应用代码中使用 ImGui::Toggle() 函数的地方。

示例入门

在您的应用中集成 imgui_toggle 的基本步骤可以简化为以下几步：

1. 将所有 *.cpp 和对应的 *.h 文件从 imgui_toggle 项目复制到你的项目源代码目录。
2. 在你需要显示开关的源代码文件中，包含 #include "imgui_toggle.h"。
3. 在 ImGui 渲染循环内调用 ImGui::Toggle("Toggle Label", &yourBoolValue) 来创建并控制开关状态。

3. 项目的配置文件介绍

imgui_toggle 本身不直接提供传统的配置文件。但是，它通过编程方式进行高度定制。配置和样式调整主要是通过直接调用 ImGui 的风格设置函数完成，比如 ImGui::PushStyleColor() 和 ImGui::PopStyleColor()，来改变开关的颜色等视觉属性。这些设置可以在使用 ImGui::Toggle() 前后进行，以适配不同的视觉需求。

例如，如果你想自定义开关颜色，你可能这样操作：

// 自定义开关的“开”状态颜色
ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetColorU32(ImVec4(0.f, 1.f, 0.f, 1.f)));
ImGui::Toggle("My Toggle", &myBooleanValue);
ImGui::PopStyleColor();

此外，更复杂的配置可以通过构造 ImGuiToggleConfig 结构体传递给 ImGui::Toggle() 函数的重载版本来实现。

总结，imgui_toggle 通过源代码级别的集成和API调用来实现配置和启动，而不需要单独的配置文件。这使得它更加灵活，但也要求开发者对Dear ImGui的API有一定的熟悉度。

imgui_toggle A toggle switch widget for Dear ImGui 项目地址: https://gitcode.com/gh_mirrors/im/imgui_toggle