fontcache.h File Reference

Functions to read fonts from files and cache them. More...

#include "string_type.h"
#include "spritecache.h"

Go to the source code of this file.

Data Structures
class	FontCache
	Font cache for basic fonts. More...
struct	FontCacheSubSetting
	Settings for a single font. More...
struct	FontCacheSettings
	Settings for the four different fonts. More...

Typedefs
typedef uint32_t	GlyphID
	Glyphs are characters from a font.

Functions
void	SetUnicodeGlyph (FontSize size, char32_t key, SpriteID sprite)
	Map a SpriteID to the font size and key.
void	InitializeUnicodeGlyphMap ()
	Initialize the glyph map.
void	ClearFontCache ()
const Sprite *	GetGlyph (FontSize size, char32_t key)
	Get the Sprite for a glyph.
uint	GetGlyphWidth (FontSize size, char32_t key)
	Get the width of a glyph.
bool	GetDrawGlyphShadow (FontSize size)
FontCacheSubSetting *	GetFontCacheSubSetting (FontSize fs)
	Get the settings of a given font size. More...
uint	GetFontCacheFontSize (FontSize fs)
	Get the scalable font size to use for a FontSize. More...
std::string	GetFontCacheFontName (FontSize fs)
	Get font to use for a given font size. More...
void	InitFontCache (bool monospace)
	(Re)initialize the font cache related things, i.e. More...
void	UninitFontCache ()
	Free everything allocated w.r.t. More...
bool	GetFontAAState ()
void	SetFont (FontSize fontsize, const std::string &font, uint size)

Variables
static const GlyphID	SPRITE_GLYPH = 1U << 30
FontCacheSettings	_fcsettings

Detailed Description

Functions to read fonts from files and cache them.

Definition in file fontcache.h.

Function Documentation

GetFontCacheFontName()

std::string GetFontCacheFontName

(

FontSize

fs

)

Get font to use for a given font size.

Parameters

fs	Font size.

Returns

If configured, the font name to use, or the path of the default TrueType font if sprites are not preferred.

Definition at line 206 of file fontcache.cpp.

References GetFontCacheSubSetting(), and settings.

Referenced by LoadCoreTextFont(), LoadFreeTypeFont(), and LoadWin32Font().

GetFontCacheFontSize()

uint GetFontCacheFontSize

(

FontSize

fs

)

Get the scalable font size to use for a FontSize.

Parameters

fs	FontSize to get the scalable font size for.

Returns

Scalable font size to use.

Definition at line 162 of file fontcache.cpp.

References GetFontCacheSubSetting(), IsDefaultFont(), and FontCacheSubSetting::size.

GetFontCacheSubSetting()

FontCacheSubSetting* GetFontCacheSubSetting ( FontSize  fs )

inline

Get the settings of a given font size.

Parameters

fs	The font size to look up.

Returns

The settings.

Definition at line 216 of file fontcache.h.

Referenced by GetFontCacheFontName(), GetFontCacheFontSize(), LoadCoreTextFont(), LoadFreeTypeFont(), and LoadWin32Font().

InitFontCache()

void InitFontCache

(

bool

monospace

)

(Re)initialize the font cache related things, i.e.

load the non-sprite fonts.

Parameters

monospace

Whether to initialise the monospace or regular fonts.

Definition at line 218 of file fontcache.cpp.

References FS_BEGIN.

Referenced by MissingGlyphSearcher::FindMissingGlyphs(), and SetFallbackFont().

UninitFontCache()

void UninitFontCache

(

)

Free everything allocated w.r.t.

fonts.

Definition at line 241 of file fontcache.cpp.

References FS_BEGIN.