Class GorgonFontInfo

Provides information used to create a new GorgonFont.

Inheritance
object
GorgonFontInfo
Implements
Inherited Members
Namespace: Gorgon.Graphics.Fonts
Assembly: Gorgon.Graphics.Fonts.dll
Syntax
public class GorgonFontInfo : IGorgonFontInfo, IGorgonNamedObject

Constructors

| Edit this page View Source

GorgonFontInfo(IGorgonFontInfo)

Initializes a new instance of the GorgonFontInfo class.

Declaration
public GorgonFontInfo(IGorgonFontInfo fontInfo)
Parameters
Type Name Description
IGorgonFontInfo fontInfo

The font information to copy.
Exceptions
Type Condition
ArgumentNullException

Thrown when the fontInfo parameter is null.
| Edit this page View Source

GorgonFontInfo(string, float, FontHeightMode)

Initializes a new instance of the GorgonFontInfo class.

Declaration
public GorgonFontInfo(string fontFamily, float size, FontHeightMode heightMode)
Parameters
Type Name Description
string fontFamily

The name of the font family to derive the font from.
float size

The height of the font.
FontHeightMode heightMode

[Optional] The type of units to express the font height in.

Properties

| Edit this page View Source

AntiAliasingMode

Property to return the anti-aliasing mode for the font.

Declaration
public FontAntiAliasMode AntiAliasingMode { get; set; }
Property Value
Type Description
FontAntiAliasMode
| Edit this page View Source

Brush

Property to return a GorgonGlyphBrush to use for special effects on the glyphs for the font.

Declaration
public GorgonGlyphBrush Brush { get; set; }
Property Value
Type Description
GorgonGlyphBrush
| Edit this page View Source

Characters

Property to return the list of available characters to use as glyphs within the font.

Declaration
public IEnumerable<char> Characters { get; set; }
Property Value
Type Description
IEnumerable<char>
| Edit this page View Source

Compression

Property to return the type of compression to apply to the font textures.

Declaration
public FontTextureCompression Compression { get; set; }
Property Value
Type Description
FontTextureCompression
| Edit this page View Source

DefaultCharacter

Property to return a default character to use in place of a character that cannot be found in the font.

Declaration
public char DefaultCharacter { get; set; }
Property Value
Type Description
char
| Edit this page View Source

FontFamilyName

Property to return the font family name to generate the font from.

Declaration
public string FontFamilyName { get; set; }
Property Value
Type Description
string
| Edit this page View Source

FontHeightMode

Property to return whether the font height is in pixels or in points.

Declaration
public FontHeightMode FontHeightMode { get; set; }
Property Value
Type Description
FontHeightMode
| Edit this page View Source

FontStyle

Property to return the style for the font.

Declaration
public FontStyle FontStyle { get; set; }
Property Value
Type Description
FontStyle
| Edit this page View Source

Name

Property to return the name of the font object.

Declaration
public string Name { get; set; }
Property Value
Type Description
string
| Edit this page View Source

OutlineColor1

Property to return the starting color of the outline.

Declaration
public GorgonColor OutlineColor1 { get; set; }
Property Value
Type Description
GorgonColor
| Edit this page View Source

OutlineColor2

Property to return the ending color of the outline.

Declaration
public GorgonColor OutlineColor2 { get; set; }
Property Value
Type Description
GorgonColor
| Edit this page View Source

OutlineSize

Property to return the size of an outline.

Declaration
public int OutlineSize { get; set; }
Property Value
Type Description
int
| Edit this page View Source

PackingSpacing

Property to return the spacing (in pixels) used between font glyphs on the backing texture.

Declaration
public int PackingSpacing { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Size

Property to return the font size.

Declaration
public float Size { get; set; }
Property Value
Type Description
float
| Edit this page View Source

TextureHeight

Property to return the height of the texture(s) used as the backing store for the bitmap font data.

Declaration
public int TextureHeight { get; set; }
Property Value
Type Description
int
| Edit this page View Source

TextureWidth

Property to return the width of the texture(s) used as the backing store for the bitmap font data.

Declaration
public int TextureWidth { get; set; }
Property Value
Type Description
int
| Edit this page View Source

UseKerningPairs

Property to return whether to include kerning pair information in the font.

Declaration
public bool UseKerningPairs { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

UsePremultipliedTextures

Property to return whether premultiplied textures are used when generating the glyphs for the font.

Declaration
public bool UsePremultipliedTextures { get; set; }
Property Value
Type Description
bool

Implements

Extension Methods