TGUI  1.3.0
Loading...
Searching...
No Matches
BackendFont.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
26#ifndef TGUI_BACKEND_FONT_HPP
27#define TGUI_BACKEND_FONT_HPP
28
29#include <TGUI/Font.hpp>
30#include <TGUI/String.hpp>
31#include <TGUI/Global.hpp>
32#include <TGUI/Backend/Renderer/BackendTexture.hpp>
33
34#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
35 #include <cstdint>
36#endif
37
39
40TGUI_MODULE_EXPORT namespace tgui
41{
45 class TGUI_API BackendFont
46 {
47 public:
48
53
54
59
60
64 BackendFont(BackendFont&& other) noexcept;
65
66
70 virtual ~BackendFont();
71
72
77
78
82 BackendFont& operator=(BackendFont&& other) noexcept;
83
84
92 virtual bool loadFromFile(const String& filename);
93
94
103 virtual bool loadFromMemory(std::unique_ptr<std::uint8_t[]> data, std::size_t sizeInBytes) = 0;
104
105
116 bool loadFromMemory(const void* data, std::size_t sizeInBytes);
117
118
126 TGUI_NODISCARD virtual bool hasGlyph(char32_t codePoint) const = 0;
127
128
142 TGUI_NODISCARD virtual FontGlyph getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness = 0) = 0;
143
144
159 TGUI_NODISCARD virtual float getKerning(char32_t first, char32_t second, unsigned int characterSize, bool bold) = 0;
160
161
171 TGUI_NODISCARD virtual float getLineSpacing(unsigned int characterSize) = 0;
172
173
181 TGUI_NODISCARD virtual float getFontHeight(unsigned int characterSize) = 0;
182
183
191 TGUI_NODISCARD virtual float getAscent(unsigned int characterSize) = 0;
192
193
201 TGUI_NODISCARD virtual float getDescent(unsigned int characterSize) = 0;
202
203
213 TGUI_NODISCARD virtual float getUnderlinePosition(unsigned int characterSize) = 0;
214
215
225 TGUI_NODISCARD virtual float getUnderlineThickness(unsigned int characterSize) = 0;
226
227
236 TGUI_NODISCARD virtual std::shared_ptr<BackendTexture> getTexture(unsigned int characterSize, unsigned int& textureVersion) = 0;
237
238
246 TGUI_NODISCARD virtual Vector2u getTextureSize(unsigned int characterSize) = 0;
247
248
258 virtual void setSmooth(bool smooth);
259
260
268 TGUI_NODISCARD bool isSmooth() const;
269
270
278 virtual void setFontScale(float scale);
279
280
287 TGUI_NODISCARD float getFontScale() const;
288
289
291 protected:
292
305 TGUI_NODISCARD std::uint64_t constructGlyphKey(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness) const;
306
308 protected:
309
310 bool m_isSmooth = true;
311 float m_fontScale = 1;
312 };
313}
314
316
317#endif // TGUI_BACKEND_FONT_HPP
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.
TGUI_NODISCARD std::uint64_t constructGlyphKey(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness) const
Creates a key for each unique character to render.
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.
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