BackendSFML.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2022 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/Backend.hpp>
#include <SFML/Window/Cursor.hpp> // Can't be an incomplete type when instantiating an object of type BackendSFML
#include <map>
 
 
namespace sf
{
    class Event;
    class Window;
    class RenderTarget;
}
 
namespace tgui
{
    class GuiSFML;
    class BackendRenderTargetSFML;
 
 
    class TGUI_API BackendSFML : public BackendBase
    {
    public:
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use GuiSFML::convertEvent instead") static bool convertEvent(const sf::Event& eventSFML, Event& eventTGUI);
#endif
 
        void attachGui(GuiBase* gui) override;
 
 
        void detatchGui(GuiBase* gui) override;
 
 
        Font createDefaultFont() override;
 
 
        std::shared_ptr<BackendFontBase> createFont() override;
 
 
        std::shared_ptr<BackendTextBase> createText() override;
 
 
        std::shared_ptr<BackendTextureBase> createTexture() override;
 
 
        void setMouseCursorStyle(Cursor::Type type, const std::uint8_t* pixels, Vector2u size, Vector2u hotspot) override;
 
 
        void resetMouseCursorStyle(Cursor::Type type) override;
 
 
        void setMouseCursor(GuiBase* gui, Cursor::Type type) override;
 
 
        void openVirtualKeyboard(const FloatRect& inputRect) override;
 
 
        void closeVirtualKeyboard() override;
 
 
        bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
 
 
        void setClipboard(const String& contents) override;
 
 
        String getClipboard() const override;
 
#ifdef TGUI_SYSTEM_ANDROID
        std::unique_ptr<std::uint8_t[]> readFileFromAndroidAssets(const String& filename, std::size_t& fileSize) const override;
#endif
 
        std::shared_ptr<BackendRenderTargetSFML> createGuiRenderTarget(GuiSFML* gui, sf::RenderTarget& target);
 
 
    protected:
 
        // Helper function to create a system cursor
        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::map<GuiBase*, GuiResources> m_guis;
        std::map<Cursor::Type, std::unique_ptr<sf::Cursor>> m_mouseCursors;
    };
 
}
 
 
#endif // TGUI_BACKEND_SFML_HPP