imgui-flame-graph 项目使用教程

imgui-flame-graph 项目使用教程

imgui-flame-graphA Dear ImGui Widget for displaying Flame Graphs.项目地址:https://gitcode.com/gh_mirrors/im/imgui-flame-graph

1. 项目的目录结构及介绍

imgui-flame-graph/
├── examples/
│   ├── main.cpp
│   └── ...
├── src/
│   ├── imgui_flame_graph.cpp
│   └── imgui_flame_graph.h
├── CMakeLists.txt
├── LICENSE
└── README.md

• examples/: 包含示例代码，展示如何使用 imgui-flame-graph 小部件。
  • main.cpp: 示例程序的主文件，展示如何集成和使用火焰图小部件。
• src/: 包含项目的主要源代码。
  • imgui_flame_graph.cpp: 实现火焰图小部件的核心功能。
  • imgui_flame_graph.h: 定义火焰图小部件的接口和数据结构。
• CMakeLists.txt: 用于构建项目的 CMake 配置文件。
• LICENSE: 项目的许可证文件，采用 MIT 许可证。
• README.md: 项目的说明文档，包含项目的基本信息和使用指南。

2. 项目的启动文件介绍

项目的启动文件位于 examples/main.cpp。该文件展示了如何初始化和运行包含火焰图小部件的示例程序。以下是 main.cpp 的主要内容：

#include "imgui.h"
#include "imgui_impl_glfw.h"
#include "imgui_impl_opengl3.h"
#include "imgui_flame_graph.h"
#include <GLFW/glfw3.h>

int main(int, char**)
{
    // 初始化 GLFW
    if (!glfwInit())
        return -1;

    // 创建窗口
    GLFWwindow* window = glfwCreateWindow(1280, 720, "ImGui Flame Graph Example", NULL, NULL);
    if (window == NULL)
        return -1;

    glfwMakeContextCurrent(window);
    glfwSwapInterval(1); // 启用垂直同步

    // 初始化 ImGui
    IMGUI_CHECKVERSION();
    ImGui::CreateContext();
    ImGuiIO& io = ImGui::GetIO(); (void)io;
    ImGui::StyleColorsDark();

    // 设置 ImGui 后端
    ImGui_ImplGlfw_InitForOpenGL(window, true);
    ImGui_ImplOpenGL3_Init("#version 130");

    // 主循环
    while (!glfwWindowShouldClose(window))
    {
        glfwPollEvents();

        // 开始新帧
        ImGui_ImplOpenGL3_NewFrame();
        ImGui_ImplGlfw_NewFrame();
        ImGui::NewFrame();

        // 渲染火焰图小部件
        static ImFlameGraph flame_graph;
        ImGui::Begin("Flame Graph");
        flame_graph.Draw();
        ImGui::End();

        // 渲染 ImGui
        ImGui::Render();
        int display_w, display_h;
        glfwGetFramebufferSize(window, &display_w, &display_h);
        glViewport(0, 0, display_w, display_h);
        glClear(GL_COLOR_BUFFER_BIT);
        ImGui_ImplOpenGL3_RenderDrawData(ImGui::GetDrawData());

        glfwSwapBuffers(window);
    }

    // 清理
    ImGui_ImplOpenGL3_Shutdown();
    ImGui_ImplGlfw_Shutdown();
    ImGui::DestroyContext();

    glfwDestroyWindow(window);
    glfwTerminate();

    return 0;
}

3. 项目的配置文件介绍

项目的配置文件主要是 CMakeLists.txt，用于配置和构建项目。以下是 CMakeLists.txt 的主要内容：

cmake_minimum_required(VERSION 3.10)
project(imgui-flame-graph)

set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 添加源文件
set(SOURCES
    src/imgui_flame_graph.cpp
    src/imgui_flame_graph.h
)

# 添加示例
add_executable(example examples/main.cpp ${SOURCES})

# 链接库
target

imgui-flame-graphA Dear ImGui Widget for displaying Flame Graphs.项目地址:https://gitcode.com/gh_mirrors/im/imgui-flame-graph