Add debug UI for system API

Author: JoelOtter

src/core/include/growl/core/api/api_internal.h

@@ -19,14 +19,20 @@ class APIInternal {
 
 	virtual Error init() = 0;
 	virtual void dispose() = 0;
+#ifdef GROWL_IMGUI
+	virtual void populateDebugMenu() {}
+#endif
 };
 
 class SystemAPIInternal : public SystemAPI, public APIInternal {
 public:
 	virtual ~SystemAPIInternal() {}
 	// Used in push-style touch input e.g. on iOS.
 	virtual void onTouch(InputTouchEvent touch) {}
-	virtual void setDarkMode(bool dark_mode) {}
+	virtual void setDarkMode(bool dark_mode) {
+		this->dark_mode = dark_mode;
+	}
+	virtual void populateDebugMenu() override;
 };
 
 class GraphicsAPIInternal : public GraphicsAPI, public APIInternal {

src/core/include/growl/core/api/system_api.h

@@ -16,6 +16,8 @@ class File;
 class Window;
 
 class SystemAPI {
+	friend class SystemAPIInternal;
+
 public:
 	virtual ~SystemAPI() {}
 	virtual bool isRunning() = 0;
@@ -46,7 +48,7 @@ class SystemAPI {
 	virtual void setLogLevel(LogLevel log_level) = 0;
 
 	virtual bool isDarkMode() {
-		return false;
+		return dark_mode;
 	}
 
 	virtual Result<std::unique_ptr<File>>
@@ -56,6 +58,9 @@ class SystemAPI {
 	virtual void
 	logInternal(LogLevel log_level, std::string tag, std::string formatted) = 0;
 	InputProcessor* inputProcessor = nullptr;
+
+private:
+	bool dark_mode;
 };
 
 } // namespace Growl

src/core/include/growl/core/imgui.h

@@ -4,7 +4,9 @@
 
 namespace Growl {
 
-void imGuiBegin();
+class API;
+
+void imGuiBegin(API& api);
 void imGuiBeginGameWindow();
 void imGuiEndGameWindow();
 bool imGuiGameWindowFocused();
@@ -20,6 +22,7 @@ int game_window_y;
 int game_window_w = 0;
 int game_window_h = 0;
 bool game_window_resized;
+bool system_api_view = false;
 } // namespace
 } // namespace Growl
 

src/core/src/api/api.cpp

@@ -1,7 +1,11 @@
 #include "growl/core/api/api.h"
 #include "growl/core/api/api_internal.h"
+#ifdef GROWL_IMGUI
+#include "imgui.h"
+#endif
 
 using Growl::API;
+using Growl::SystemAPIInternal;
 
 void API::addSystemAPI(std::unique_ptr<SystemAPIInternal> internal) {
 	systemInternal = std::move(internal);
@@ -18,3 +22,12 @@ void API::addAudioAPI(std::unique_ptr<AudioAPIInternal> internal) {
 void API::addScriptingAPI(std::unique_ptr<ScriptingAPIInternal> internal) {
 	scriptingInternal = std::move(internal);
 }
+
+#ifdef GROWL_IMGUI
+void SystemAPIInternal::populateDebugMenu() {
+	bool dark_mode = isDarkMode();
+	if (ImGui::Checkbox("Dark mode", &dark_mode)) {
+		setDarkMode(dark_mode);
+	}
+}
+#endif

src/core/src/imgui.cpp

@@ -1,12 +1,29 @@
 #ifdef GROWL_IMGUI
-
 #include "growl/core/imgui.h"
+#include "growl/core/api/api.h"
 #include "imgui.h"
 
-void Growl::imGuiBegin() {
+constexpr const char* SYSTEM_API_WINDOW = "System API";
+
+namespace Growl {
+void doApiWindows(API& api) {
+	if (system_api_view) {
+		ImGui::Begin(SYSTEM_API_WINDOW, &system_api_view);
+		static_cast<SystemAPIInternal&>(api.system()).populateDebugMenu();
+		ImGui::End();
+	}
+}
+} // namespace Growl
+
+void Growl::imGuiBegin(API& api) {
 	ImGui::NewFrame();
 	ImGui::BeginMainMenuBar();
 	ImGui::Text("Growl");
+	if (ImGui::BeginMenu("Views")) {
+		ImGui::SeparatorText("Growl APIs");
+		ImGui::MenuItem("System API", nullptr, &system_api_view);
+		ImGui::EndMenu();
+	}
 	auto size = ImGui::CalcTextSize("0.00 ms/frame (000.0 FPS)");
 	ImGuiStyle& style = ImGui::GetStyle();
 	size.x += style.FramePadding.x * 2 + style.ItemSpacing.x;
@@ -19,6 +36,7 @@ void Growl::imGuiBegin() {
 	ImGui::EndMainMenuBar();
 	ImGuiID dockspace_id = ImGui::GetID("DockSpace");
 	ImGui::DockSpaceOverViewport(dockspace_id);
+	doApiWindows(api);
 }
 
 void Growl::imGuiBeginGameWindow() {

src/plugins/ios/src/ios_system.h

@@ -18,9 +18,6 @@ class IOSSystemAPI : public SystemAPIInternal {
 		return running;
 	}
 
-	void setDarkMode(bool dark_mode) override;
-	bool isDarkMode() override;
-
 	virtual Result<std::unique_ptr<Window>>
 	createWindow(const Config& config) override;
 	void setLogLevel(LogLevel log_level) override;
@@ -40,7 +37,6 @@ class IOSSystemAPI : public SystemAPIInternal {
 
 	API& api;
 	bool running;
-	bool dark_mode;
 	GCController* controller = nullptr;
 	id game_controller_connect_observer;
 	id game_controller_disconnect_observer;

src/plugins/ios/src/ios_system.mm

@@ -93,14 +93,6 @@
 		OS_LOG_DEFAULT, OS_LOG_TYPE_DEBUG, "[%s] %s", tag.c_str(), msg.c_str());
 }
 
-void IOSSystemAPI::setDarkMode(bool dark_mode) {
-	this->dark_mode = dark_mode;
-}
-
-bool IOSSystemAPI::isDarkMode() {
-	return dark_mode;
-}
-
 Result<std::unique_ptr<File>>
 IOSSystemAPI::openFile(std::string path, size_t start, size_t end) {
 	auto full_path =

src/plugins/metal/src/metal_graphics.mm

@@ -65,7 +65,7 @@
 	// Start the Dear ImGui frame
 	ImGui_ImplMetal_NewFrame(imgui_pass);
 	window->newImguiFrame();
-	imGuiBegin();
+	imGuiBegin(api);
 #endif
 }
 

src/plugins/opengl/src/opengl_graphics.cpp

@@ -47,7 +47,7 @@ void OpenGLGraphicsAPI::begin() {
 #ifdef GROWL_IMGUI
 	ImGui_ImplOpenGL3_NewFrame();
 	window->newImguiFrame();
-	imGuiBegin();
+	imGuiBegin(api);
 #endif
 }