Make the ImGui extension work on all axmol supported platforms (#3083)

halx99 · web-flow · commit 418c28b65cd7 · 2026-03-08T15:35:15.000+08:00
diff --git a/axmol/CMakeLists.txt b/axmol/CMakeLists.txt
@@ -204,12 +204,12 @@ option(AX_ENABLE_EXT_SPINE "Build extension spine" ${AX_EXT_HINT})
 option(AX_ENABLE_EXT_DRAGONBONES "Build extension DragonBones" ${AX_EXT_HINT})
 option(AX_ENABLE_EXT_COCOSTUDIO "Build extension cocostudio" ${AX_EXT_HINT})
 option(AX_ENABLE_EXT_FAIRYGUI "Build extension FairyGUI" ${AX_EXT_HINT})
+option(AX_ENABLE_EXT_IMGUI "Build extension ImGui" ${AX_EXT_HINT})
 option(AX_ENABLE_EXT_LIVE2D "Build extension Live2D" OFF)
 option(AX_ENABLE_EXT_EFFEKSEER "Build extension Effekseer" OFF)
 
 cmake_dependent_option(AX_ENABLE_EXT_PARTICLE3D "Build extension Particle3D" ${AX_EXT_HINT} "AX_ENABLE_3D" OFF)
 cmake_dependent_option(AX_ENABLE_EXT_PHYSICS_NODE "Build extension physics-nodes" ${AX_EXT_HINT} "AX_ENABLE_PHYSICS" OFF)
-cmake_dependent_option(AX_ENABLE_EXT_IMGUI "Build extension ImGui" ${AX_EXT_HINT} "NOT IOS AND NOT WINRT" OFF)
 cmake_dependent_option(AX_ENABLE_EXT_INSPECTOR "Build extension Inspector" ${AX_EXT_HINT} "AX_ENABLE_EXT_IMGUI" OFF)
 cmake_dependent_option(AX_ENABLE_EXT_SDFGEN "Build extension SDFGen" ${AX_EXT_HINT} "AX_ENABLE_EXT_IMGUI" OFF)
 
diff --git a/extensions/ImGui/CMakeLists.txt b/extensions/ImGui/CMakeLists.txt
@@ -25,9 +25,9 @@ set(SOURCE
 list(APPEND SOURCE src/ImGui/backends/imgui_impl_axmol.cpp)
 list(APPEND HEADER src/ImGui/backends/imgui_impl_axmol.h)
 
-if(ANDROID)
-  list(APPEND SOURCE src/ImGui/backends/imgui_impl_android.cpp)
-  list(APPEND HEADER src/ImGui/backends/imgui_impl_android.h)
+if(WINRT OR ANDROID OR IOS)
+  list(APPEND SOURCE src/ImGui/backends/imgui_impl_axmol_sw.cpp)
+  list(APPEND HEADER src/ImGui/backends/imgui_impl_axmol_sw.h)
 else()
   list(APPEND SOURCE src/ImGui/backends/imgui_impl_glfw.cpp)
   list(APPEND HEADER src/ImGui/backends/imgui_impl_glfw.h)
diff --git a/extensions/ImGui/src/ImGui/ImGuiPresenter.cpp b/extensions/ImGui/src/ImGui/ImGuiPresenter.cpp
@@ -24,14 +24,12 @@ THE SOFTWARE.
 
 #include "ImGuiPresenter.h"
 #include <assert.h>
-#if (AX_TARGET_PLATFORM == AX_PLATFORM_ANDROID)
-#    include "backends/imgui_impl_android.h"
-#else
+#if defined(AX_PLATFORM_PC)
 #    include "backends/imgui_impl_glfw.h"
+#    include "backends/imgui_impl_axmol.h"
+#else
+#    include "backends/imgui_impl_axmol_sw.h"
 #endif
-
-#include "backends/imgui_impl_axmol.h"
-
 #include "imgui_internal.h"
 #include "misc/freetype/imgui_freetype.h"
 
@@ -165,7 +163,7 @@ class ImGuiSceneEventTracker : public ImGuiEventTracker
 public:
     bool initWithScene(Scene* scene)
     {
-#if defined(AX_PLATFORM_PC) || defined(__EMSCRIPTEN__)
+#if defined(AX_PLATFORM_PC)
         _trackLayer = utils::newInstance<Node>(&Node::initLayer);
 
         // note: when at the first click to focus the window, this will not take effect
@@ -206,7 +204,7 @@ class ImGuiSceneEventTracker : public ImGuiEventTracker
 
     ~ImGuiSceneEventTracker() override
     {
-#if defined(AX_PLATFORM_PC) || defined(__EMSCRIPTEN__)
+#if defined(AX_PLATFORM_PC)
         if (_trackLayer)
         {
             if (_trackLayer->getParent())
@@ -227,7 +225,7 @@ class ImGuiGlobalEventTracker : public ImGuiEventTracker
 public:
     bool init()
     {
-#if defined(AX_PLATFORM_PC) || defined(__EMSCRIPTEN__)
+#if defined(AX_PLATFORM_PC)
         // note: when at the first click to focus the window, this will not take effect
 
         auto eventDispatcher = Director::getInstance()->getEventDispatcher();
@@ -252,7 +250,7 @@ class ImGuiGlobalEventTracker : public ImGuiEventTracker
 
     ~ImGuiGlobalEventTracker() override
     {
-#if defined(AX_PLATFORM_PC) || defined(__EMSCRIPTEN__)
+#if defined(AX_PLATFORM_PC)
         auto eventDispatcher = Director::getInstance()->getEventDispatcher();
         eventDispatcher->removeEventListener(_mouseListener);
         eventDispatcher->removeEventListener(_touchListener);
@@ -325,11 +323,11 @@ void ImGuiPresenter::init()
         style.Colors[ImGuiCol_WindowBg].w = 1.0f;
     }
 
-#if (AX_TARGET_PLATFORM == AX_PLATFORM_ANDROID)
-    ImGui_ImplAndroid_InitForAxmol(Director::getInstance()->getRenderView(), true);
-#else
+#if defined(AX_PLATFORM_PC)
     auto window = static_cast<RenderViewImpl*>(Director::getInstance()->getRenderView())->getWindow();
     ImGui_ImplGlfw_InitForAxmol(window, true);
+#else
+    ImGui_ImplAxmolSW_InitForAxmol(Director::getInstance()->getRenderView(), true);
 #endif
     ImGui_ImplAxmol_Init();
 
@@ -360,10 +358,10 @@ void ImGuiPresenter::cleanup()
 
     ImGui_ImplAxmol_SetUpdateFontsFunc(nullptr, nullptr);
     ImGui_ImplAxmol_Shutdown();
-#if (AX_TARGET_PLATFORM == AX_PLATFORM_ANDROID)
-    ImGui_ImplAndroid_Shutdown();
-#else
+#if defined(AX_PLATFORM_PC)
     ImGui_ImplGlfw_Shutdown();
+#else
+    ImGui_ImplAxmolSW_Shutdown();
 #endif
 
     ImGui::DestroyContext();
@@ -481,10 +479,10 @@ void ImGuiPresenter::beginFrame()
     {
         // create frame
         ImGui_ImplAxmol_NewFrame();
-#if (AX_TARGET_PLATFORM == AX_PLATFORM_ANDROID)
-        ImGui_ImplAndroid_NewFrame();
-#else
+#if defined(AX_PLATFORM_PC)
         ImGui_ImplGlfw_NewFrame();
+#else
+        ImGui_ImplAxmolSW_NewFrame();
 #endif
         ImGui::NewFrame();
 
diff --git a/extensions/ImGui/src/ImGui/backends/imgui_impl_android.h b/extensions/ImGui/src/ImGui/backends/imgui_impl_android.h
diff --git a/extensions/ImGui/src/ImGui/backends/imgui_impl_axmol.cpp b/extensions/ImGui/src/ImGui/backends/imgui_impl_axmol.cpp
@@ -2,7 +2,7 @@
 
 #include "axmol/base/Director.h"
 #include "axmol/base/Data.h"
-#if !defined(__ANDROID__)
+#if defined(AX_PLATFORM_PC)
 #    include "axmol/platform/RenderViewImpl.h"
 #endif
 #include "axmol/rhi/Program.h"
@@ -470,7 +470,7 @@ IMGUI_IMPL_API void ImGui_ImplAxmol_RenderPlatform()
         ImGui::UpdatePlatformWindows();
         ImGui::RenderPlatformWindowsDefault();
 
-#if !defined(__ANDROID__)
+#if defined(AX_PLATFORM_PC)
         // restore context
         if (rhi::DriverContext::isOpenGL())
         {
@@ -638,7 +638,7 @@ static void ImGui_ImplAxmol_ShutdownMultiViewportSupport()
     ImGui::DestroyPlatformWindows();
 }
 
-#if !defined(__ANDROID__)
+#if defined(AX_PLATFORM_PC)
 IMGUI_IMPL_API void ImGui_ImplAxmol_SetViewResolution(float width, float height)
 {
     // Resize (expand) window
diff --git a/extensions/ImGui/src/ImGui/backends/imgui_impl_axmol_sw.cpp b/extensions/ImGui/src/ImGui/backends/imgui_impl_axmol_sw.cpp
@@ -1,14 +1,9 @@
-#include "imgui_impl_android.h"
-#include "imgui_impl_axmol.h"
+#include "imgui_impl_axmol_sw.h"
 #include "axmol/base/Director.h"
 #include "axmol/base/EventListenerTouch.h"
 #include "axmol/base/IMEDelegate.h"
 #include "axmol/rhi/axmol-rhi.h"
 #include <functional>
-#include <android/native_window.h>
-#include <android/input.h>
-#include <android/keycodes.h>
-#include <android/log.h>
 #include <imgui_internal.h>
 #include "axmol/base/IMEDelegate.h"
 #include "axmol/base/EventDispatcher.h"
@@ -49,15 +44,15 @@ class KeyboardInputDelegate : public IMEDelegate
     }
 };
 
-// Android data
+// Axmol SingleWindow Platform data
 
-struct ImGui_ImplAndroid_Data
+struct ImGui_ImplAxmolSW_Data
 {
     RenderView* Window{nullptr};
     double Time{0};
     bool InstalledCallbacks{false};
 
-    // ImGui_ImplAndroid_Data()   { memset(this, 0, sizeof(*this)); }
+    // ImGui_ImplAxmolSW_Data()   { memset(this, 0, sizeof(*this)); }
 
     // axmol spec data
     Vec2 ViewResolution = Vec2(1920, 1080);
@@ -68,14 +63,14 @@ struct ImGui_ImplAndroid_Data
 };
 
 // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts
-static ImGui_ImplAndroid_Data* ImGui_ImplAndroid_GetBackendData()
+static ImGui_ImplAxmolSW_Data* ImGui_ImplAxmolSW_GetBackendData()
 {
-    return ImGui::GetCurrentContext() ? (ImGui_ImplAndroid_Data*)ImGui::GetIO().BackendPlatformUserData : nullptr;
+    return ImGui::GetCurrentContext() ? (ImGui_ImplAxmolSW_Data*)ImGui::GetIO().BackendPlatformUserData : nullptr;
 }
 
 static ax::Vec2 convertToScreen(const Vec2& pos)
 {
-    auto* bd    = ImGui_ImplAndroid_GetBackendData();
+    auto* bd    = ImGui_ImplAxmolSW_GetBackendData();
     ImGuiIO& io = ImGui::GetIO();
     auto origin = bd->Window->getViewportRect().origin;
     auto uiX    = (pos.x * bd->Window->getScaleX() + origin.x) / io.DisplayFramebufferScale.x;
@@ -110,15 +105,15 @@ static bool ImGui_ImplAxmol_HitTest(const ImVec2& p)
 static int s_CapturedTouchId = -1;
 
 // Functions
-bool ImGui_ImplAndroid_InitForAxmol(RenderView* window, bool install_callbacks)
+bool ImGui_ImplAxmolSW_InitForAxmol(RenderView* window, bool install_callbacks)
 {
     ImGuiIO& io = ImGui::GetIO();
     IM_ASSERT(io.BackendPlatformUserData == nullptr && "Already initialized a platform backend!");
 
     // Setup backend capabilities flags
-    ImGui_ImplAndroid_Data* bd = IM_NEW(ImGui_ImplAndroid_Data)();
+    ImGui_ImplAxmolSW_Data* bd = IM_NEW(ImGui_ImplAxmolSW_Data)();
     io.BackendPlatformUserData = (void*)bd;
-    io.BackendPlatformName     = "imgui_impl_android";
+    io.BackendPlatformName     = "imgui_impl_axmol_sw";
     // io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors;         // We can honor GetMouseCursor() values (optional)
     io.BackendFlags |=
         ImGuiBackendFlags_HasSetMousePos;  // We can honor io.WantSetMousePos requests (optional, rarely used)
@@ -143,7 +138,7 @@ bool ImGui_ImplAndroid_InitForAxmol(RenderView* window, bool install_callbacks)
 
     touchListener->onTouchBegan = [](Touch* touch, Event* event) -> bool {
         ImGuiIO& io                = ImGui::GetIO();
-        ImGui_ImplAndroid_Data* bd = ImGui_ImplAndroid_GetBackendData();
+        ImGui_ImplAxmolSW_Data* bd = ImGui_ImplAxmolSW_GetBackendData();
         auto location              = convertToScreen(touch->getLocationInView());
         auto touchPos              = ImVec2(location.x, location.y);
 
@@ -169,7 +164,7 @@ bool ImGui_ImplAndroid_InitForAxmol(RenderView* window, bool install_callbacks)
         if (touch->getID() != s_CapturedTouchId)
             return;
         ImGuiIO& io                = ImGui::GetIO();
-        ImGui_ImplAndroid_Data* bd = ImGui_ImplAndroid_GetBackendData();
+        ImGui_ImplAxmolSW_Data* bd = ImGui_ImplAxmolSW_GetBackendData();
         auto location              = convertToScreen(touch->getLocationInView());
         io.AddMousePosEvent(location.x, location.y);
         bd->LastValidMousePos = ImVec2(location.x, location.y);
@@ -179,7 +174,7 @@ bool ImGui_ImplAndroid_InitForAxmol(RenderView* window, bool install_callbacks)
         if (touch->getID() != s_CapturedTouchId)
             return;
         ImGuiIO& io                = ImGui::GetIO();
-        ImGui_ImplAndroid_Data* bd = ImGui_ImplAndroid_GetBackendData();
+        ImGui_ImplAxmolSW_Data* bd = ImGui_ImplAxmolSW_GetBackendData();
         auto location              = convertToScreen(touch->getLocationInView());
         io.AddMousePosEvent(location.x, location.y);
         bd->LastValidMousePos = ImVec2(location.x, location.y);
@@ -204,7 +199,7 @@ bool ImGui_ImplAndroid_InitForAxmol(RenderView* window, bool install_callbacks)
             return;
 
         ImGuiIO& io                = ImGui::GetIO();
-        ImGui_ImplAndroid_Data* bd = ImGui_ImplAndroid_GetBackendData();
+        ImGui_ImplAxmolSW_Data* bd = ImGui_ImplAxmolSW_GetBackendData();
         auto location              = convertToScreen(touch->getLocationInView());
         io.AddMousePosEvent(location.x, location.y);
         bd->LastValidMousePos = ImVec2(location.x, location.y);
@@ -219,30 +214,28 @@ bool ImGui_ImplAndroid_InitForAxmol(RenderView* window, bool install_callbacks)
     return true;
 }
 
-void ImGui_ImplAndroid_Shutdown()
+void ImGui_ImplAxmolSW_Shutdown()
 {
-    ImGui_ImplAndroid_Data* bd = ImGui_ImplAndroid_GetBackendData();
+    ImGui_ImplAxmolSW_Data* bd = ImGui_ImplAxmolSW_GetBackendData();
     IM_ASSERT(bd != nullptr && "No platform backend to shutdown, or already shutdown?");
     ImGuiIO& io = ImGui::GetIO();
 
     io.BackendPlatformName     = nullptr;
     io.BackendPlatformUserData = nullptr;
     io.BackendRendererUserData = nullptr;
 
-#if defined(__ANDROID__)
     Director::getInstance()->getEventDispatcher()->removeEventListener(bd->TouchListener);
     AX_SAFE_RELEASE_NULL(bd->TouchListener);
-#endif
 
     IM_DELETE(bd);
 }
 
-void ImGui_ImplAndroid_NewFrame()
+void ImGui_ImplAxmolSW_NewFrame()
 {
     ImGuiIO& io = ImGui::GetIO();
 
-    ImGui_ImplAndroid_Data* bd = ImGui_ImplAndroid_GetBackendData();
-    IM_ASSERT(bd != nullptr && "Did you call ImGui_ImplAndroid_InitForXXX()?");
+    ImGui_ImplAxmolSW_Data* bd = ImGui_ImplAxmolSW_GetBackendData();
+    IM_ASSERT(bd != nullptr && "Did you call ImGui_ImplAxmolSW_InitForXXX()?");
 
     // Setup display size (every frame to accommodate for window resizing)
     int32_t window_width  = bd->ViewResolution.width;
@@ -255,48 +248,17 @@ void ImGui_ImplAndroid_NewFrame()
         io.DisplayFramebufferScale = ImVec2((float)display_width / window_width, (float)display_height / window_height);
 
     // Setup time step
-    struct timespec current_timespec;
-    clock_gettime(CLOCK_MONOTONIC, &current_timespec);
-    double current_time = (double)(current_timespec.tv_sec) + (current_timespec.tv_nsec / 1000000000.0);
+    auto now            = std::chrono::high_resolution_clock::now();
+    auto duration       = now.time_since_epoch();
+    double current_time = std::chrono::duration_cast<std::chrono::nanoseconds>(duration).count() / 1e9;
     io.DeltaTime        = bd->Time > 0.0 ? (float)(current_time - bd->Time) : (float)(1.0f / 60.0f);
     bd->Time            = current_time;
 }
 
-//--------------------------------------------------------------------------------------------------------
-// MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
-// This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports
-// simultaneously. If you are new to dear imgui or creating a new binding for dear imgui, it is recommended that you
-// completely ignore this section first..
-//--------------------------------------------------------------------------------------------------------
-
-// Helper structure we store in the void* RenderUserData field of each ImGuiViewport to easily retrieve our backend
-// data.
-struct ImGui_ImplAndroid_ViewportData
-{
-    RenderView* Window;
-    bool WindowOwned;
-    int IgnoreWindowPosEventFrame;
-    int IgnoreWindowSizeEventFrame;
-
-    ImGui_ImplAndroid_ViewportData()
-    {
-        Window                     = nullptr;
-        WindowOwned                = false;
-        IgnoreWindowSizeEventFrame = IgnoreWindowPosEventFrame = -1;
-    }
-    ~ImGui_ImplAndroid_ViewportData() { IM_ASSERT(Window == nullptr); }
-};
-
-static void ImGui_ImplAndroid_WindowCloseCallback(RenderView* window)
-{
-    if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle(window))
-        viewport->PlatformRequestClose = true;
-}
-
 // @imgui_impl_axmol.h
 IMGUI_IMPL_API void ImGui_ImplAxmol_SetViewResolution(float width, float height)
 {
-    auto bd = ImGui_ImplAndroid_GetBackendData();
+    auto bd = ImGui_ImplAxmolSW_GetBackendData();
     bd->ViewResolution.set(width, height);
 }
 
diff --git a/extensions/ImGui/src/ImGui/backends/imgui_impl_axmol_sw.h b/extensions/ImGui/src/ImGui/backends/imgui_impl_axmol_sw.h
@@ -0,0 +1,8 @@
+#pragma once
+#include "imgui_impl_axmol.h"
+#include "axmol/platform/RenderView.h"
+
+/// ImGui Axmol SingleWindow platform spec APIs
+IMGUI_IMPL_API bool ImGui_ImplAxmolSW_InitForAxmol(ax::RenderView* window, bool install_callbacks);
+IMGUI_IMPL_API void ImGui_ImplAxmolSW_Shutdown();
+IMGUI_IMPL_API void ImGui_ImplAxmolSW_NewFrame();
diff --git a/tests/cpp-tests/CMakeLists.txt b/tests/cpp-tests/CMakeLists.txt
@@ -395,6 +395,7 @@ if(AX_ENABLE_EXT_IMGUI)
   list(APPEND GAME_HEADER Source/ImGuiTest/ImGuiTest.h)
   list(APPEND GAME_SOURCE Source/ImGuiTest/ImGuiTest.cpp)
 
+  # Box2DTestBed is only works on PC platforms, because it requires glfw which is not available on mobile platforms
   if((WINDOWS OR MACOSX OR LINUX OR WASM) AND(NOT WINRT))
     file(GLOB_RECURSE BOX2D_TESTBED_SOURCES Source/Box2DTestBed/*.h;Source/Box2DTestBed/*.cpp;Source/Box2DTestBed/*.c)
     list(APPEND GAME_SOURCE ${BOX2D_TESTBED_SOURCES})
diff --git a/tests/cpp-tests/Source/controller.cpp b/tests/cpp-tests/Source/controller.cpp
@@ -61,7 +61,9 @@ class RootTests : public TestList
         addTest("AudioEngine", []() { return new AudioEngineTests(); });
 
         addTest("Box2D - Basic", []() { return new Box2DTests(); });
-#if AX_ENABLE_EXT_IMGUI && AX_TARGET_PLATFORM != AX_PLATFORM_ANDROID
+
+        // Box2DTestBed is only works on PC platforms, because it requires glfw which is not available on mobile platforms
+#if AX_ENABLE_EXT_IMGUI && defined(AX_PLATFORM_PC)
         addTest("Box2D - TestBed", []() { return new Box2DTestBedTests(); });
 #endif
         addTest("Bugs", []() { return new BugsTests(); });
diff --git a/tests/cpp-tests/Source/feature-detect.h b/tests/cpp-tests/Source/feature-detect.h
diff --git a/tests/cpp-tests/Source/tests.h b/tests/cpp-tests/Source/tests.h
