BackendSFML.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_SFML_HPP
#define TGUI_BACKEND_SFML_HPP
 
#include <TGUI/Config.hpp>
#include <TGUI/Backend/Window/Backend.hpp>
#include <TGUI/Backend/Window/SFML/BackendGuiSFML.hpp>
 
#include <SFML/Window.hpp>
 
#include <unordered_map>
#include <map>

 
TGUI_IGNORE_DEPRECATED_WARNINGS_START // Required for VS2017 due to inheriting a function that we deprecated
 
namespace tgui
{
    class TGUI_API BackendSFML : public Backend
    {
    public:

        void setGuiWindow(BackendGui* gui, sf::Window* window);

        void detatchGui(BackendGui* gui) override;

        void setMouseCursorStyle(Cursor::Type type, const std::uint8_t* pixels, Vector2u size, Vector2u hotspot) override;

        void resetMouseCursorStyle(Cursor::Type type) override;

        void setMouseCursor(BackendGui* gui, Cursor::Type type) override;
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use BackendGui::startTextInput instead") void openVirtualKeyboard(const FloatRect& inputRect) override;

        TGUI_DEPRECATED("Use BackendGui::stopTextInput instead") void closeVirtualKeyboard() override;
#endif

        TGUI_DEPRECATED("Use gui.isKeyboardModifierPressed(modifierKey) instead") TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;

        void setClipboard(const String& contents) override;

        TGUI_NODISCARD String getClipboard() const override;
 
#ifdef TGUI_SYSTEM_ANDROID
        TGUI_NODISCARD std::unique_ptr<std::uint8_t[]> readFileFromAndroidAssets(const String& filename, std::size_t& fileSize) const override;
#endif

        static void cleanupLeakedCursors();

    protected:

        // Helper function to create a system cursor
        TGUI_NODISCARD std::unique_ptr<sf::Cursor> createSystemCursor(Cursor::Type type);

        // Helper function to update the mouse cursors on all attached guis
        void updateMouseCursor(Cursor::Type type, std::unique_ptr<sf::Cursor> cursor);

        // Helper function to update the mouse cursor on a window
        void updateMouseCursor(sf::Window* window, Cursor::Type type);

    protected:
 
        struct GuiResources
        {
            sf::Window* window = nullptr;
            Cursor::Type mouseCursor = Cursor::Type::Arrow;
        };
 
        std::unordered_map<const BackendGui*, GuiResources> m_guiResources;
        std::unordered_map<Cursor::Type, std::unique_ptr<sf::Cursor>> m_mouseCursors;
 
        static std::vector<std::unique_ptr<sf::Cursor>> m_leakedCursors;
    };

}
 
TGUI_IGNORE_DEPRECATED_WARNINGS_END

 
#endif // TGUI_BACKEND_SFML_HPP