Inheritance diagram for CoreTextFontCache:

Public Member Functions
	CoreTextFontCache (FontSize fs, CFAutoRelease< CTFontDescriptorRef > &&font, int pixels)

void	ClearFontCache () override
	Reset cached glyphs.

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?

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

Public Member Functions inherited from TrueTypeFontCache
	TrueTypeFontCache (FontSize fs, int pixels)
	Create a new TrueTypeFontCache.

virtual	~TrueTypeFontCache ()
	Free everything that was allocated for this font cache.

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

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

void	ClearFontCache () override
	Reset cached glyphs.

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?

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	GetGlyphYOffset ()

Private Member Functions
void	SetFontSize (int pixels)

const Sprite *	InternalGetGlyph (GlyphID key, bool use_aa) override

Private Attributes
CFAutoRelease< CTFontDescriptorRef >	font_desc
	Font descriptor excluding font size.

CFAutoRelease< CTFontRef >	font
	CoreText font handle.

std::string	font_name
	Cached font name.

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 TrueTypeFontCache
GlyphEntry *	GetGlyphPtr (GlyphID key)

GlyphEntry &	SetGlyphPtr (GlyphID key, GlyphEntry &&glyph)

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 TrueTypeFontCache
int	req_size = 0
	Requested font size.

int	used_size = 0
	Used font size.

std::unordered_map< GlyphID, GlyphEntry >	glyph_to_sprite_map {}

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 TrueTypeFontCache
static constexpr int	MAX_GLYPH_DIM = 256
	Maximum glyph dimensions.

static constexpr uint	MAX_FONT_MIN_REC_SIZE = 20u
	Upper limit for the recommended font size in case a font file contains nonsensical values.

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

Definition at line 18 of file font_osx.h.

Constructor & Destructor Documentation

◆ CoreTextFontCache()

CoreTextFontCache::CoreTextFontCache	(	FontSize	fs,
		CFAutoRelease< CTFontDescriptorRef > &&	font,
		int	pixels
	)

Definition at line 26 of file font_osx.cpp.

◆ ~CoreTextFontCache()

CoreTextFontCache::~CoreTextFontCache ( )

inline

Definition at line 28 of file font_osx.h.

Member Function Documentation

◆ ClearFontCache()

void CoreTextFontCache::ClearFontCache ( )

overridevirtual

Reset cached glyphs.

Implements FontCache.

Definition at line 34 of file font_osx.cpp.

References TrueTypeFontCache::ClearFontCache(), font, and TrueTypeFontCache::req_size.

◆ GetFontName()

std::string CoreTextFontCache::GetFontName ( )

inlineoverridevirtual

Get the name of this font.

Returns: The name of the font.

Implements FontCache.

Definition at line 32 of file font_osx.h.

References font_name.

◆ GetOSHandle()

const void * CoreTextFontCache::GetOSHandle ( )

inlineoverridevirtual

Get the native OS font handle, if there is one.

Returns: Opaque OS font handle.

Reimplemented from FontCache.

Definition at line 34 of file font_osx.h.

References font.

◆ InternalGetGlyph()

const Sprite * CoreTextFontCache::InternalGetGlyph	(	GlyphID	key,
		bool	use_aa
	)

overrideprivatevirtual

Implements TrueTypeFontCache.

Definition at line 118 of file font_osx.cpp.

◆ IsBuiltInFont()

bool CoreTextFontCache::IsBuiltInFont ( )

inlineoverridevirtual

Is this a built-in sprite font?

Implements FontCache.

Definition at line 33 of file font_osx.h.

◆ MapCharToGlyph()

GlyphID CoreTextFontCache::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 97 of file font_osx.cpp.

References font.

◆ SetFontSize()

void CoreTextFontCache::SetFontSize ( int pixels )

private

Definition at line 42 of file font_osx.cpp.

Field Documentation

◆ font

CFAutoRelease<CTFontRef> CoreTextFontCache::font

private

CoreText font handle.

Definition at line 20 of file font_osx.h.

Referenced by ClearFontCache(), GetOSHandle(), and MapCharToGlyph().

◆ font_desc

CFAutoRelease<CTFontDescriptorRef> CoreTextFontCache::font_desc

private

Font descriptor excluding font size.

Definition at line 19 of file font_osx.h.

◆ font_name

std::string CoreTextFontCache::font_name

private

Cached font name.

Definition at line 22 of file font_osx.h.

Referenced by GetFontName().

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

src/os/macosx/font_osx.h
src/os/macosx/font_osx.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CoreTextFontCache()

◆ ~CoreTextFontCache()

Member Function Documentation

◆ ClearFontCache()

◆ GetFontName()

◆ GetOSHandle()

◆ InternalGetGlyph()

◆ IsBuiltInFont()

◆ MapCharToGlyph()

◆ SetFontSize()

Field Documentation

◆ font

◆ font_desc

◆ font_name