SwapchainVulkan.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2026 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_SWAPCHAIN_VULKAN_HPP
#define TGUI_SWAPCHAIN_VULKAN_HPP
 
#include <TGUI/Color.hpp>
#include <TGUI/Vector2.hpp>
 
#include <memory>
#include <vector>
#include <vulkan/vulkan.h>

 
namespace tgui
{
    class BackendRendererVulkan;

    class SwapchainVulkan
    {
    public:
        // Amount of frames that can be executing on the GPU at the same time, which has to be passed to setRenderPass.
        // With FIFO presentation, more frames would only increase the input latency.
        static constexpr std::uint32_t FramesInFlight = 2;

        SwapchainVulkan(std::shared_ptr<BackendRendererVulkan> renderer, VkSurfaceKHR surface);

        ~SwapchainVulkan();
 
        SwapchainVulkan(const SwapchainVulkan&) = delete;
        SwapchainVulkan& operator=(const SwapchainVulkan&) = delete;

        [[nodiscard]] VkCommandBuffer beginFrame(Vector2u framebufferSize, Color clearColor);

        void endFrame();

        [[nodiscard]] VkRenderPass getRenderPass() const;

        [[nodiscard]] VkFormat getColorFormat() const;

        [[nodiscard]] bool isSurfaceLost() const;

 
    private:
        // Creates the render pass, command buffers and synchronization objects
        void createVulkanObjects();

        // Destroys the objects that were created in createVulkanObjects
        void destroyVulkanObjects();

        // Creates the swapchain and the objects that depend on it. Returns false if the window has no size.
        bool recreateSwapchain(Vector2u framebufferSize);

        // Destroys the image views, framebuffers and semaphores that depend on the swapchain images
        void destroySwapchainImageResources();

 
    private:
        struct FrameSync
        {
            VkCommandBuffer cmdBuffer = VK_NULL_HANDLE;
            VkFence inFlightFence = VK_NULL_HANDLE;
            VkSemaphore imageAvailableSemaphore = VK_NULL_HANDLE;
        };
 
        std::shared_ptr<BackendRendererVulkan> m_renderer;
        VkDevice m_device = VK_NULL_HANDLE;
        VkSurfaceKHR m_surface = VK_NULL_HANDLE;
        VkSurfaceFormatKHR m_surfaceFormat = {};
        VkSwapchainKHR m_swapchain = VK_NULL_HANDLE;
        VkExtent2D m_extent = {};
        Vector2u m_framebufferSize; // Window size that was passed when the swapchain was last created
        VkRenderPass m_renderPass = VK_NULL_HANDLE;
        VkCommandPool m_commandPool = VK_NULL_HANDLE;
 
        // One per swapchain image
        std::vector<VkImageView> m_imageViews;
        std::vector<VkFramebuffer> m_framebuffers;
        std::vector<VkSemaphore> m_renderFinishedSemaphores;
 
        std::vector<FrameSync> m_frames;
        std::size_t m_currentFrame = 0;
        std::uint32_t m_imageIndex = 0;
        bool m_swapchainOutdated = false;
        bool m_surfaceLost = false;
        bool m_rotatedByCompositor = false;
    };
} // namespace tgui
 
#endif // TGUI_SWAPCHAIN_VULKAN_HPP