|
| Font (std::nullptr_t=nullptr) |
| Default constructor which will set the font to nullptr.
|
|
| Font (const String &id) |
| Constructor to create the font from a string (filename by default) More...
|
|
| Font (const char *id) |
| Constructor to create the font from a string (filename by default) More...
|
|
| Font (const void *data, std::size_t sizeInBytes) |
| Constructor to create the font from a byte array. More...
|
|
| Font (std::shared_ptr< BackendFontBase > backendFont, const String &id) |
| Constructor to create the font from an internal backend font. More...
|
|
const String & | getId () const |
| Returns the id that was used to load the font. More...
|
|
| operator bool () const |
| Converts the font to a boolean to check if it is a nullptr of not.
|
|
bool | operator== (std::nullptr_t) const |
| Compares the font with a nullptr.
|
|
bool | operator!= (std::nullptr_t) const |
| Compares the font with a nullptr.
|
|
bool | operator== (const Font &right) const |
| Compares the font with another one.
|
|
bool | operator!= (const Font &right) const |
| Compares the font with another one.
|
|
FontGlyph | getGlyph (char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness=0) const |
| Retrieve a glyph of the font. More...
|
|
float | getKerning (char32_t first, char32_t second, unsigned int characterSize) const |
| Returns the kerning offset of two glyphs. More...
|
|
float | getLineSpacing (unsigned int characterSize) const |
| Returns the line spacing. More...
|
|
std::shared_ptr< BackendFontBase > | getBackendFont () const |
| Returns the internal font. More...
|
|
◆ Font() [1/4]
tgui::Font::Font |
( |
const String & |
id | ) |
|
Constructor to create the font from a string (filename by default)
- Parameters
-
◆ Font() [2/4]
tgui::Font::Font |
( |
const char * |
id | ) |
|
Constructor to create the font from a string (filename by default)
- Parameters
-
◆ Font() [3/4]
tgui::Font::Font |
( |
const void * |
data, |
|
|
std::size_t |
sizeInBytes |
|
) |
| |
Constructor to create the font from a byte array.
- Parameters
-
data | Pointer to the file data in memory |
sizeInBytes | Size of the data to load, in bytes |
◆ Font() [4/4]
Constructor to create the font from an internal backend font.
- Parameters
-
backendFont | Internal font to use |
id | Id of the font (usually filename) |
◆ getBackendFont()
Returns the internal font.
- Returns
- Backend font that is used internally
◆ getGlobalFont()
static Font tgui::Font::getGlobalFont |
( |
| ) |
|
|
static |
Returns the global font that is used for all new widgets.
- Returns
- Global font
◆ getGlyph()
FontGlyph tgui::Font::getGlyph |
( |
char32_t |
codePoint, |
|
|
unsigned int |
characterSize, |
|
|
bool |
bold, |
|
|
float |
outlineThickness = 0 |
|
) |
| const |
Retrieve a glyph of the font.
If the font is a bitmap font, not all character sizes might be available. If the glyph is not available at the requested size, an empty glyph is returned.
- Parameters
-
codePoint | Unicode code point of the character to get |
characterSize | Reference character size |
bold | Retrieve the bold version or the regular one? |
outlineThickness | Thickness of outline (when != 0 the glyph will not be filled) |
- Returns
- The glyph corresponding to codePoint and characterSize
◆ getId()
const String& tgui::Font::getId |
( |
| ) |
const |
Returns the id that was used to load the font.
- Returns
- Id of the font or an empty string when no id was passed when this object was created
◆ getKerning()
float tgui::Font::getKerning |
( |
char32_t |
first, |
|
|
char32_t |
second, |
|
|
unsigned int |
characterSize |
|
) |
| const |
Returns the kerning offset of two glyphs.
The kerning is an extra offset (negative) to apply between two glyphs when rendering them, to make the pair look more "natural". For example, the pair "AV" have a special kerning to make them closer than other characters. Most of the glyphs pairs have a kerning offset of zero, though.
- Parameters
-
first | Unicode code point of the first character |
second | Unicode code point of the second character |
characterSize | Size of the characters |
- Returns
- Kerning value for first and second, in pixels
◆ getLineSpacing()
float tgui::Font::getLineSpacing |
( |
unsigned int |
characterSize | ) |
const |
Returns the line spacing.
Line spacing is the vertical offset to apply between two consecutive lines of text.
- Parameters
-
characterSize | Size of the characters |
- Returns
- Line spacing, in pixels
◆ setGlobalFont()
static void tgui::Font::setGlobalFont |
( |
const Font & |
font | ) |
|
|
static |
Changes the global font that is used for all new widgets.
- Parameters
-
The documentation for this class was generated from the following file: