TGUI  1.6.1
Loading...
Searching...
No Matches
BackendFontSFML.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef TGUI_BACKEND_FONT_SFML_HPP
26#define TGUI_BACKEND_FONT_SFML_HPP
27
28#include <SFML/Graphics/Font.hpp>
29
30#include <TGUI/Config.hpp>
31#if !TGUI_BUILD_AS_CXX_MODULE
32 #include <TGUI/Backend/Font/BackendFont.hpp>
33#endif
34
35#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
36 #include <unordered_set>
37 #include <memory>
38 #include <map>
39#endif
40
42
43TGUI_MODULE_EXPORT namespace tgui
44{
48 class TGUI_API BackendFontSFML : public BackendFont
49 {
50 public:
51
60 bool loadFromMemory(std::unique_ptr<std::uint8_t[]> data, std::size_t sizeInBytes) override;
61 using BackendFont::loadFromMemory;
62
70 TGUI_NODISCARD bool hasGlyph(char32_t codePoint) const override;
71
85 TGUI_NODISCARD FontGlyph getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness = 0) override;
86
101 TGUI_NODISCARD float getKerning(char32_t first, char32_t second, unsigned int characterSize, bool bold) override;
102
112 TGUI_NODISCARD float getLineSpacing(unsigned int characterSize) override;
113
121 TGUI_NODISCARD float getFontHeight(unsigned int characterSize) override;
122
130 TGUI_NODISCARD float getAscent(unsigned int characterSize) override;
131
139 TGUI_NODISCARD float getDescent(unsigned int characterSize) override;
140
150 TGUI_NODISCARD float getUnderlinePosition(unsigned int characterSize) override;
151
161 TGUI_NODISCARD float getUnderlineThickness(unsigned int characterSize) override;
162
171 TGUI_NODISCARD std::shared_ptr<BackendTexture> getTexture(unsigned int characterSize, unsigned int& textureVersion) override;
172
180 TGUI_NODISCARD Vector2u getTextureSize(unsigned int characterSize) override;
181
191 void setSmooth(bool smooth) override;
192
200 void setFontScale(float scale) override;
201
207 TGUI_NODISCARD sf::Font* getInternalFont();
208
210 protected:
211
212 std::unique_ptr<sf::Font> m_font;
213 std::unique_ptr<std::uint8_t[]> m_fileContents;
214
215 std::unordered_set<std::uint64_t> m_loadedGlyphKeys;
216
217 // We keep one texture per character size. Other font backends don't do this, but this is to prevent existing code
218 // from breaking since sf::Font does the same.
219 std::map<unsigned int, std::shared_ptr<BackendTexture>> m_textures;
220 std::map<unsigned int, unsigned int> m_textureVersions;
221 };
222}
223
225
226#endif // TGUI_BACKEND_FONT_SFML_HPP
Font implementation that makes use of SFML.
Definition BackendFontSFML.hpp:49
float getFontHeight(unsigned int characterSize) override
Returns the height required to render a line of text.
float getUnderlinePosition(unsigned int characterSize) override
Get the position of the underline.
bool hasGlyph(char32_t codePoint) const override
Returns whether a font contains a certain glyph.
FontGlyph getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness=0) override
Retrieve a glyph of the font.
float getUnderlineThickness(unsigned int characterSize) override
Get the thickness of the underline.
bool loadFromMemory(std::unique_ptr< std::uint8_t[]> data, std::size_t sizeInBytes) override
Loads a font from memory.
void setSmooth(bool smooth) override
Enable or disable the smooth filter.
float getLineSpacing(unsigned int characterSize) override
Returns the line spacing.
float getKerning(char32_t first, char32_t second, unsigned int characterSize, bool bold) override
Returns the kerning offset of two glyphs.
std::shared_ptr< BackendTexture > getTexture(unsigned int characterSize, unsigned int &textureVersion) override
Returns the texture that is used to store glyphs of the given character size.
Vector2u getTextureSize(unsigned int characterSize) override
Returns the size of the texture that is used to store glyphs of the given character size.
float getDescent(unsigned int characterSize) override
Returns the maximum height of a glyph below the baseline.
float getAscent(unsigned int characterSize) override
Returns the maximum height of a glyph above the baseline.
Base class for font implementations that depend on the backend.
Definition BackendFont.hpp:45
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
Information about a glyph in the font.
Definition Font.hpp:48