BackendRenderTargetSDLGPU.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_RENDER_TARGET_SDL_GPU_HPP
#define TGUI_BACKEND_RENDER_TARGET_SDL_GPU_HPP
 
#include <TGUI/Backend/Renderer/SDL_GPU/BackendTextureSDLGPU.hpp>
 
#if !TGUI_BUILD_AS_CXX_MODULE
    #include <TGUI/Backend/Renderer/BackendRenderTarget.hpp>
#endif

 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API BackendRenderTargetSDLGPU : public BackendRenderTarget
    {
    public:

        BackendRenderTargetSDLGPU(SDL_GPUDevice* device, SDL_GPUTextureFormat swapchainTextureFormat);

        ~BackendRenderTargetSDLGPU();

        void setClearColor(const Color& color) override;

        void clearScreen() override;

        void setView(FloatRect view, FloatRect viewport, Vector2f targetSize) override;

        void drawGui(const std::shared_ptr<RootContainer>&) 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");
        }

        bool prepareDrawGui(const std::shared_ptr<RootContainer>& root, SDL_GPUCommandBuffer* cmdBuffer, SDL_GPUCopyPass* copyPass = nullptr);

        void drawGui(SDL_GPURenderPass* renderPass);

        void drawVertexArray(const RenderStates& states, const Vertex* vertices, std::size_t vertexCount,
                             const unsigned int* indices, std::size_t indexCount, const std::shared_ptr<BackendTexture>& texture) override;

    protected:

        void updateClipping(FloatRect clipRect, FloatRect clipViewport) override;

    protected:
 
        struct DrawCommand
        {
            std::size_t indexCount;
            std::shared_ptr<BackendTexture> texture;
            SDL_Rect clipRect;
        };
 
        SDL_GPUDevice* m_device = nullptr;
        SDL_GPUGraphicsPipeline* m_pipeline = nullptr;
        SDL_GPUSampler* m_samplerNearest = nullptr;
        SDL_GPUSampler* m_samplerLinear = nullptr;
        std::unique_ptr<BackendTextureSDLGPU> m_emptyTexture;
 
        Transform m_projectionTransform;
 
        // Used while prepateDrawGui is being executed
        std::vector<Vertex> m_vertices;
        std::vector<unsigned int> m_indices;
        SDL_Rect m_clipRect;
 
        // Filled duing prepateDrawGui and used during drawGui
        std::vector<DrawCommand> m_drawCommands;
        SDL_GPUBuffer* m_vertexBuffer = nullptr;
        SDL_GPUBuffer* m_indexBuffer = nullptr;
    };

}

 
#endif // TGUI_BACKEND_RENDER_TARGET_SDL_GPU_HPP