Create Surface

Author: karnkaul

guide/src/SUMMARY.md

@@ -11,4 +11,5 @@
 - [Initialization](initialization/README.md)
   - [GLFW Window](initialization/glfw_window.md)
   - [Vulkan Instance](initialization/instance.md)
+  - [Vulkan Surface](initialization/surface.md)
 

guide/src/initialization/surface.md

@@ -0,0 +1,26 @@
+# Vulkan Surface
+
+Being platform agnostic, Vulkan interfaces with the WSI via the [`VK_KHR_surface` extension](https://registry.khronos.org/vulkan/specs/latest/man/html/VK_KHR_surface.html).
+
+Add another helper function in `window.hpp/cpp`:
+
+```cpp
+auto glfw::create_surface(GLFWwindow* window, vk::Instance const instance)
+	-> vk::UniqueSurfaceKHR {
+	VkSurfaceKHR ret{};
+	auto const result =
+		glfwCreateWindowSurface(instance, window, nullptr, &ret);
+	if (result != VK_SUCCESS || ret == VkSurfaceKHR{}) {
+		throw std::runtime_error{"Failed to create Vulkan Surface"};
+	}
+	return vk::UniqueSurfaceKHR{ret, instance};
+}
+```
+
+Add corrseponding members to `App` and create the surface:
+
+```cpp
+void App::create_surface() {
+	m_surface = glfw::create_surface(m_window.get(), *m_instance);
+}
+```

src/app.cpp

@@ -11,6 +11,7 @@ constexpr auto vk_version_v = VK_MAKE_VERSION(1, 3, 0);
 void App::run() {
 	create_window();
 	create_instance();
+	create_surface();
 
 	main_loop();
 }
@@ -38,6 +39,10 @@ void App::create_instance() {
 	VULKAN_HPP_DEFAULT_DISPATCHER.init(*m_instance);
 }
 
+void App::create_surface() {
+	m_surface = glfw::create_surface(m_window.get(), *m_instance);
+}
+
 void App::main_loop() {
 	while (glfwWindowShouldClose(m_window.get()) == GLFW_FALSE) {
 		glfwPollEvents();

src/app.hpp

@@ -10,10 +10,12 @@ class App {
   private:
 	void create_window();
 	void create_instance();
+	void create_surface();
 
 	void main_loop();
 
 	glfw::Window m_window{};
 	vk::UniqueInstance m_instance{};
+	vk::UniqueSurfaceKHR m_surface{};
 };
 } // namespace lvk

src/window.cpp

@@ -24,7 +24,7 @@ auto glfw::create_window(glm::ivec2 const size, char const* title) -> Window {
 		throw std::runtime_error{"Vulkan not supported"};
 	}
 	auto ret = Window{};
-	// tell GLFW we don't want an OpenGL context
+	// tell GLFW that we don't want an OpenGL context.
 	glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API);
 	ret.reset(glfwCreateWindow(size.x, size.y, title, nullptr, nullptr));
 	if (!ret) { throw std::runtime_error{"Failed to create GLFW Window"}; }
@@ -36,4 +36,15 @@ auto glfw::instance_extensions() -> std::span<char const* const> {
 	auto const* extensions = glfwGetRequiredInstanceExtensions(&count);
 	return {extensions, static_cast<std::size_t>(count)};
 }
+
+auto glfw::create_surface(GLFWwindow* window, vk::Instance const instance)
+	-> vk::UniqueSurfaceKHR {
+	VkSurfaceKHR ret{};
+	auto const result =
+		glfwCreateWindowSurface(instance, window, nullptr, &ret);
+	if (result != VK_SUCCESS || ret == VkSurfaceKHR{}) {
+		throw std::runtime_error{"Failed to create Vulkan Surface"};
+	}
+	return vk::UniqueSurfaceKHR{ret, instance};
+}
 } // namespace lvk

src/window.hpp

@@ -1,6 +1,7 @@
 #pragma once
 #include <GLFW/glfw3.h>
 #include <glm/vec2.hpp>
+#include <vulkan/vulkan.hpp>
 #include <memory>
 #include <span>
 
@@ -15,4 +16,7 @@ using Window = std::unique_ptr<GLFWwindow, Deleter>;
 [[nodiscard]] auto create_window(glm::ivec2 size, char const* title) -> Window;
 
 [[nodiscard]] auto instance_extensions() -> std::span<char const* const>;
+
+[[nodiscard]] auto create_surface(GLFWwindow* window, vk::Instance instance)
+	-> vk::UniqueSurfaceKHR;
 } // namespace lvk::glfw