OpenTTD Source: src/fontcache/spritefontcache.h Source File

OpenTTD Source 15.0-beta1

spritefontcache.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#ifndef SPRITEFONTCACHE_H
11#define SPRITEFONTCACHE_H
12
13#include "../string_func.h"
14#include "../fontcache.h"
15
17 class SpriteFontCache : public FontCache {
18public:
19 SpriteFontCache(FontSize fs);
20 void SetUnicodeGlyph(char32_t key, SpriteID sprite) override;
21 void InitializeUnicodeGlyphMap() override;
22 void ClearFontCache() override;
23 const Sprite *GetGlyph(GlyphID key) override;
24 uint GetGlyphWidth(GlyphID key) override;
25 bool GetDrawGlyphShadow() override;
26 GlyphID MapCharToGlyph(char32_t key, bool allow_fallback = true) override;
27 std::string GetFontName() override { return "sprite"; }
28 bool IsBuiltInFont() override { return true; }
29
30private:
31 std::unordered_map<GlyphID, SpriteID> glyph_to_spriteid_map{};
32 SpriteID GetUnicodeGlyph(GlyphID key);
33};
34
35#endif /* SPRITEFONTCACHE_H */
FontCache
Font cache for basic fonts.
Definition fontcache.h:21
FontCache::fs
const FontSize fs
The size of the font.
Definition fontcache.h:25
SpriteFontCache
Font cache for fonts that are based on a freetype font.
Definition spritefontcache.h:17
SpriteFontCache::GetGlyphWidth
uint GetGlyphWidth(GlyphID key) override
Get the width of the glyph with the given key.
Definition spritefontcache.cpp:111
SpriteFontCache::InitializeUnicodeGlyphMap
void InitializeUnicodeGlyphMap() override
Initialize the glyph map.
Definition spritefontcache.cpp:62
SpriteFontCache::MapCharToGlyph
GlyphID MapCharToGlyph(char32_t key, bool allow_fallback=true) override
Map a character into a glyph.
Definition spritefontcache.cpp:118
SpriteFontCache::GetUnicodeGlyph
SpriteID GetUnicodeGlyph(GlyphID key)
Get SpriteID associated with a GlyphID.
Definition spritefontcache.cpp:50
SpriteFontCache::glyph_to_spriteid_map
std::unordered_map< GlyphID, SpriteID > glyph_to_spriteid_map
Mapping of glyphs to sprite IDs.
Definition spritefontcache.h:31
SpriteFontCache::GetDrawGlyphShadow
bool GetDrawGlyphShadow() override
Do we need to draw a glyph shadow?
Definition spritefontcache.cpp:126
SpriteFontCache::GetFontName
std::string GetFontName() override
Get the name of this font.
Definition spritefontcache.h:27
SpriteFontCache::SetUnicodeGlyph
void SetUnicodeGlyph(char32_t key, SpriteID sprite) override
Map a SpriteID to the key.
Definition spritefontcache.cpp:57
SpriteFontCache::ClearFontCache
void ClearFontCache() override
Clear the font cache.
Definition spritefontcache.cpp:97
SpriteFontCache::GetGlyph
const Sprite * GetGlyph(GlyphID key) override
Get the glyph (sprite) of the given key.
Definition spritefontcache.cpp:104
SpriteFontCache::IsBuiltInFont
bool IsBuiltInFont() override
Is this a built-in sprite font?
Definition spritefontcache.h:28
GlyphID
uint32_t GlyphID
Glyphs are characters from a font.
Definition fontcache.h:17
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:18
FontSize
FontSize
Available font sizes.
Definition gfx_type.h:208
Sprite
Data structure describing a sprite.
Definition spritecache.h:17