Minimize Gui interface; update docs

Author: karnkaul

lib/engine/src/engine.cpp

@@ -129,15 +129,15 @@ struct DearImGui : Gui {
 		pool = init_imgui(info);
 	}
 
-	void new_frame() final {
+	void new_frame() {
 		if (state == State::eEndFrame) { end_frame(); }
 		ImGui_ImplVulkan_NewFrame();
 		ImGui_ImplGlfw_NewFrame();
 		ImGui::NewFrame();
 		state = State::eEndFrame;
 	}
 
-	void end_frame() final {
+	void end_frame() {
 		// ImGui::Render calls ImGui::EndFrame
 		ImGui::Render();
 		state = State::eNewFrame;
@@ -151,9 +151,9 @@ struct RenderWindow {
 	Vulkan vulkan;
 	Gfx gfx;
 	Renderer renderer;
-	std::unique_ptr<Gui> gui;
+	std::unique_ptr<DearImGui> gui;
 
-	RenderWindow(UniqueWin window, std::unique_ptr<Gui> gui, std::uint8_t msaa, bool validation)
+	RenderWindow(UniqueWin window, std::unique_ptr<DearImGui> gui, std::uint8_t msaa, bool validation)
 		: window(std::move(window)), vulkan(GlfwWsi{this->window}, validation), gfx(vulkan.gfx()),
 		  renderer(gfx, this->window, gui.get(), Renderer::CreateInfo{command_buffers_v, msaa}), gui(std::move(gui)) {}
 };

lib/render/include/facade/render/gui.hpp

@@ -4,9 +4,9 @@
 #include <facade/vk/gfx.hpp>
 
 namespace facade {
-/// 
-/// \brief Creates a window and a renderer.
-/// 
+///
+/// \brief Abstract interface for GUI (concrete DearImGui authored and owned by Engine).
+///
 class Gui {
   public:
 	struct InitInfo {
@@ -20,9 +20,6 @@ class Gui {
 	virtual ~Gui() = default;
 
 	virtual void init(InitInfo const& info) = 0;
-
-	virtual void new_frame() = 0;
-	virtual void end_frame() = 0;
 	virtual void render(vk::CommandBuffer cb) = 0;
 };
 } // namespace facade

lib/render/include/facade/render/renderer.hpp

@@ -8,12 +8,10 @@
 #include <memory>
 
 namespace facade {
-	
 ///
-/// \brief Handles all information about the frame and what is happening.
+/// \brief Stores various frame statistics.
 ///
 struct FrameStats {
-	
 	///
 	/// \brief Name of the GPU
 	///
@@ -23,7 +21,7 @@ struct FrameStats {
 	/// \brief Total frames so far
 	///
 	std::uint64_t frame_counter{};
-	
+
 	///
 	/// \brief Triangles drawn in previous frame
 	///
@@ -33,33 +31,33 @@ struct FrameStats {
 	/// \brief Draw calls in previous frame
 	///
 	std::uint32_t draw_calls{};
-	
+
 	///
 	/// \brief Framerate (until previous frame)
 	///
 	std::uint32_t fps{};
-	
+
 	///
 	/// \brief Current present mode
 	///
 	vk::PresentModeKHR mode{};
-	
+
 	///
 	/// \brief Multi-sampled anti-aliasing level
 	///
 	vk::SampleCountFlagBits msaa{};
 };
 
 ///
-/// \brief
+/// \brief Initialization data for constructing a Renderer.
 ///
 struct RendererCreateInfo {
 	std::size_t command_buffers{1};
 	std::uint8_t desired_msaa{1};
 };
 
 ///
-/// \brief Creates a window and a renderer.
+/// \brief Owns a Vulkan Swapchain and RenderPass, a Shader::Db and Pipes instance each, and renders to the Window passed in constructor.
 ///
 class Renderer {
   public:

lib/scene/include/facade/scene/camera.hpp

@@ -12,10 +12,11 @@ struct ViewPlane {
 	float far{};
 };
 
-////////////////////////////////////////////////////////////
-/// \brief A camera inside of a 3d plane
 ///
-////////////////////////////////////////////////////////////
+/// \brief Models a 3D camera with either perspective or orthographic projection parameters.
+///
+/// The view matrix is modelled through a Transform that's passed in as a parameter.
+///
 struct Camera {
 	struct Perspective {
 		ViewPlane view_plane{1.0f, 1000.0f};

lib/scene/include/facade/scene/id.hpp

@@ -1,30 +1,30 @@
 #pragma once
+#include <concepts>
 #include <cstdint>
 
 namespace facade {
-////////////////////////////////////////////////////////////
-/// \brief A ID assigned to items inside of the GLTF viewer.
 ///
-////////////////////////////////////////////////////////////
-template <typename T>
+/// \brief Represents a strongly-typed integral ID.
+///
+/// Primarily used for items owned by a Scene.
+///
+template <typename Type, std::integral Value = std::size_t>
 class Id {
   public:
-	using id_type = std::size_t;
+	using id_type = Value;
 
-	////////////////////////////////////////////////////////////
-	/// \brief ADD MORE INFO.
 	///
-	/// \param value ADD MORE INFO.
+	/// \brief Implicit constructor
+	/// \param value The underlying value of this instance
 	///
-	////////////////////////////////////////////////////////////
-	constexpr Id(std::size_t value = {}) : m_value(value) {}
+	constexpr Id(Value value = {}) : m_value(value) {}
 
-	constexpr std::size_t value() const { return m_value; }
-	constexpr operator std::size_t() const { return value(); }
+	constexpr Value value() const { return m_value; }
+	constexpr operator Value() const { return value(); }
 
 	bool operator==(Id const&) const = default;
 
   private:
-	std::size_t m_value{};
+	Value m_value{};
 };
 } // namespace facade