Font cache for fonts that are based on a freetype font. More...

#include <spritefontcache.h>

Inheritance diagram for SpriteFontCache:

Public Member Functions
	SpriteFontCache (FontSize fs)
	Create a new sprite font cache.

void	ClearFontCache () override
	Clear the font cache.

int	GetGlyphYOffset () override

const Sprite *	GetGlyph (GlyphID key) override
	Get the glyph (sprite) of the given key.

uint	GetGlyphWidth (GlyphID key) override
	Get the width of the glyph with the given key.

bool	GetDrawGlyphShadow () override
	Do we need to draw a glyph shadow?

GlyphID	MapCharToGlyph (char32_t key) override
	Map a character into a glyph.

std::string	GetFontName () override
	Get the name of this font.

bool	IsBuiltInFont () override
	Is this a built-in sprite font?

Public Member Functions inherited from FontCache
FontSize	GetSize () const
	Get the FontSize of the font.

FontIndex	GetIndex () const

FontLoadReason	GetFontLoadReason () const

int	GetHeight () const
	Get the height of the font.

int	GetAscender () const
	Get the ascender value of the font.

int	GetDescender () const
	Get the descender value of the font.

virtual int	GetFontSize () const
	Get the nominal font size of the font.

virtual const void *	GetOSHandle ()
	Get the native OS font handle, if there is one.

Private Member Functions
void	UpdateMetrics ()

Private Attributes
int	scaled_ascender

Additional Inherited Members
Static Public Member Functions inherited from FontCache
static void	InitializeFontCaches ()
	Initialise font caches with the base sprite font cache for all sizes.

static void	UninitializeFontCaches ()
	Free everything allocated w.r.t.

static void	LoadFontCaches (FontSizes fontsizes)
	(Re)initialize the font cache related things, i.e.

static void	ClearFontCaches (FontSizes fontsizes)
	Clear cached information for the specified font caches.

static int	GetDefaultFontHeight (FontSize fs)

static int	GetFontBaseline (FontSize fs)

static void	AddFallback (FontSizes fontsizes, FontLoadReason load_reason, std::string_view name, std::span< const std::byte > os_data={})
	Add a fallback font, with optional OS-specific handle.

template<typename T >
static void	AddFallbackWithHandle (FontSizes fontsizes, FontLoadReason load_reason, std::string_view name, T &handle)
	Add a fallback font, with OS-specific handle.

static std::span< const std::unique_ptr< FontCache > >	Get ()
	Get span of all FontCaches.

static FontCache *	Get (FontIndex font_index)
	Get the font cache of a given font size.

static int	GetCharacterHeight (FontSize fs)

static void	UpdateCharacterHeight (FontSize fs)

static FontIndex	GetDefaultFontIndex (FontSize fs)

static class FontCache *	GetDefaultFontCache (FontSize fs)

static FontIndex	GetFontIndexForCharacter (FontSize fs, char32_t c)

Static Public Attributes inherited from FontCache
static const int	DEFAULT_FONT_HEIGHT [FS_END] = {10, 6, 18, 10}
	Default unscaled font heights.

static const int	DEFAULT_FONT_ASCENDER [FS_END] = {8, 6, 15, 8}
	Default unscaled font ascenders.

Protected Types inherited from FontCache
using	FontCaches = std::vector< std::unique_ptr< FontCache > >

Protected Member Functions inherited from FontCache
	FontCache (FontSize fs)

Static Protected Member Functions inherited from FontCache
static void	Register (std::unique_ptr< FontCache > &&fc, FontLoadReason load_reason)

static void	LoadDefaultFonts (FontSize fs)

static void	LoadFallbackFonts (FontSize fs, FontLoadReason load_reason)

Protected Attributes inherited from FontCache
const FontSize	fs
	The size of the font.

FontIndex	font_index
	The index of the font.

FontLoadReason	load_reason
	Reason why the font is loaded.

int	height = 0
	The height of the font.

int	ascender = 0
	The ascender value of the font.

int	descender = 0
	The descender value of the font.

Static Protected Attributes inherited from FontCache
static FontCaches	caches

static std::array< FontMetrics, FS_END >	metrics {}

static std::array< FontIndex, FS_END >	default_font_index {}

Detailed Description

Font cache for fonts that are based on a freetype font.

Definition at line 16 of file spritefontcache.h.

Constructor & Destructor Documentation

◆ SpriteFontCache()

SpriteFontCache::SpriteFontCache ( FontSize fs )

Create a new sprite font cache.

Parameters

fs	The font size to create the cache for.

Definition at line 107 of file spritefontcache.cpp.

Member Function Documentation

◆ ClearFontCache()

void SpriteFontCache::ClearFontCache ( )

overridevirtual

Clear the font cache.

Implements FontCache.

Definition at line 112 of file spritefontcache.cpp.

References FontCache::fs, and Layouter::ResetFontCache().

◆ GetDrawGlyphShadow()

bool SpriteFontCache::GetDrawGlyphShadow ( )

overridevirtual

Do we need to draw a glyph shadow?

Returns: True if it has to be done, otherwise false.

Implements FontCache.

Definition at line 153 of file spritefontcache.cpp.

◆ GetFontName()

std::string SpriteFontCache::GetFontName ( )

inlineoverridevirtual

Get the name of this font.

Returns: The name of the font.

Implements FontCache.

Definition at line 25 of file spritefontcache.h.

◆ GetGlyph()

const Sprite * SpriteFontCache::GetGlyph ( GlyphID key )

overridevirtual

Get the glyph (sprite) of the given key.

Parameters

key	The key to look up.

Returns: The sprite.

Implements FontCache.

Definition at line 131 of file spritefontcache.cpp.

References Font, FontCache::fs, and GetUnicodeGlyph().

◆ GetGlyphWidth()

uint SpriteFontCache::GetGlyphWidth ( GlyphID key )

overridevirtual

Get the width of the glyph with the given key.

Parameters

key	The key to look up.

Returns: The width.

Implements FontCache.

Definition at line 138 of file spritefontcache.cpp.

References Font, FontCache::fs, FS_NORMAL, GetUnicodeGlyph(), ScaleFontTrad(), and Sprite::width.

◆ GetGlyphYOffset()

int SpriteFontCache::GetGlyphYOffset ( )

overridevirtual

Reimplemented from FontCache.

Definition at line 126 of file spritefontcache.cpp.

◆ IsBuiltInFont()

bool SpriteFontCache::IsBuiltInFont ( )

inlineoverridevirtual

Is this a built-in sprite font?

Implements FontCache.

Definition at line 26 of file spritefontcache.h.

◆ MapCharToGlyph()

GlyphID SpriteFontCache::MapCharToGlyph ( char32_t key )

overridevirtual

Map a character into a glyph.

Parameters

key	The character.

Returns: The glyph ID used to draw the character.

Implements FontCache.

Definition at line 145 of file spritefontcache.cpp.

References FontCache::fs, and GetUnicodeGlyph().

◆ UpdateMetrics()

void SpriteFontCache::UpdateMetrics ( )

private

Definition at line 118 of file spritefontcache.cpp.

Field Documentation

◆ scaled_ascender

int SpriteFontCache::scaled_ascender

private

Definition at line 30 of file spritefontcache.h.

The documentation for this class was generated from the following files:

src/fontcache/spritefontcache.h
src/fontcache/spritefontcache.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpriteFontCache()

Member Function Documentation

◆ ClearFontCache()

◆ GetDrawGlyphShadow()

◆ GetFontName()

◆ GetGlyph()

◆ GetGlyphWidth()

◆ GetGlyphYOffset()

◆ IsBuiltInFont()

◆ MapCharToGlyph()

◆ UpdateMetrics()

Field Documentation

◆ scaled_ascender