Formatting, typos, etc

Author: karnkaul

guide/src/dear_imgui/dear_imgui.md

@@ -4,37 +4,37 @@ Dear ImGui has its own initialization and loop, which we encapsulate into `class
 
 ```cpp
 struct DearImGuiCreateInfo {
-	GLFWwindow* window{};
-	std::uint32_t api_version{};
-	vk::Instance instance{};
-	vk::PhysicalDevice physical_device{};
-	std::uint32_t queue_family{};
-	vk::Device device{};
-	vk::Queue queue{};
-	vk::Format color_format{}; // single color attachment.
-	vk::SampleCountFlagBits samples{};
+  GLFWwindow* window{};
+  std::uint32_t api_version{};
+  vk::Instance instance{};
+  vk::PhysicalDevice physical_device{};
+  std::uint32_t queue_family{};
+  vk::Device device{};
+  vk::Queue queue{};
+  vk::Format color_format{}; // single color attachment.
+  vk::SampleCountFlagBits samples{};
 };
 
 class DearImGui {
   public:
-	using CreateInfo = DearImGuiCreateInfo;
+  using CreateInfo = DearImGuiCreateInfo;
 
-	explicit DearImGui(CreateInfo const& create_info);
+  explicit DearImGui(CreateInfo const& create_info);
 
-	void new_frame();
-	void end_frame();
-	void render(vk::CommandBuffer command_buffer) const;
+  void new_frame();
+  void end_frame();
+  void render(vk::CommandBuffer command_buffer) const;
 
   private:
-	enum class State : std::int8_t { Ended, Begun };
+  enum class State : std::int8_t { Ended, Begun };
 
-	struct Deleter {
-		void operator()(vk::Device device) const;
-	};
+  struct Deleter {
+    void operator()(vk::Device device) const;
+  };
 
-	State m_state{};
+  State m_state{};
 
-	Scoped<vk::Device, Deleter> m_device{};
+  Scoped<vk::Device, Deleter> m_device{};
 };
 ```
 
@@ -103,35 +103,35 @@ m_device = Scoped<vk::Device, Deleter>{create_info.device};
 
 // ...
 void DearImGui::Deleter::operator()(vk::Device const device) const {
-	device.waitIdle();
-	ImGui_ImplVulkan_DestroyFontsTexture();
-	ImGui_ImplVulkan_Shutdown();
-	ImGui_ImplGlfw_Shutdown();
-	ImGui::DestroyContext();
+  device.waitIdle();
+  ImGui_ImplVulkan_DestroyFontsTexture();
+  ImGui_ImplVulkan_Shutdown();
+  ImGui_ImplGlfw_Shutdown();
+  ImGui::DestroyContext();
 }
 ```
 
 The remaining functions are straightforward:
 
 ```cpp
 void DearImGui::new_frame() {
-	if (m_state == State::Begun) { end_frame(); }
-	ImGui_ImplGlfw_NewFrame();
-	ImGui_ImplVulkan_NewFrame();
-	ImGui::NewFrame();
-	m_state = State::Begun;
+  if (m_state == State::Begun) { end_frame(); }
+  ImGui_ImplGlfw_NewFrame();
+  ImGui_ImplVulkan_NewFrame();
+  ImGui::NewFrame();
+  m_state = State::Begun;
 }
 
 void DearImGui::end_frame() {
-	if (m_state == State::Ended) { return; }
-	ImGui::Render();
-	m_state = State::Ended;
+  if (m_state == State::Ended) { return; }
+  ImGui::Render();
+  m_state = State::Ended;
 }
 
 // NOLINTNEXTLINE(readability-convert-member-functions-to-static)
 void DearImGui::render(vk::CommandBuffer const command_buffer) const {
-	auto* data = ImGui::GetDrawData();
-	if (data == nullptr) { return; }
-	ImGui_ImplVulkan_RenderDrawData(data, command_buffer);
+  auto* data = ImGui::GetDrawData();
+  if (data == nullptr) { return; }
+  ImGui_ImplVulkan_RenderDrawData(data, command_buffer);
 }
 ```

guide/src/dear_imgui/imgui_integration.md

@@ -12,18 +12,18 @@ Update `Swapchain` to expose its image format:
 
 ```cpp
 void App::create_imgui() {
-	auto const imgui_ci = DearImGui::CreateInfo{
-		.window = m_window.get(),
-		.api_version = vk_version_v,
-		.instance = *m_instance,
-		.physical_device = m_gpu.device,
-		.queue_family = m_gpu.queue_family,
-		.device = *m_device,
-		.queue = m_queue,
-		.color_format = m_swapchain->get_format(),
-		.samples = vk::SampleCountFlagBits::e1,
-	};
-	m_imgui.emplace(imgui_ci);
+  auto const imgui_ci = DearImGui::CreateInfo{
+    .window = m_window.get(),
+    .api_version = vk_version_v,
+    .instance = *m_instance,
+    .physical_device = m_gpu.device,
+    .queue_family = m_gpu.queue_family,
+    .device = *m_device,
+    .queue = m_queue,
+    .color_format = m_swapchain->get_format(),
+    .samples = vk::SampleCountFlagBits::e1,
+  };
+  m_imgui.emplace(imgui_ci);
 }
 ```
 

guide/src/initialization/swapchain.md

@@ -1,13 +1,13 @@
 # Swapchain
 
-A [Vulkan Swapchain](https://registry.khronos.org/vulkan/specs/latest/man/html/VkSwapchainKHR.html) is an array of presentable images associated with a Surface, which acts as a bridge between the application and the platform's presentation engine (compositor / display engine). The Swapchain will be continually used in the main loop to acquire and present images. Since failing to create a Swapchain is a fatal error, its creation is part of the initialiation section.
+A [Vulkan Swapchain](https://registry.khronos.org/vulkan/specs/latest/man/html/VkSwapchainKHR.html) is an array of presentable images associated with a Surface, which acts as a bridge between the application and the platform's presentation engine (compositor / display engine). The Swapchain will be continually used in the main loop to acquire and present images. Since failing to create a Swapchain is a fatal error, its creation is part of the initialization section.
 
 We shall wrap the Vulkan Swapchain into our own `class Swapchain`. It will also store the a copy of the Images owned by the Vulkan Swapchain, and create (and own) Image Views for each Image. The Vulkan Swapchain may need to be recreated in the main loop, eg when the framebuffer size changes, or an acquire/present operation returns `vk::ErrorOutOfDateKHR`. This will be encapsulated in a `recreate()` function which can simply be called during initialization as well.
 
 ```cpp
 // swapchain.hpp
 class Swapchain {
-  public:
+ public:
   explicit Swapchain(vk::Device device, Gpu const& gpu,
                      vk::SurfaceKHR surface, glm::ivec2 size);
 
@@ -17,7 +17,7 @@ class Swapchain {
     return {m_ci.imageExtent.width, m_ci.imageExtent.height};
   }
 
-  private:
+ private:
   void populate_images();
   void create_image_views();
 

guide/src/shader_objects/shader_program.md

@@ -62,7 +62,7 @@ auto const layers = get_layers(layers_v);
 instance_ci.setPEnabledLayerNames(layers);
 ```
 
-## `class ShaderObject`
+## `class ShaderProgram`
 
 We will encapsulate both vertex and fragment shaders into a single `ShaderProgram`, which will also bind the shaders before a draw, and expose/set various dynamic states.