CanvasSDL.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_CANVAS_SDL_HPP
#define TGUI_CANVAS_SDL_HPP
 
#include <TGUI/Backend/Renderer/SDL_Renderer/BackendTextureSDL.hpp>
 
#if !TGUI_BUILD_AS_CXX_MODULE
    #include <TGUI/Backend/Renderer/BackendRenderTarget.hpp>
    #include <TGUI/Widgets/CanvasBase.hpp>
#endif
 
#include <TGUI/extlibs/IncludeSDL.hpp>

 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API CanvasSDL : public CanvasBase
    {
    public:
 
        using Ptr = std::shared_ptr<CanvasSDL>; 
        using ConstPtr = std::shared_ptr<const CanvasSDL>; 
 
        static constexpr const char StaticWidgetType[] = "CanvasSDL"; 

        CanvasSDL(const char* typeName = StaticWidgetType, bool initRenderer = true);

        CanvasSDL(const CanvasSDL& copy);

        CanvasSDL(CanvasSDL&& copy) = default;

        CanvasSDL& operator= (const CanvasSDL& right);

        CanvasSDL& operator= (CanvasSDL&& right) = default;

        TGUI_NODISCARD static CanvasSDL::Ptr create(const Layout2d& size = {"100%", "100%"});

        TGUI_NODISCARD static CanvasSDL::Ptr copy(const CanvasSDL::ConstPtr& canvas);

        void setSize(const Layout2d& size) override;
        using Widget::setSize;

        void draw(BackendRenderTarget& target, RenderStates states) const override;

        TGUI_NODISCARD SDL_Texture* getTextureTarget()
        {
            return m_textureTarget;
        }

    protected:

        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;

    protected:
 
        SDL_Texture* m_textureTarget = nullptr;
        Vector2u m_textureSize;
        Vector2u m_usedTextureSize;
        std::shared_ptr<BackendTextureSDL> m_backendTexture;
    };
}

 
#endif // TGUI_CANVAS_SDL_HPP