pyimgui 使用教程

1. 项目介绍

pyimgui 是一个基于 Cython 编写的 Python 绑定库，用于集成 Dear ImGui，这是一款强大的直绘式图形用户界面（GUI）库。Dear ImGui 提供了一种“立即模式”（immediate mode）的方式来创建灵活且高性能的 GUI，而 pyimgui 则让这种功能无缝融入到 Python 程序中。

2. 项目快速启动

首先，确保安装了 pyimgui 及其依赖项。可以通过 pip 来安装：

pip install imgui[full]

以下是一个简单的 HelloWorld 示例，展示了如何在 GLFW3 后端上创建一个窗口并显示 "Hello, world!" 文本：

import glfw
import imgui

def main():
    if not glfw.init():
        raise Exception("Failed to initialize GLFW")

    # 创建窗口
    window = glfw.create_window(650, 400, "pyimgui Example", None, None)
    if not window:
        glfw.terminate()
        raise Exception("Failed to create GLFW window")

    # 初始化 imgui context
    imgui.create_context()

    while not glfw.window_should_close(window):
        glfw.poll_events()

        # 开始一帧
        imgui.new_frame()

        # 显示 Hello, world! 标签
        imgui.text_unformatted("Hello, World!")

        # 渲染 imgui
        imgui.render()
        _, _, width, height = glfw.get_window_size(window)
        buffer = gl.GLuint(0)
        gl.glGenFramebuffers(1, byref(buffer))
        gl.glBindFramebuffer(gl.GL_FRAMEBUFFER, buffer)
        gl.glDrawBuffer(gl.GL_COLOR_ATTACHMENT0)

        # 设置视口大小
        gl.glViewport(0, 0, width, height)
        imgui.impl_glfw.RenderDrawData(imgui.get_draw_data())

        # 恢复默认的 FBO 并交换缓冲区
        gl.glBindFramebuffer(gl.GL_FRAMEBUFFER, 0)
        glfw.swap_buffers(window)

    # 退出前清理
    imgui.destroy_context()
    glfw.terminate()

if __name__ == "__main__":
    main()

3. 应用案例和最佳实践

最佳实践

• 在主循环中调用 imgui.new_frame() 和 imgui.render() 分别表示开始新帧和渲染所有 GUI 元素。
• 对于复杂的 UI 结构，利用 ImGui 的树节点、布局和条件语句来组织界面元素。
• 保持代码清晰，将复杂的逻辑封装到单独的函数或类中。

应用案例

• 创建可交互的数据可视化工具
• 实时调试和性能监控面板
• 配置文件管理界面
• 图形编辑器和设计工具

4. 典型生态项目

• Pygame: pyimgui 支持 Pygame 后端，允许你在 Pygame 应用中集成 GUI 功能。
• GLFW: 如上示例所示，GLFW 是一个广泛使用的图形库，适合开发跨平台的桌面应用。
• Cocos2d: pyimgui 提供对 Cocos2d 游戏引擎的支持，增加游戏开发中的 UI 设计可能性。
• Pyglet: 另一个轻量级的窗口系统库，也受到 pyimgui 的支持。

这些生态项目使得 pyimgui 能够轻松地融入不同的应用场景，增强了 Python 应用程序的交互性和可视化能力。