26#ifndef TGUI_BACKEND_FONT_HPP
27#define TGUI_BACKEND_FONT_HPP
29#include <TGUI/Font.hpp>
30#include <TGUI/String.hpp>
31#include <TGUI/Global.hpp>
32#include <TGUI/Backend/Renderer/BackendTexture.hpp>
34#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
40TGUI_MODULE_EXPORT
namespace tgui
103 virtual bool loadFromMemory(std::unique_ptr<std::uint8_t[]> data, std::size_t sizeInBytes) = 0;
126 TGUI_NODISCARD
virtual bool hasGlyph(
char32_t codePoint)
const = 0;
142 TGUI_NODISCARD
virtual FontGlyph getGlyph(
char32_t codePoint,
unsigned int characterSize,
bool bold,
float outlineThickness = 0) = 0;
159 TGUI_NODISCARD
virtual float getKerning(
char32_t first,
char32_t second,
unsigned int characterSize,
bool bold) = 0;
191 TGUI_NODISCARD
virtual float getAscent(
unsigned int characterSize) = 0;
201 TGUI_NODISCARD
virtual float getDescent(
unsigned int characterSize) = 0;
236 TGUI_NODISCARD
virtual std::shared_ptr<BackendTexture>
getTexture(
unsigned int characterSize,
unsigned int& textureVersion) = 0;
278 virtual void setFontScale(
float scale);
305 TGUI_NODISCARD std::uint64_t
constructGlyphKey(
char32_t codePoint,
unsigned int characterSize,
bool bold,
float outlineThickness);
310 bool m_isSmooth =
true;
311 float m_fontScale = 1;
Base class for font implementations that depend on the backend.
Definition BackendFont.hpp:46
virtual TGUI_NODISCARD float getAscent(unsigned int characterSize)=0
Returns the maximum height of a glyph above the baseline.
virtual ~BackendFont()
Virtual destructor.
virtual TGUI_NODISCARD bool hasGlyph(char32_t codePoint) const =0
Returns whether a font contains a certain glyph.
virtual TGUI_NODISCARD float getUnderlineThickness(unsigned int characterSize)=0
Get the thickness of the underline.
virtual TGUI_NODISCARD float getKerning(char32_t first, char32_t second, unsigned int characterSize, bool bold)=0
Returns the kerning offset of two glyphs.
bool loadFromMemory(const void *data, std::size_t sizeInBytes)
Loads a font from memory.
BackendFont & operator=(BackendFont &&other) noexcept
Move assignment operator.
virtual bool loadFromMemory(std::unique_ptr< std::uint8_t[]> data, std::size_t sizeInBytes)=0
Loads a font from memory.
BackendFont(const BackendFont &)
Copy constructor.
virtual TGUI_NODISCARD Vector2u getTextureSize(unsigned int characterSize)=0
Returns the size of the texture that is used to store glyphs of the given character size.
virtual TGUI_NODISCARD std::shared_ptr< BackendTexture > getTexture(unsigned int characterSize, unsigned int &textureVersion)=0
Returns the texture that is used to store glyphs of the given character size.
BackendFont & operator=(const BackendFont &other)
Copy assignment operator.
virtual TGUI_NODISCARD float getLineSpacing(unsigned int characterSize)=0
Returns the line spacing.
TGUI_NODISCARD std::uint64_t constructGlyphKey(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness)
Creates a key for each unique character to render.
virtual TGUI_NODISCARD float getFontHeight(unsigned int characterSize)=0
Returns the height required to render a line of text.
virtual void setSmooth(bool smooth)
Enable or disable the smooth filter.
virtual TGUI_NODISCARD float getDescent(unsigned int characterSize)=0
Returns the maximum height of a glyph below the baseline.
TGUI_NODISCARD bool isSmooth() const
Tell whether the smooth filter is enabled or not.
BackendFont()
Default constructor.
BackendFont(BackendFont &&other) noexcept
Move constructor.
virtual TGUI_NODISCARD FontGlyph getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness=0)=0
Retrieve a glyph of the font.
virtual TGUI_NODISCARD float getUnderlinePosition(unsigned int characterSize)=0
Get the position of the underline.
virtual bool loadFromFile(const String &filename)
Loads a font from a file.
TGUI_NODISCARD float getFontScale() const
Returns the scale at which glyphs are rendered.
Wrapper class to store strings.
Definition String.hpp:101
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
Information about a glyph in the font.
Definition Font.hpp:50