CanvasSFML.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_SFML_HPP
#define TGUI_CANVAS_SFML_HPP
 
#include <TGUI/Backend/Renderer/SFML-Graphics/BackendTextureSFML.hpp>
 
#if !TGUI_BUILD_AS_CXX_MODULE
    #include <TGUI/Backend/Renderer/BackendRenderTarget.hpp>
    #include <TGUI/Widgets/CanvasBase.hpp>
#endif
 
#include <SFML/Graphics/RenderTexture.hpp>
#include <SFML/Graphics/Sprite.hpp>

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

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

        CanvasSFML(const CanvasSFML& copy);

        CanvasSFML(CanvasSFML&& copy) noexcept;

        CanvasSFML& operator= (const CanvasSFML& right);

        CanvasSFML& operator= (CanvasSFML&& right) noexcept;

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

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

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

        void setView(const sf::View& view);

        TGUI_NODISCARD const sf::View& getView() const;

        void resetView();

        TGUI_NODISCARD sf::View getDefaultView() const;

        TGUI_NODISCARD IntRect getViewport() const;

        TGUI_NODISCARD Vector2f mapPixelToCoords(Vector2f point) const;

        TGUI_NODISCARD Vector2f mapCoordsToPixel(Vector2f coord) const;

        void setSmooth(bool smooth);

        TGUI_NODISCARD bool isSmooth() const;

        void clear(Color color = Color::Black);

        void draw(const sf::Drawable& drawable, const sf::RenderStates& states = {});

        void draw(const sf::Vertex* vertices, std::size_t vertexCount,
                  sf::PrimitiveType type, const sf::RenderStates& states = {});

        void draw(const Sprite& sprite, const RenderStates& states = {});

        void display();

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

        TGUI_NODISCARD sf::RenderTexture& getRenderTexture()
        {
            return m_renderTexture;
        }

    protected:

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

    protected:
 
        sf::RenderTexture m_renderTexture;
        Optional<sf::View> m_customView;
    };
}

 
#endif // TGUI_CANVAS_SFML_HPP