TGUI  0.10-dev
BackendFont.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2021 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#include <cstdint>
34
36
37namespace tgui
38{
42 class TGUI_API BackendFont
43 {
44 public:
45
49 virtual ~BackendFont() = default;
50
51
59 virtual bool loadFromFile(const String& filename);
60
61
70 virtual bool loadFromMemory(std::unique_ptr<std::uint8_t[]> data, std::size_t sizeInBytes) = 0;
71
72
83 bool loadFromMemory(const void* data, std::size_t sizeInBytes);
84
85
93 virtual bool hasGlyph(char32_t codePoint) const = 0;
94
95
109 virtual FontGlyph getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness = 0) = 0;
110
111
126 virtual float getKerning(char32_t first, char32_t second, unsigned int characterSize, bool bold) = 0;
127
128
138 virtual float getLineSpacing(unsigned int characterSize) = 0;
139
140
150 virtual float getUnderlinePosition(unsigned int characterSize) = 0;
151
152
162 virtual float getUnderlineThickness(unsigned int characterSize) = 0;
163
164
172 virtual std::shared_ptr<BackendTexture> getTexture(unsigned int characterSize) = 0;
173
174
184 virtual void setSmooth(bool smooth);
185
186
194 bool isSmooth() const;
195
196
198 protected:
199
200
213 std::uint64_t constructGlyphKey(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness);
214
215
217 protected:
218
219 bool m_isSmooth = true;
220 };
221}
222
224
225#endif // TGUI_BACKEND_FONT_HPP
Base class for font implementations that depend on the backend.
Definition: BackendFont.hpp:43
virtual ~BackendFont()=default
Virtual destructor.
bool loadFromMemory(const void *data, std::size_t sizeInBytes)
Loads a font from memory.
virtual bool loadFromMemory(std::unique_ptr< std::uint8_t[]> data, std::size_t sizeInBytes)=0
Loads a font from memory.
virtual float getUnderlineThickness(unsigned int characterSize)=0
Get the thickness of the underline.
virtual float getUnderlinePosition(unsigned int characterSize)=0
Get the position of the underline.
virtual float getLineSpacing(unsigned int characterSize)=0
Returns the line spacing.
bool isSmooth() const
Tell whether the smooth filter is enabled or not.
std::uint64_t constructGlyphKey(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness)
Creates a key for each unique character to render.
virtual void setSmooth(bool smooth)
Enable or disable the smooth filter.
virtual float getKerning(char32_t first, char32_t second, unsigned int characterSize, bool bold)=0
Returns the kerning offset of two glyphs.
virtual std::shared_ptr< BackendTexture > getTexture(unsigned int characterSize)=0
Returns the texture that is used to store glyphs of the given character size.
virtual bool hasGlyph(char32_t codePoint) const =0
Returns whether a font contains a certain glyph.
virtual bool loadFromFile(const String &filename)
Loads a font from a file.
virtual FontGlyph getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness=0)=0
Retrieve a glyph of the font.
Wrapper class to store strings.
Definition: String.hpp:79
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Information about a glyph in the font.
Definition: Font.hpp:47