Document constructors for SwapchainBuilder

Specifically done for the 3rd constructor which will query the necessary
queues when they are not provided
This commit is contained in:
Charles Giessen 2021-04-23 15:36:48 -06:00 committed by Charles Giessen
parent 045b1e7b0f
commit 84ba7a79ee

View File

@ -614,8 +614,13 @@ void destroy_swapchain(Swapchain const& swapchain);
class SwapchainBuilder { class SwapchainBuilder {
public: public:
// Construct a SwapchainBuilder with a `vkb::Device`
explicit SwapchainBuilder(Device const& device); explicit SwapchainBuilder(Device const& device);
// Construct a SwapchainBuilder with a specific VkSurfaceKHR handle and `vkb::Device`
explicit SwapchainBuilder(Device const& device, VkSurfaceKHR const surface); 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, explicit SwapchainBuilder(VkPhysicalDevice const physical_device,
VkDevice const device, VkDevice const device,
VkSurfaceKHR const surface, VkSurfaceKHR const surface,