fontAPI_t Struct Reference

About this class

Font library.

Public Member Functions
float	GetID (font_s fnt)
	Get the internal font id. More...
void	Load (string fontDef, font_s &fntNew)
	Load a desired .font definition into memory. More...
string	RGBtoHex (vector normalizedColor)
	Converts a normalized RGB color vector to a hex color string. More...
int	GetHeight (font_s fnt)
	Returns the height of a specified font in pixels. More...
float	StringWidth (string inputText, bool hasColor, font_s fnt)
	Returns the width of a series of characters in pixels. More...

Member Function Documentation

GetHeight()

int fontAPI_t::GetHeight

(

font_s

fnt

)

Returns the height of a specified font in pixels.

Parameters

fnt	is the font to be queried.

Returns

is the height of a font in pixels.

See also

Font_StringWidth

GetID()

float fontAPI_t::GetID

(

font_s

fnt

)

Get the internal font id.

The internal font id is only useful for when you want to assign 'drawfont' yourself, or have some other use for it. Those id's are meant to be unique, but may change between vid_reload or other cases where video memory is de-allocated. Overall you should never need to use this, unless you know what you're doing or are porting old code.

Parameters

fnt	is the font to be queried.

Returns

the internal 'drawfont' id of the specified font.

Load()

void fontAPI_t::Load	(	string	fontDef,
		font_s &	fntNew
	)

Load a desired .font definition into memory.

Parameters

strFile	is the path to the file in question.
fntNew	is the location of where the font will be stored.

RGBtoHex()

string fontAPI_t::RGBtoHex

(

vector

normalizedColor

)

Converts a normalized RGB color vector to a hex color string.

Parameters

normalizedColor

is the normalized input color. E.g. [1.0f, 0.0f, 0.0f]

Returns

is a hex color string. e.g. "^xF00"

StringWidth()

float fontAPI_t::StringWidth	(	string	inputText,
		bool	hasColor,
		font_s	fnt
	)

Returns the width of a series of characters in pixels.

If you have a string with funstring color codes (e.g. ^1 or ^xF00) and want to make sure those are not interpreted as visible characters, set the parameter hasColor to true. Rendering may be more expensive this way, but you should generally cache the result instead of querying it every frame anyway.

The return value is of type float, to be a drop-in replacement for the engine builtin stringwidth().

Parameters

inputText	is the text to get the length of.
hasColor	hints if funstring color codes are present in the string.
fnt	is the font used with the text in question.

---

The documentation for this struct was generated from the following file:

• src/client/api_func.h