Unshackle renderer; move DearImGui into engine; merge editor with context (#42)

* Merge editor into context; use Gui interface for Renderer

- Move `DearImGui` to engine (internal), have `Engine` create a `GuiDearImGui` instance for the main window.

* Restrict Dear ImGui to a single instance

* Avoid passing incomplete `Renderer` instance to `Gui`.

A class instance technically isn't constructed until the constructor returns: `Renderer` passes `*this` to `Gui` to initialize it.
Duplicate `DearImGui::CreateInfo` as `Gui::InitInfo` instead.

* Remove (now) unecessary API, make DearImGui constructor private

`ConstructTag` approach yields a cleaner implementation: can pass such a dummy object to `std::make_unique` directly instead of having to construct `DearImGui` instance manually, but it muddies the API. Having a private constructor makes it clear to readers that an instance of this class cannot be constructed externally.

* Integrate DearImGui into engine

- Move `Glfw::Wsi` into its own header. (Avoid including vulkan in glfw.hpp).

* Move Window ownership to Context

- Add docs for Engine and Context.

* Cleanup, docs

* Lock shared mutex before using device queue

- Add `Engine::Validation` to enable users to override default logic. This will be useful with RenderDoc, which refuses to load an app that even attempts to check if validation layers are available, unless layers are available in PATH.
- Remove `.at()` indexing in `Scene`: harder to figure out where the problem is when debugging: stack unwinds all the way to try/catch in main.
- Add default camera to `Scene` on its construction.

Author: karnkaul

CMakeLists.txt

@@ -56,7 +56,6 @@ target_sources(${PROJECT_NAME} PRIVATE
 
 target_link_libraries(${PROJECT_NAME} PRIVATE
   facade::context
-  facade::editor
   facade::compile-options
 )
 

lib/CMakeLists.txt

@@ -18,5 +18,4 @@ add_subdirectory(glfw)
 add_subdirectory(render)
 add_subdirectory(scene)
 add_subdirectory(engine)
-add_subdirectory(editor)
 add_subdirectory(context)

lib/context/CMakeLists.txt

@@ -35,5 +35,15 @@ endif()
 target_sources(${PROJECT_NAME} PRIVATE
   include/${target_prefix}/context/context.hpp
 
+  include/${target_prefix}/context/editor/common.hpp
+  include/${target_prefix}/context/editor/inspector.hpp
+  include/${target_prefix}/context/editor/log.hpp
+  include/${target_prefix}/context/editor/scene_tree.hpp
+
   src/context.cpp
+
+  src/editor/common.cpp
+  src/editor/inspector.cpp
+  src/editor/log.cpp
+  src/editor/scene_tree.cpp
 )

lib/context/include/facade/context/context.hpp

@@ -4,20 +4,68 @@
 #include <facade/util/time.hpp>
 
 namespace facade {
+struct ContextCreateInfo {
+	glm::uvec2 extent{1280, 800};
+	char const* title{"facade"};
+	std::uint8_t msaa_samples{2};
+	bool auto_show{false};
+	Engine::Validation validation{Engine::Validation::eDefault};
+};
+
+///
+/// \brief Owns and operates a Window, Engine and Scene
+///
 class Context {
+	// order is important here: window and engine must be initialized before / destroyed after all other data members
+	UniqueWin m_window;
+	Engine m_engine;
+
   public:
-	Context(Engine::CreateInfo const& create_info = {});
+	using CreateInfo = ContextCreateInfo;
+	///
+	/// \brief Construct a Context instance
+	///
+	/// Throws if an instance already exists
+	///
+	Context(CreateInfo const& create_info = {}) noexcept(false);
 
+	///
+	/// \brief Register a shader for the renderer to look up during draws
+	///
 	void add_shader(Shader shader);
 
+	///
+	/// \brief Show the window
+	///
 	void show(bool reset_dt);
+	///
+	/// \brief Hide the window
+	///
+	void hide();
 
-	bool running() const { return engine.running(); }
+	///
+	/// \brief Check if window has been requested to be closed
+	///
+	bool running() const { return !glfwWindowShouldClose(m_window.get()); }
+	///
+	/// \brief Submit previous frame (if applicable), and begin a new frame
+	/// \returns time elapsed since the previous call to next_frame()
+	///
 	float next_frame();
 
-	void request_stop() { engine.request_stop(); }
+	///
+	/// \brief Request window to be closed
+	///
+	void request_stop();
+
+	Glfw::Window const& window() const { return m_window; }
+	Engine const& engine() const { return m_engine; }
+	Glfw::State const& state() const { return m_window.get().state(); }
+	Input const& input() const { return m_window.get().state().input; }
 
-	Engine engine;
+	///
+	/// \brief The scene to render every frame
+	///
 	Scene scene;
 
   private:

lib/editor/include/facade/editor/common.hpp renamed to lib/context/include/facade/context/editor/common.hpp

@@ -85,6 +85,17 @@ class MainMenu : public MenuBar {
 	~MainMenu();
 };
 
+///
+/// \brief RAII Dear ImGui Popup
+///
+class Popup : public Openable {
+  public:
+	explicit Popup(char const* id, int flags = {});
+	~Popup();
+
+	static void close_current();
+};
+
 ///
 /// \brief RAII Dear ImGui StyleVar stack
 ///

lib/editor/include/facade/editor/inspector.hpp renamed to lib/context/include/facade/context/editor/inspector.hpp

@@ -1,5 +1,5 @@
 #pragma once
-#include <facade/editor/common.hpp>
+#include <facade/context/editor/common.hpp>
 #include <facade/scene/material.hpp>
 #include <facade/scene/node.hpp>
 #include <limits>

lib/editor/include/facade/editor/log.hpp renamed to lib/context/include/facade/context/editor/log.hpp

@@ -1,5 +1,5 @@
 #pragma once
-#include <facade/editor/common.hpp>
+#include <facade/context/editor/common.hpp>
 #include <facade/util/enum_array.hpp>
 #include <facade/util/logger.hpp>
 #include <vector>

lib/editor/include/facade/editor/scene_tree.hpp renamed to lib/context/include/facade/context/editor/scene_tree.hpp

@@ -1,5 +1,5 @@
 #pragma once
-#include <facade/editor/common.hpp>
+#include <facade/context/editor/common.hpp>
 #include <facade/scene/id.hpp>
 #include <facade/util/fixed_string.hpp>
 

lib/context/src/context.cpp

@@ -1,21 +1,40 @@
 #include <facade/context/context.hpp>
+#include <facade/render/renderer.hpp>
 
 namespace facade {
-Context::Context(Engine::CreateInfo const& create_info) : engine(create_info), scene(engine.gfx()) {}
+namespace {
+UniqueWin make_window(glm::ivec2 extent, char const* title) {
+	auto ret = Glfw::Window::make();
+	glfwSetWindowTitle(ret.get(), title);
+	glfwSetWindowSize(ret.get(), extent.x, extent.y);
+	return ret;
+}
+} // namespace
+
+Context::Context(CreateInfo const& create_info) noexcept(false)
+	: m_window(make_window(create_info.extent, create_info.title)), m_engine(m_window, create_info.validation, create_info.msaa_samples),
+	  scene(m_engine.gfx()) {
+	if (create_info.auto_show) { show(true); }
+}
 
-void Context::add_shader(Shader shader) { engine.add_shader(std::move(shader)); }
+void Context::add_shader(Shader shader) { m_engine.renderer().add_shader(std::move(shader)); }
 
 void Context::show(bool reset_dt) {
-	engine.show_window();
+	glfwShowWindow(m_window.get());
 	if (reset_dt) { m_dt = {}; }
 }
 
+void Context::hide() { glfwHideWindow(m_window.get()); }
+
+void Context::request_stop() { glfwSetWindowShouldClose(m_window.get(), GLFW_TRUE); }
+
 float Context::next_frame() {
 	if (m_ready_to_render) {
-		if (m_cb) { scene.render(engine.renderer(), m_cb); }
-		engine.submit();
+		if (m_cb) { scene.render(m_engine.renderer(), m_cb); }
+		m_engine.submit();
 	}
-	if (!engine.next_frame(m_cb)) { m_cb = vk::CommandBuffer{}; }
+	m_window.get().glfw->poll_events();
+	if (!m_engine.next_frame(m_cb)) { m_cb = vk::CommandBuffer{}; }
 	m_ready_to_render = true;
 	return m_dt();
 }

lib/editor/src/common.cpp renamed to lib/context/src/editor/common.cpp

@@ -1,5 +1,5 @@
 #include <imgui.h>
-#include <facade/editor/common.hpp>
+#include <facade/context/editor/common.hpp>
 #include <cassert>
 
 namespace facade::editor {
@@ -37,6 +37,14 @@ MainMenu::~MainMenu() {
 	if (m_open) { ImGui::EndMainMenuBar(); }
 }
 
+Popup::Popup(char const* id, int flags) : Openable(ImGui::BeginPopup(id, flags)) {}
+
+Popup::~Popup() {
+	if (m_open) { ImGui::EndPopup(); }
+}
+
+void Popup::close_current() { ImGui::CloseCurrentPopup(); }
+
 Menu::Menu(NotClosed<MenuBar>, char const* label, bool enabled) : Openable(ImGui::BeginMenu(label, enabled)) {}
 
 Menu::~Menu() {