Texture.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_TEXTURE_HPP
#define TGUI_TEXTURE_HPP

 
#include <TGUI/TextureData.hpp>
#include <TGUI/Vector2.hpp>
#include <TGUI/String.hpp>
#include <TGUI/Global.hpp>
#include <TGUI/Color.hpp>
#include <TGUI/Rect.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
    #include <functional>
#endif
 
#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !TGUI_BUILD_AS_CXX_MODULE
    namespace sf
    {
        class Texture;
        class Shader;
    }
#endif

 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API Texture
    {
    public:
 
        using CallbackFunc = std::function<void(std::shared_ptr<TextureData>)>;
        using BackendTextureLoaderFunc = std::function<bool(BackendTexture&, const String&, bool smooth)>;
        using TextureLoaderFunc = std::function<std::shared_ptr<TextureData>(Texture&, const String&, bool smooth)>;

        Texture() = default;

        Texture(const char* id,
                const UIntRect& partRect = UIntRect(0, 0, 0, 0),
                const UIntRect& middlePart = UIntRect(0, 0, 0, 0),
                bool smooth = m_defaultSmooth)
            : Texture(String{id}, partRect, middlePart, smooth)
        {
        }

        Texture(const String& id,
                const UIntRect& partRect = UIntRect(0, 0, 0, 0),
                const UIntRect& middlePart = UIntRect(0, 0, 0, 0),
                bool smooth = m_defaultSmooth);
 
#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !defined(TGUI_REMOVE_DEPRECATED_CODE)
        TGUI_DEPRECATED("Use Texture() and loadFromPixelData(texture.getSize(), texture.copyToImage().getPixelsPtr()) instead")
        Texture(const sf::Texture& texture,
                const UIntRect& partRect = UIntRect(0, 0, 0, 0),
                const UIntRect& middlePart = UIntRect(0, 0, 0, 0));
#endif
        Texture(const Texture&);

        Texture(Texture&&) noexcept;

        ~Texture();

        Texture& operator=(const Texture&);

        Texture& operator=(Texture&&) noexcept;

        void load(const String& id,
                  const UIntRect& partRect = {},
                  const UIntRect& middleRect = {},
                  bool smooth = m_defaultSmooth);
 
#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !defined(TGUI_REMOVE_DEPRECATED_CODE)
        TGUI_DEPRECATED("Use loadFromPixelData(texture.getSize(), texture.copyToImage().getPixelsPtr()) instead")
        void load(const sf::Texture& texture,
                  const UIntRect& partRect = {},
                  const UIntRect& middleRect = {});
#endif
        void loadFromMemory(const std::uint8_t* data, std::size_t dataSize, const UIntRect& partRect = {}, const UIntRect& middleRect = {}, bool smooth = m_defaultSmooth);

        void loadFromPixelData(Vector2u size, const std::uint8_t* pixels, const UIntRect& partRect = {}, const UIntRect& middleRect = {}, bool smooth = m_defaultSmooth);

        void loadFromBase64(CharStringView imageAsBase64, const UIntRect& partRect = {}, const UIntRect& middleRect = {}, bool smooth = m_defaultSmooth);

        TGUI_NODISCARD const String& getId() const;

        TGUI_NODISCARD std::shared_ptr<TextureData> getData() const;

        TGUI_NODISCARD Vector2u getImageSize() const;

        TGUI_NODISCARD UIntRect getPartRect() const;

        TGUI_NODISCARD bool isSmooth() const;

        void setColor(const Color& color);

        TGUI_NODISCARD const Color& getColor() const;
 
#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS
        void setShader(sf::Shader* shader);

        TGUI_NODISCARD sf::Shader* getShader() const;
#endif
        void setMiddleRect(const UIntRect& middleRect);

        TGUI_NODISCARD UIntRect getMiddleRect() const;

        void setScaledNineSlice(bool scaled);

        TGUI_NODISCARD bool getScaledNineSlice() const;

        TGUI_NODISCARD bool isTransparentPixel(Vector2u pos) const;

        void setCopyCallback(const CallbackFunc& func);

        void setDestructCallback(const CallbackFunc& func);

        TGUI_NODISCARD bool operator==(const Texture& right) const;

        TGUI_NODISCARD bool operator!=(const Texture& right) const;

        static void setDefaultSmooth(bool smooth);

        TGUI_NODISCARD static bool getDefaultSmooth();

        static void setBackendTextureLoader(const BackendTextureLoaderFunc& func);

        TGUI_NODISCARD static const BackendTextureLoaderFunc& getBackendTextureLoader();

        static void setTextureLoader(const TextureLoaderFunc& func);

        TGUI_NODISCARD static const TextureLoaderFunc& getTextureLoader();

    private:

        void setTextureData(std::shared_ptr<TextureData> data, const UIntRect& partRect, const UIntRect& middleRect);

    private:
 
#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS
        sf::Shader* m_shader = nullptr;
#endif
 
        std::shared_ptr<TextureData> m_data = nullptr;
        Color m_color = Color::White;
 
        UIntRect m_partRect;
        UIntRect m_middleRect;
        String   m_id;
        bool     m_scaledNineSlice = false;
 
        CallbackFunc m_copyCallback;
        CallbackFunc m_destructCallback;
 
        static bool m_defaultSmooth;
 
        static TextureLoaderFunc m_textureLoader;
        static BackendTextureLoaderFunc m_backendTextureLoader;
    };

}

 
#endif // TGUI_TEXTURE_HPP