diff --git a/modules/gui/include/vkcv/gui/GUI.hpp b/modules/gui/include/vkcv/gui/GUI.hpp index 0f9d5f47eabdd0e63f4528e0598f36f57dc893f3..d1a9986c5f69bfd9d4392bd5ae50f0b1f8b60642 100644 --- a/modules/gui/include/vkcv/gui/GUI.hpp +++ b/modules/gui/include/vkcv/gui/GUI.hpp @@ -27,6 +27,12 @@ namespace vkcv::gui { event_handle<unsigned int> f_char; public: + /** + * Constructor of a new instance of ImGui management + * + * @param core Valid #Core instance of the framework + * @param window Valid #Window instance of the framework + */ GUI(Core& core, Window& window); GUI(const GUI& other) = delete; @@ -35,10 +41,20 @@ namespace vkcv::gui { GUI& operator=(const GUI& other) = delete; GUI& operator=(GUI&& other) = delete; + /** + * Destructor of a #GUI instance + */ virtual ~GUI(); + /** + * Sets up a new frame for ImGui to draw + */ void beginGUI(); + /** + * Ends a frame for ImGui, renders it and draws it onto + * the currently active swapchain image of the core (ready to present). + */ void endGUI(); };