TGUI  1.0-beta
Loading...
Searching...
No Matches
BackendFontSFML.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2022 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
26#ifndef TGUI_BACKEND_FONT_SFML_HPP
27#define TGUI_BACKEND_FONT_SFML_HPP
28
29#include <TGUI/Backend/Font/BackendFont.hpp>
30#include <SFML/Graphics/Font.hpp>
31#include <unordered_set>
32#include <memory>
33#include <map>
34
36
37namespace tgui
38{
42 class TGUI_API BackendFontSFML : public BackendFont
43 {
44 public:
45
54 bool loadFromMemory(std::unique_ptr<std::uint8_t[]> data, std::size_t sizeInBytes) override;
55 using BackendFont::loadFromMemory;
56
57
65 bool hasGlyph(char32_t codePoint) const override;
66
67
81 FontGlyph getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness = 0) override;
82
83
98 float getKerning(char32_t first, char32_t second, unsigned int characterSize, bool bold) override;
99
100
110 float getLineSpacing(unsigned int characterSize) override;
111
112
120 float getFontHeight(unsigned int characterSize) override;
121
122
130 float getAscent(unsigned int characterSize) override;
131
132
140 float getDescent(unsigned int characterSize) override;
141
142
152 float getUnderlinePosition(unsigned int characterSize) override;
153
154
164 float getUnderlineThickness(unsigned int characterSize) override;
165
166
175 std::shared_ptr<BackendTexture> getTexture(unsigned int characterSize, unsigned int& textureVersion) override;
176
177
185 Vector2u getTextureSize(unsigned int characterSize) override;
186
187
197 void setSmooth(bool smooth) override;
198
199
207 void setFontScale(float scale) override;
208
209
215 sf::Font& getInternalFont();
216
217
219 protected:
220
221 sf::Font m_font;
222 std::unique_ptr<std::uint8_t[]> m_fileContents;
223
224 std::unordered_set<std::uint64_t> m_loadedGlyphKeys;
225
226 // We keep one texture per character size. Other font backends don't do this, but this is to prevent existing code
227 // from breaking since sf::Font does the same.
228 std::map<unsigned int, std::shared_ptr<BackendTexture>> m_textures;
229 std::map<unsigned int, unsigned int> m_textureVersions;
230 };
231}
232
234
235#endif // TGUI_BACKEND_FONT_SFML_HPP
Font implementation that makes use of SFML.
Definition: BackendFontSFML.hpp:43
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:43
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Information about a glyph in the font.
Definition: Font.hpp:47