Font.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_FONT_HPP
#define TGUI_FONT_HPP
 
#include <TGUI/String.hpp>
#include <TGUI/Rect.hpp>
 
#include <cstdint>
#include <string>
#include <cstddef>
#include <memory>

 
namespace tgui
{
    class BackendFont;

    struct TGUI_API FontGlyph
    {
        float     advance = 0;  
        FloatRect bounds;       
        UIntRect  textureRect;  
    };

    class TGUI_API Font
    {
    public:

        static void setGlobalFont(const Font& font);

        TGUI_NODISCARD static Font getGlobalFont();

        Font(std::nullptr_t = nullptr) noexcept;

        Font(const String& id);

        Font(const char* id);

        Font(const void* data, std::size_t sizeInBytes);

        Font(std::shared_ptr<BackendFont> backendFont, String id);

        TGUI_NODISCARD const String& getId() const;

        operator bool() const;

        TGUI_NODISCARD bool operator==(std::nullptr_t) const;

        TGUI_NODISCARD bool operator!=(std::nullptr_t) const;

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

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

        TGUI_NODISCARD FontGlyph getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness = 0) const;

        TGUI_NODISCARD float getKerning(char32_t first, char32_t second, unsigned int characterSize, bool bold = false) const;

        TGUI_NODISCARD float getLineSpacing(unsigned int characterSize) const;

        TGUI_NODISCARD float getFontHeight(unsigned int characterSize) const;

        void setSmooth(bool smooth);

        TGUI_NODISCARD bool isSmooth() const;

        TGUI_NODISCARD std::shared_ptr<BackendFont> getBackendFont() const;

    private:
 
        std::shared_ptr<BackendFont> m_backendFont;
        String m_id;
    };

}

 
#endif // TGUI_FONT_HPP