SDL-Vulkan.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_BACKEND_SDL_VULKAN_INCLUDE_HPP
#define TGUI_BACKEND_SDL_VULKAN_INCLUDE_HPP
 
#include <TGUI/Config.hpp>
#if !TGUI_HAS_BACKEND_SDL_VULKAN
    #error "TGUI wasn't build with the SDL_VULKAN backend"
#endif
 
#include <TGUI/Backend/Font/FreeType/BackendFontFreeType.hpp>
#include <TGUI/Backend/Renderer/Vulkan/BackendRendererVulkan.hpp>
#include <TGUI/Backend/Window/SDL/BackendSDL.hpp>

 
namespace tgui
{
    class SwapchainVulkan;
 
    inline namespace SDL_VULKAN
    {
        class TGUI_API Gui : public BackendGuiSDL
        {
        public:
            Gui();

            Gui(SDL_Window* window, const VulkanContext& vulkanContext);

            ~Gui() override;

            void setWindow(SDL_Window* window, const VulkanContext& vulkanContext);

            void setRenderPass(VkRenderPass renderPass,
                               VkFormat colorFormat,
                               std::uint32_t maxFramesInFlight,
                               std::uint32_t subpass = 0,
                               VkSampleCountFlagBits samples = VK_SAMPLE_COUNT_1_BIT);

            void setDynamicRenderingFormats(VkFormat colorFormat,
                                            std::uint32_t maxFramesInFlight,
                                            VkFormat depthFormat = VK_FORMAT_UNDEFINED,
                                            VkFormat stencilFormat = VK_FORMAT_UNDEFINED,
                                            VkSampleCountFlagBits samples = VK_SAMPLE_COUNT_1_BIT);

            TGUI_DEPRECATED("This backend requires a command buffer, use draw(VkCommandBuffer) instead") void draw() override
            {
                TGUI_ASSERT(false, "The SDL_VULKAN backend requires that you pass a VkCommandBuffer to the draw function");
                throw Exception("The SDL_VULKAN backend requires that you pass a VkCommandBuffer to the draw function");
            }

            void draw(VkCommandBuffer cmdBuffer);

            void mainLoop(Color clearColor = {240, 240, 240}) override;

 
        protected:
            void renderFrame(Color clearColor) override;

            void presentScreen() override;

            void createSwapchain();
 
        protected:
            std::unique_ptr<SwapchainVulkan> m_swapchain; // Only exists while mainLoop is running
        };
    } // namespace SDL_VULKAN
} // namespace tgui
 
#endif // TGUI_BACKEND_SDL_VULKAN_INCLUDE_HPP