From 84ba7a79ee9fb12c1e872c6389fbc2af4222679c Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 23 Apr 2021 15:36:48 -0600 Subject: [PATCH] Document constructors for SwapchainBuilder Specifically done for the 3rd constructor which will query the necessary queues when they are not provided --- src/VkBootstrap.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/VkBootstrap.h b/src/VkBootstrap.h index 056b462..7c71713 100644 --- a/src/VkBootstrap.h +++ b/src/VkBootstrap.h @@ -614,8 +614,13 @@ void destroy_swapchain(Swapchain const& swapchain); class SwapchainBuilder { public: + // Construct a SwapchainBuilder with a `vkb::Device` explicit SwapchainBuilder(Device const& device); - explicit SwapchainBuilder(Device const& device, VkSurfaceKHR const surface); + // Construct a SwapchainBuilder with a specific VkSurfaceKHR handle and `vkb::Device` + explicit SwapchainBuilder(Device const& device, VkSurfaceKHR const surface); + // Construct a SwapchainBuilder with Vulkan handles for the physical device, device, and surface + // Optionally can provide the uint32_t indices for the graphics and present queue + // Note: The constructor will query the graphics & present queue if the indices are not provided explicit SwapchainBuilder(VkPhysicalDevice const physical_device, VkDevice const device, VkSurfaceKHR const surface,