AgateLib.BitmapFont.BitmapFontOptions Class Reference

Class which indicates how a bitmap font should be generated from an operating system font. More...

List of all members.

Classes
class	CharacterRange
	Class which represents a range of characters. More...
Public Member Functions
	BitmapFontOptions ()
	Constructs a BitmapFontOptions object using a 10-point sans serif font.
	BitmapFontOptions (string fontFamily, float sizeInPoints)
	Constructs a BitmapFontOptions object.
	BitmapFontOptions (string fontFamily, float sizeInPoints, FontStyle style)
	Constructs a BitmapFontOptions object.
void	AddRange (char start, char end)
	Adds a range of characters to be rendered.
Properties
IEnumerable< CharacterRange >	CharacterRanges [get]
	Enumerates the character ranges to be rendered.
int	TotalChars [get]
	Gets the total number of characters to be rendered to the bitmap.
BitmapFontEdgeOptions	EdgeOptions [get, set]
	Indicates how to treat font edges.
bool	UseTextRenderer [get, set]
	Indicates whether to use System.Windows.Forms.TextRenderer instead of System.Drawing.Graphics. TextRenderer on Windows will likely produce nicer-looking characters than Graphics, but it is much slower rendering the characters.
FontStyle	FontStyle [get, set]
	Style of the font to be generated.
float	SizeInPoints [get, set]
	Size of the font in points.
string	FontFamily [get, set]
	Name of the font family.
Color	BorderColor [get, set]
	Color of the border on the glyphs. Colors other than black may show up correctly when drawing colored text.
bool	CreateBorder [get, set]
	Indicates whether to create a border around the glyphs.

---

Detailed Description

Class which indicates how a bitmap font should be generated from an operating system font.

---

Constructor & Destructor Documentation

AgateLib.BitmapFont.BitmapFontOptions.BitmapFontOptions

(

)

Constructs a BitmapFontOptions object using a 10-point sans serif font.

AgateLib.BitmapFont.BitmapFontOptions.BitmapFontOptions	(	string	fontFamily,
		float	sizeInPoints
	)

Constructs a BitmapFontOptions object.

Parameters:

	fontFamily
	sizeInPoints

AgateLib.BitmapFont.BitmapFontOptions.BitmapFontOptions	(	string	fontFamily,
		float	sizeInPoints,
		FontStyle	style
	)

Constructs a BitmapFontOptions object.

Parameters:

	fontFamily
	sizeInPoints
	style

---

Member Function Documentation

void AgateLib.BitmapFont.BitmapFontOptions.AddRange	(	char	start,
		char	end
	)

Adds a range of characters to be rendered.

Parameters:

	start
	end

---

Property Documentation

Color AgateLib.BitmapFont.BitmapFontOptions.BorderColor [get, set]

Color of the border on the glyphs. Colors other than black may show up correctly when drawing colored text.

IEnumerable<CharacterRange> AgateLib.BitmapFont.BitmapFontOptions.CharacterRanges [get]

Enumerates the character ranges to be rendered.

bool AgateLib.BitmapFont.BitmapFontOptions.CreateBorder [get, set]

Indicates whether to create a border around the glyphs.

BitmapFontEdgeOptions AgateLib.BitmapFont.BitmapFontOptions.EdgeOptions [get, set]

Indicates how to treat font edges.

string AgateLib.BitmapFont.BitmapFontOptions.FontFamily [get, set]

Name of the font family.

FontStyle AgateLib.BitmapFont.BitmapFontOptions.FontStyle [get, set]

Style of the font to be generated.

float AgateLib.BitmapFont.BitmapFontOptions.SizeInPoints [get, set]

Size of the font in points.

int AgateLib.BitmapFont.BitmapFontOptions.TotalChars [get]

Gets the total number of characters to be rendered to the bitmap.

bool AgateLib.BitmapFont.BitmapFontOptions.UseTextRenderer [get, set]

Indicates whether to use System.Windows.Forms.TextRenderer instead of System.Drawing.Graphics. TextRenderer on Windows will likely produce nicer-looking characters than Graphics, but it is much slower rendering the characters.

---

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

• BitmapFont/BitmapFontOptions.cs