AgateLib.BitmapFont.FontMetrics Class Reference

FontMetrics is a class which describes everything needed to render a font from a bitmap image. More...

List of all members.

Public Member Functions
	FontMetrics ()
	Constructs an empty font metrics object.
FontMetrics	Clone ()
	Performs a deep copy.
void	Add (char key, GlyphMetrics value)
bool	ContainsKey (char key)
bool	Remove (char key)
bool	TryGetValue (char key, out GlyphMetrics value)
void	Clear ()
	Clears the list.
IEnumerator< KeyValuePair < char, GlyphMetrics > >	GetEnumerator ()
	Creates an enumerator.
Properties
ICollection< char >	Keys [get]
ICollection< GlyphMetrics >	Values [get]
	Returns a collection of the value.
GlyphMetrics	this [char key] [get, set]
	Returns a specified glyph metrics.
int	Count [get]
	Returns the number of glyphs.

---

Detailed Description

FontMetrics is a class which describes everything needed to render a font from a bitmap image.

---

Constructor & Destructor Documentation

AgateLib.BitmapFont.FontMetrics.FontMetrics

(

)

Constructs an empty font metrics object.

---

Member Function Documentation

void AgateLib.BitmapFont.FontMetrics.Add	(	char	key,
		GlyphMetrics	value
	)

Parameters:

	key
	value

void AgateLib.BitmapFont.FontMetrics.Clear

(

)

Clears the list.

FontMetrics AgateLib.BitmapFont.FontMetrics.Clone

(

)

Performs a deep copy.

Returns:

bool AgateLib.BitmapFont.FontMetrics.ContainsKey

(

char

key

)

Parameters:

key

Returns:

IEnumerator<KeyValuePair<char, GlyphMetrics> > AgateLib.BitmapFont.FontMetrics.GetEnumerator

(

)

Creates an enumerator.

Returns:

bool AgateLib.BitmapFont.FontMetrics.Remove

(

char

key

)

Parameters:

key

Returns:

bool AgateLib.BitmapFont.FontMetrics.TryGetValue	(	char	key,
		out GlyphMetrics	value
	)

Parameters:

	key
	value

Returns:

---

Property Documentation

int AgateLib.BitmapFont.FontMetrics.Count [get]

Returns the number of glyphs.

ICollection<char> AgateLib.BitmapFont.FontMetrics.Keys [get]

GlyphMetrics AgateLib.BitmapFont.FontMetrics.this[char key] [get, set]

Returns a specified glyph metrics.

Parameters:

key

Returns:

ICollection<GlyphMetrics> AgateLib.BitmapFont.FontMetrics.Values [get]

Returns a collection of the value.

---

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

• BitmapFont/FontMetrics.cs