AgateLib.BitmapFont.GlyphMetrics Class Reference

GlyphMetrics defines the metrics for a particular glyph in a font, including the rectangle of the glyph on the source image, overhang, and kerning pairs. More...

List of all members.

Public Member Functions
	GlyphMetrics ()
	Constructs a GlyphMetrics object.
	GlyphMetrics (Rectangle srcRect)
	Constructs a GlyphMetrics object with the specified source rectangle.
GlyphMetrics	Clone ()
	Performs a deep copy.
Properties
Rectangle	SourceRect [get, set]
	Source rectangle on the image which supplies the glyph.
int	Width [get, set]
	Gets or sets the width of the glyph.
int	Height [get, set]
	Gets or sets the height of the glyph.
Size	Size [get, set]
	Gets or sets the size of the glyph.
int	LeftOverhang [get, set]
	Number of pixels this character is shifted to the left.
int	RightOverhang [get, set]
	Number of pixels the next character should be shifted to the left.
Dictionary< char, int >	KerningPairs [get]
	A dictionary of characters which need kerning when paired with this glyph.

---

Detailed Description

GlyphMetrics defines the metrics for a particular glyph in a font, including the rectangle of the glyph on the source image, overhang, and kerning pairs.

---

Constructor & Destructor Documentation

AgateLib.BitmapFont.GlyphMetrics.GlyphMetrics

(

)

Constructs a GlyphMetrics object.

AgateLib.BitmapFont.GlyphMetrics.GlyphMetrics

(

Rectangle

srcRect

)

Constructs a GlyphMetrics object with the specified source rectangle.

Parameters:

srcRect

---

Member Function Documentation

GlyphMetrics AgateLib.BitmapFont.GlyphMetrics.Clone

(

)

Performs a deep copy.

Returns:

---

Property Documentation

int AgateLib.BitmapFont.GlyphMetrics.Height [get, set]

Gets or sets the height of the glyph.

Dictionary<char, int> AgateLib.BitmapFont.GlyphMetrics.KerningPairs [get]

A dictionary of characters which need kerning when paired with this glyph.

int AgateLib.BitmapFont.GlyphMetrics.LeftOverhang [get, set]

Number of pixels this character is shifted to the left.

int AgateLib.BitmapFont.GlyphMetrics.RightOverhang [get, set]

Number of pixels the next character should be shifted to the left.

Size AgateLib.BitmapFont.GlyphMetrics.Size [get, set]

Gets or sets the size of the glyph.

Rectangle AgateLib.BitmapFont.GlyphMetrics.SourceRect [get, set]

Source rectangle on the image which supplies the glyph.

int AgateLib.BitmapFont.GlyphMetrics.Width [get, set]

Gets or sets the width of the glyph.

---

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

• BitmapFont/GlyphMetrics.cs