SDL-GPU.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 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_GPU_INCLUDE_HPP
#define TGUI_BACKEND_SDL_GPU_INCLUDE_HPP
 
#include <TGUI/Config.hpp>
#if !TGUI_HAS_BACKEND_SDL_GPU
    #error "TGUI wasn't build with the SDL_GPU backend"
#endif
 
#if !TGUI_BUILD_AS_CXX_MODULE
    #include <TGUI/Backend/Window/SDL/BackendSDL.hpp>
    #include <TGUI/Backend/Renderer/SDL_GPU/BackendRendererSDLGPU.hpp>
    #include <TGUI/Backend/Font/SDL_ttf/BackendFontSDLttf.hpp>
#endif
 
TGUI_MODULE_EXPORT namespace tgui
{
    inline namespace SDL_GPU
    {
        class TGUI_API Gui : public BackendGuiSDL
        {
        public:

            Gui() = default;

            Gui(SDL_Window* window, SDL_GPUDevice* device)
            {
                setWindow(window, device);
            }

            void setWindow(SDL_Window* window, SDL_GPUDevice* device);

            SDL_GPUDevice* getDevice() const;

            void draw() override
            {
                TGUI_ASSERT(false, "The SDL_GPU backend requires that you pass SDL_GPUCommandBuffer and SDL_GPURenderPass pointers to the draw function");
                throw Exception("The SDL_GPU backend requires that you pass SDL_GPUCommandBuffer and SDL_GPURenderPass pointers to the draw function");
            }

            void prepareDraw(SDL_GPUCommandBuffer* cmdBuffer, SDL_GPUCopyPass* copyPass = nullptr);

            void draw(SDL_GPURenderPass* renderPass);

        protected:

            void renderFrame(Color clearColor) override;

            void presentScreen() override;

        protected:
 
            SDL_GPUDevice* m_device = nullptr;
        };
    }
}
 
#endif // TGUI_BACKEND_SDL_GPU_INCLUDE_HPP