Blam::Content::Fonts Namespace Reference

Namespace containing functions for interacting with font packages. More...

Functions
BLAM void	LoadAllFonts ()
	Loads all available font packages within the fonts directory. More...
BLAM BlamResult	LoadFontDirectory (std::string directory)
	Attempts to load an unpackaged (XML) font from a directory. More...
BLAM BlamResult	LoadFontPackage (std::string file)
	Attempts to load a font package from a file. More...
BLAM BlamResult	LoadFont (std::string font_name)
BLAM BlamMap< std::string, BlamFontPackage * >	GetFontList ()
	Retrieves the map of all available fonts. More...
BLAM bool	FontExists (std::string id)
	Checks if a font package exists with a given name. More...
BLAM BlamFontPackage *	GetFont (std::string id)
	Retrieves a font package from its name. More...
BLAM void	Cleanup ()
	Releases all font package data from memory. More...

Detailed Description

Namespace containing functions for interacting with font packages.

For more information, see BlamFontPackage.

Function Documentation

Cleanup()

void Blam::Content::Fonts::Cleanup

(

)

Releases all font package data from memory.

Here is the caller graph for this function:

FontExists()

bool Blam::Content::Fonts::FontExists

(

std::string

id

)

Checks if a font package exists with a given name.

Parameters

id	- The unique ID/name of the font package.

Returns

true if the font exists, otherwise returns false.

GetFont()

BlamFontPackage * Blam::Content::Fonts::GetFont

(

std::string

id

)

Retrieves a font package from its name.

Parameters

id	- The unique ID/name of the desired font package.

Returns

Pointer to the font package. If the font could not be found, then nullptr is returned.

Here is the caller graph for this function:

GetFontList()

BlamMap< std::string, BlamFontPackage * > Blam::Content::Fonts::GetFontList

(

)

Retrieves the map of all available fonts.

Each key contains the name of the font, and each value contains the pointer to the associated font package.

Returns

A BlamMap containing all available font packages.

Here is the caller graph for this function:

LoadAllFonts()

void Blam::Content::Fonts::LoadAllFonts

(

)

Loads all available font packages within the fonts directory.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadFont()

BlamResult Blam::Content::Fonts::LoadFont

(

std::string

font_name

)

Todo:

Implement.

LoadFontDirectory()

BlamResult Blam::Content::Fonts::LoadFontDirectory

(

std::string

directory

)

Attempts to load an unpackaged (XML) font from a directory.

Parameters

directory

- The path to the font directory.

Returns

BlamResult::Success_OK if the font was loaded successfully, otherwise returns an error code.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadFontPackage()

BlamResult Blam::Content::Fonts::LoadFontPackage

(

std::string

file

)

Attempts to load a font package from a file.

Parameters

file	- The path to the font package file.

Returns

BlamResult::Success_OK if the font was loaded successfully, otherwise returns an error code.

Todo:

Implement.

Here is the caller graph for this function: