[TOC] # 簡介 ImGui 是一個用於C++的用戶界面庫,跨平臺、無依賴,支持OpenGL、DirectX等多種渲染API,是一種即時UI(Immediate Mode User Interface)庫,保留模式與即時模式的區別參考[**保留模式與即時模式**](https://learn.m ...
目錄
簡介
ImGui 是一個用於C++的用戶界面庫,跨平臺、無依賴,支持OpenGL、DirectX等多種渲染API,是一種即時UI(Immediate Mode User Interface)庫,保留模式與即時模式的區別參考保留模式與即時模式。ImGui渲染非常快,但界面上有大量的數據集需要渲染可能會有一些問題,需要使用一些緩存技巧。緩存只是避免數據的更新邏輯耗時太久影響渲染,實際渲染過程不存在瓶頸。
本文最終實現的應用效果如下:
使用示例
ImGui有master、docking兩個分支,鏈接如下:
- 主分支:https://github.com/ocornut/imgui/tree/master
- docking分支:https://github.com/ocornut/imgui/tree/docking
推薦使用docking分支(支持視窗停靠),本文也是使用的docking分支,先把項目下載下來。
下載示例
從github下載示例,打開examples文件夾下的項目,有很多示例可以選:
我的電腦只有example_glfw_opengl和example_win32_directx兩個系列的示例能直接運行起來,example_win32_directx的界面不知道為什麼看起來很糊,所以只能選擇example_glfw_opengl3的示例來開始後續的內容。
main文件
example_glfw_opengl3項目的源文件如下:
其中,main文件有很多有用的註釋和代碼片段,下麵主要介紹主題、字體部分內容。
設置ImGui風格
ImGui提供Dark、Light、Classic三種風格,示例中預設使用Dark:
// Setup Dear ImGui style
ImGui::StyleColorsDark();
//ImGui::StyleColorsLight();
// Classic在示例註釋裡面沒有提及,但源碼裡面有對應的函數
//ImGui::StyleColorsClassic();
Dark風格:
Light風格:
Classic 風格:
自定義配色方案可參考上面設置風格的函數實現,裡面的顏色種類太多,後面會單獨寫一篇界面美化的文章。
設置字體
ImGui預設字體說實話比較難看,我還是比較喜歡微軟雅黑:
//設置微軟雅黑字體,並指定字體大小
ImFont* font = io.Fonts->AddFontFromFileTTF
(
"C:/Windows/Fonts/msyh.ttc",
30,
nullptr,
//設置載入中文
io.Fonts->GetGlyphRangesChineseFull()
);
//必須判斷一下字體有沒有載入成功
IM_ASSERT(font != nullptr);
註意一下,一定要使用GetGlyphRangesChineseFull(),使用GetGlyphRangesChineseSimplifiedCommon()的話會有部分中文載入不出來。
上面載入字體有兩個問題:固定文件路徑、記憶體占用過高,後面會單獨寫一篇關於字體的文章。
主迴圈
main函數的主迴圈類似其它界面框架的消息迴圈,裡面有一些示例代碼需要刪除,簡化後的代碼大致如下:
while (!glfwWindowShouldClose(window))
{
//一些註釋...
glfwPollEvents();
// Start the Dear ImGui frame
ImGui_ImplOpenGL3_NewFrame();
ImGui_ImplGlfw_NewFrame();
ImGui::NewFrame();
/*
* 添加自己的代碼,App的實現見下麵的代碼
*/
App::RenderUI();
// Rendering
ImGui::Render();
//一些代碼和註釋
glfwSwapBuffers(window);
}
每幀的UI渲染都在App::RenderUI()函數裡面執行,具體實現參考下麵的內容。
添加Application類
實際項目中不可能把所有UI代碼放到Main函數裡面,所以添加命名為Application的頭文件和源文件用來存放UI代碼。
同時,創建一個App的命名空間併在Application.h中引入imgui.h頭文件,在源碼中添加一些示例。
頭文件內容如下:
#pragma once
#include "imgui.h"
namespace App
{
void RenderUI();
}
源碼文件如下:
#include "Application.h"
#include <iostream>
#include <string>
namespace App
{
//選中結果
bool isShowDrag=false;
//字元串結果
std::string text="";
//拖拽值
float fValue = 0.5f;
void RenderUI()
{
//創建一個設置視窗
ImGui::Begin("設置拖拽按鈕");
//按鈕在單擊時返回true(大多數小部件在編輯/激活時返回true)
if (ImGui::Button("按鈕"))
{
//單擊事件處理程式
}
//顯示一些文本(也可以使用字元串格式)
ImGui::Text("這是一個中文字元串");
// 緩衝區用於存儲文本輸入值
char buffer[256] = "";
ImGui::InputText("輸入框", buffer, sizeof(buffer));
//編碼轉換
std::string textU8 = buffer;
ImGui::Checkbox("顯示拖拽", &isShowDrag);
if (isShowDrag)
{
float value = 10.0f;
ImGui::DragFloat(u8"值",&value);
}
//使用從0.0f到1.0f的滑塊編輯1個浮動
ImGui::SliderFloat("float", &fValue, 0.0f, 1.0f);
ImGui::SameLine();
ImGui::Text("Value %f", fValue);
ImGui::End();
}
}
運行結果如下:
中文編碼問題
在上述例子中,有一個關於中文字元串的問題需要註意。預設情況下,VS使用ANSI編碼格式的字元串,因此ImGui會顯示為????。
關於這個問題,網上提供了幾種解決方案:
- 在字元串前面添加u8首碼,例如:ImGui::Begin(u8"顯示中文");
- 將字元串轉換為UTF-8編碼格式後再傳入,例如:ImGui::Begin(string_to_utf8("顯示中文").c_str());
- 使用記事本將源碼文件另存為UTF-8格式(推薦使用),參考B站視頻:imgui 幫助 19
推薦使用第三種方法,它簡單快速。第一種方法實際上沒有作用,依然會顯示亂碼。第二種方法可能會導致部分代碼轉換為換行符,從而導致編譯錯誤。第三種方法只需修改文件的編碼格式,之後可以直接使用中文,無需添加u8首碼。
需要註意的是,將源碼文件另存為UTF-8格式只解決了顯示問題,並沒有解決中文輸入問題。文本框控制項中的中文字元串值採用的是UTF-8格式。如果需要在代碼中列印或保存文本框的輸入值,需要將其轉換為ANSI編碼。可以參考C++字元串編碼轉換進行轉換。需要註意的是,使用標準庫版本的編碼轉換可能存在多線程bug。
界面設計
界面整體使用"左導航右內容"佈局,視窗標題下麵最多加一個菜單欄用來設置一下業務無關的邏輯(如界面主題、停靠選項等),界面效果見文章開頭。下麵會介紹怎麼創建這樣一個界面,包括一些需要註意的問題。
關於imgui_demo.cpp
imgui_demo.cpp有8000多行代碼,裡面有各種有用的示例代碼,下麵需要樹控制項和停靠空間的代碼都是從這裡拷貝改造的。
可以先調用ImGui::ShowDemoWindow()查看示例顯示效果,並根據渲染的字元串到代碼裡面進行搜索,如搜索Basic trees、DockSpace等。
創建停靠空間
ImGui的docking分支雖然支持停靠,但需要使用者主動去創建才能使用。把ShowExampleAppDockSpace函數從imgui_demo.cpp複製到Application.cpp的RenderUI函數裡面,稍微改造刪除一些代碼、註釋。
代碼如下:
void RenderUI()
{
//p_open不需要,改成nullptr
bool* p_open = nullptr;
static bool opt_fullscreen = true;
static bool opt_padding = false;
static ImGuiDockNodeFlags dockspace_flags = ImGuiDockNodeFlags_None; ImGuiWindowFlags window_flags = ImGuiWindowFlags_MenuBar | ImGuiWindowFlags_NoDocking;
if (opt_fullscreen)
{
const ImGuiViewport* viewport = ImGui::GetMainViewport();
ImGui::SetNextWindowPos(viewport->WorkPos);
ImGui::SetNextWindowSize(viewport->WorkSize);
ImGui::SetNextWindowViewport(viewport->ID);
ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, 0.0f);
ImGui::PushStyleVar(ImGuiStyleVar_WindowBorderSize, 0.0f);
window_flags |= ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove;
window_flags |= ImGuiWindowFlags_NoBringToFrontOnFocus | ImGuiWindowFlags_NoNavFocus;
}
else
{
dockspace_flags &= ~ImGuiDockNodeFlags_PassthruCentralNode;
} if (dockspace_flags & ImGuiDockNodeFlags_PassthruCentralNode)
window_flags |= ImGuiWindowFlags_NoBackground; if (!opt_padding)
ImGui::PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(0.0f, 0.0f));
ImGui::Begin("DockSpace Demo", p_open, window_flags);
if (!opt_padding)
ImGui::PopStyleVar(); if (opt_fullscreen)
ImGui::PopStyleVar(2); // Submit the DockSpace
ImGuiIO& io = ImGui::GetIO();
if (io.ConfigFlags & ImGuiConfigFlags_DockingEnable)
{
ImGuiID dockspace_id = ImGui::GetID("MyDockSpace");
ImGui::DockSpace(dockspace_id, ImVec2(0.0f, 0.0f), dockspace_flags);
}
else
{
//不關閉Docking
//ShowDockingDisabledMessage();
} if (ImGui::BeginMenuBar())
{
//菜單做一些漢化
if (ImGui::BeginMenu("選項(Options)"))
{
ImGui::MenuItem("全屏(Fullscreen)", NULL, &opt_fullscreen);
ImGui::MenuItem("填充(Padding)", NULL, &opt_padding);
ImGui::Separator(); if (ImGui::MenuItem("標誌:不分割(Flag: NoSplit)", "", (dockspace_flags & ImGuiDockNodeFlags_NoSplit) != 0)) { dockspace_flags ^=mGuiDockNodeFlags_NoSplit; }
if (ImGui::MenuItem("標誌:不調整大小(Flag: NoResize)", "", (dockspace_flags & ImGuiDockNodeFlags_NoResize) != 0)) { dockspace_flags ^=mGuiDockNodeFlags_NoResize; }
if (ImGui::MenuItem("標誌:不停靠在中心節點(Flag: NoDockingInCentralNode)", "", (dockspace_flags & ImGuiDockNodeFlags_NoDockingInCentralNode) != 0)) {ockspace_flags ^= ImGuiDockNodeFlags_NoDockingInCentralNode; }
if (ImGui::MenuItem("標誌:自動隱藏選項卡欄(Flag: AutoHideTabBar)", "", (dockspace_flags & ImGuiDockNodeFlags_AutoHideTabBar) != 0)) { dockspace_flags= ImGuiDockNodeFlags_AutoHideTabBar; }
if (ImGui::MenuItem("標誌:中心節點篩選器(Flag: PassthruCentralNode)", "", (dockspace_flags & ImGuiDockNodeFlags_PassthruCentralNode) != 0,pt_fullscreen)) { dockspace_flags ^= ImGuiDockNodeFlags_PassthruCentralNode; }
ImGui::Separator();
//不關閉菜單
/* if (ImGui::MenuItem("Close", NULL, false, p_open != NULL))
*p_open = false;*/
ImGui::EndMenu();
}
//增加主題切換
if (ImGui::BeginMenu("主題(Other)"))
{
if (ImGui::MenuItem("暗黑(Dark)")) { ImGui::StyleColorsDark(); }
if (ImGui::MenuItem("明亮(Light)")) { ImGui::StyleColorsLight(); }
if (ImGui::MenuItem("經典(Classic)")) { ImGui::StyleColorsClassic(); }
ImGui::EndMenu();
}
//HelpMarker 不需要
ImGui::EndMenuBar();
}
/**添加自己的視窗**/
ShowTreeView();
ShowMainView();
ImGui::End();
}
創建頁面
先在Application.h文件中定義需要用到的一些函數:
#pragma once
#include "imgui.h"
namespace App
{
//主UI函數,放停靠空間的代碼
void RenderUI();
//隱藏視窗的TabBar
void HideTabBar();
//導航頁面
void ShowTreeView();
//內容頁面
void ShowMainView();
/*
* 內容頁面0-5
*/
void ShowPageView0();
void ShowPageView1();
void ShowPageView2();
void ShowPageView3();
void ShowPageView4();
}
隱藏視窗標簽欄
正常情況下視窗創建後會有一個標簽欄,這個很影響界面外觀需要去掉,參考github上面的issues:以編程方式完成停靠和隱藏選項卡欄。
沒次創建視窗時,需要在ImGui::Begin前面調用,代碼如下:
#include <imgui_internal.h>
void HideTabBar()
{
ImGuiWindowClass window_class;
window_class.DockNodeFlagsOverrideSet = ImGuiDockNodeFlags_NoTabBar;
ImGui::SetNextWindowClass(&window_class);
}
創建導航頁面
導航頁面本質上就是一個樹控制項,使用ImGui自帶的控制項樣式即可,代碼也是從demo裡面拷貝到Application.cpp的,如下所示:
//一級索引
int FirstIdx = 0;
//二級索引
int SecondIdx = 0;
//導航頁面
void ShowTreeView()
{
HideTabBar();
ImGui::Begin("導航視窗");
if (ImGui::TreeNode("功能選項"))
{
for (int i = 0; i < 5; i++)
{
if (i == 0)
ImGui::SetNextItemOpen(true, ImGuiCond_Once);
if (ImGui::TreeNode((void*)(intptr_t)i, "功能 %d", i))
{
ImGui::Text("圖標");
ImGui::SameLine();
if (ImGui::SmallButton("按鈕1")) { FirstIdx = i; SecondIdx = 0; }
ImGui::Text("圖標");
ImGui::SameLine();
if (ImGui::SmallButton("按鈕2")) { FirstIdx = i; SecondIdx = 1; }
ImGui::TreePop();
}
}
ImGui::TreePop();
}
if (ImGui::TreeNode("其它選項"))
{
ImGui::Text("圖標");
ImGui::SameLine();
if (ImGui::SmallButton("按鈕")) { }
ImGui::TreePop();
}
ImGui::End();
}
註:上面的“圖標”使用圖標字體就可以顯示真正的圖標,圖標字體的載入留到後續的文章再說。
創建內容頁面
內容頁面根據導航的索引確定需要渲染的內容,為了避免頁面關於單調,裡面加了一個表格控制項和選項卡控制項的示例,代碼如下:
//內容頁面
void ShowMainView()
{
HideTabBar();
// 清除之前的內容
ImGui::Begin("頁面視窗");
switch (FirstIdx)
{
case 0:
ShowPageView0();
break;
case 1:
ShowPageView1();
break;
case 2:
ShowPageView2();
break;
case 3:
ShowPageView3();
break;
case 4:
ShowPageView4();
break;
default:
break;
}
ImGui::End();
}
void ShowPageView0()
{
ImGui::Text("功能%d -> 按鈕%d -> 頁面0", FirstIdx,SecondIdx);
//一個表格示例
static ImGuiTableFlags flags =
ImGuiTableFlags_SizingFixedFit |
ImGuiTableFlags_RowBg |
ImGuiTableFlags_Borders |
ImGuiTableFlags_Resizable |
ImGuiTableFlags_Reorderable |
ImGuiTableFlags_Hideable;
if (ImGui::BeginTable("table0", 3, flags))
{
ImGui::TableSetupColumn("AAA", ImGuiTableColumnFlags_WidthFixed);
ImGui::TableSetupColumn("BBB", ImGuiTableColumnFlags_WidthFixed);
ImGui::TableSetupColumn("CCC", ImGuiTableColumnFlags_WidthStretch);
ImGui::TableHeadersRow();
for (int row = 0; row < 5; row++)
{
ImGui::TableNextRow();
for (int column = 0; column < 3; column++)
{
ImGui::TableSetColumnIndex(column);
ImGui::Text("%s %d,%d", (column == 2) ? "Stretch" : "Fixed", column, row);
}
}
ImGui::EndTable();
}
}
void ShowPageView1()
{
ImGui::Text("功能%d -> 按鈕%d -> 頁面1", FirstIdx, SecondIdx);
//選項卡示例
ImGuiTabBarFlags tab_bar_flags = ImGuiTabBarFlags_None;
if (ImGui::BeginTabBar("MyTabBar", tab_bar_flags))
{
if (ImGui::BeginTabItem("Avocado"))
{
ImGui::Text("This is the Avocado tab!\nblah blah blah blah blah");
ImGui::EndTabItem();
}
if (ImGui::BeginTabItem("Broccoli"))
{
ImGui::Text("This is the Broccoli tab!\nblah blah blah blah blah");
ImGui::EndTabItem();
}
if (ImGui::BeginTabItem("Cucumber"))
{
ImGui::Text("This is the Cucumber tab!\nblah blah blah blah blah");
ImGui::EndTabItem();
}
ImGui::EndTabBar();
}
}
void ShowPageView2() { ImGui::Text("功能%d -> 按鈕%d -> 頁面2", FirstIdx, SecondIdx); }
void ShowPageView3() { ImGui::Text("功能%d -> 按鈕%d -> 頁面3", FirstIdx, SecondIdx); }
void ShowPageView4() { ImGui::Text("功能%d -> 按鈕%d -> 頁面4", FirstIdx, SecondIdx); }
隱藏控制台視窗
隱藏控制台視窗一般都是調用HWND hWnd = GetConsoleWindow()獲取控制台視窗,然後使用ShowWindow(hWnd, SW_HIDE)隱藏視窗,這裡使用另一種更合理的方法。
右擊項目“屬性->鏈接器->系統->子系統”,將控制台改為視窗,如下圖所示:
然後將main函數改成WinMain函數,代碼如下:
// Main code
//int main(int, char**)
int WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)
如果使用的不是win32,還需要引用以下頭文件:
#include <windows.h>
順便把程式標題也改一下,代碼如下:
// Create window with graphics context
GLFWwindow* window = glfwCreateWindow(1280, 720, "演示程式", nullptr, nullptr);
打包程式
將生成的exe文件重命名為App.exe單獨放到一個文件夾,初次打開需要手動調整佈局,程式退出時佈局自動保存在ImGui.ini文件中。最後打包的文件如下所示:
可以看到exe文件很小,只有500多KB。
總結
待解決問題
本文記錄初次使用ImGui的整個過程,解決了使用過程中的大部分問題,但還有一些細節問題需要解決:
- 字體記憶體載入方式時軟體退出報錯
- 字體文件過大時載入耗時導致白屏
- 程式圖標自定義,預設窗體標題欄的自定義
- 控制項外觀自定義,載入圖標字體作為控制項圖標
這些問題後面會每個單獨寫一篇文章處理,目前的內容已經可以開發一些簡單的應用。
開發優勢
ImGui界面框架是我使用過開發體驗的最好的界面框架,有種在C++中使用Winform開發的感覺,甚至比Winform開發更簡單。這裡要點名吐槽MFC,如果不是工作所迫我是絕對不會用它的。個人感覺ImGui良好的開發體驗主要來自兩方面:
- 即時UI模式降低了界面和數據之間的交互難度
- 框架預設的佈局、樣式降低了開發的心智負擔
ImGui目前主要應用在游戲開發中,但我感覺在其它領域也能很好的發揮作用,在C#中也有ImGui.Net可以使用。
附件
源代碼:提取碼: 59nz