Struct GameFontStyle

Describes a font based on game resource file.

Inherited Members

System.ValueType.Equals(System.Object)

System.ValueType.GetHashCode()

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Dalamud.Interface.GameFonts

Assembly: Dalamud.dll

Syntax

public struct GameFontStyle

Constructors

GameFontStyle(GameFontFamily, Single)

Initializes a new instance of the GameFontStyle struct.

Declaration

public GameFontStyle(GameFontFamily family, float sizePx)

Parameters

Type	Name	Description
GameFontFamily	family	Font family.
System.Single	sizePx	Size in pixels.

GameFontStyle(GameFontFamilyAndSize)

Initializes a new instance of the GameFontStyle struct.

Declaration

public GameFontStyle(GameFontFamilyAndSize familyAndSize)

Parameters

Type	Name	Description
GameFontFamilyAndSize	familyAndSize	Font family and size.

Fields

FamilyAndSize

Font family of the font.

Declaration

public GameFontFamilyAndSize FamilyAndSize

Field Value

Type	Description
GameFontFamilyAndSize

SizePx

Size of the font in pixels unit.

Declaration

public float SizePx

Field Value

Type	Description
System.Single

SkewStrength

Skewedness of the font.

0 is unaltered. Greater than 1 will make upper part go rightwards. Less than 1 will make lower part go rightwards.

Declaration

public float SkewStrength

Field Value

Type	Description
System.Single

Weight

Weight of the font.

0 is unaltered. Any value greater than 0 will make it bolder.

Declaration

public float Weight

Field Value

Type	Description
System.Single

Properties

BaseSizePt

Gets the base font size in point unit.

Declaration

public readonly float BaseSizePt { get; }

Property Value

Type	Description
System.Single

BaseSizePx

Gets the base font size in pixel unit.

Declaration

public readonly float BaseSizePx { get; }

Property Value

Type	Description
System.Single

BaseSkewStrength

Gets or sets the base skew strength.

Declaration

public float BaseSkewStrength { get; set; }

Property Value

Type	Description
System.Single

Bold

Gets or sets a value indicating whether this font is bold.

Declaration

public bool Bold { get; set; }

Property Value

Type	Description
System.Boolean

Family

Gets the font family.

Declaration

public readonly GameFontFamily Family { get; }

Property Value

Type	Description
GameFontFamily

FamilyWithMinimumSize

Gets the corresponding GameFontFamilyAndSize but with minimum possible font sizes.

Declaration

public readonly GameFontFamilyAndSize FamilyWithMinimumSize { get; }

Property Value

Type	Description
GameFontFamilyAndSize

Italic

Gets or sets a value indicating whether this font is italic.

Declaration

public bool Italic { get; set; }

Property Value

Type	Description
System.Boolean

SizePt

Gets or sets the size of the font in points unit.

Declaration

public float SizePt { get; set; }

Property Value

Type	Description
System.Single

Methods

CalculateBaseWidthAdjustment(FdtReader, FdtReader.FontTableEntry)

Calculates the adjustment to width resulting fron Weight and SkewStrength.

Declaration

public int CalculateBaseWidthAdjustment(FdtReader reader, FdtReader.FontTableEntry glyph)

Parameters

Type	Name	Description
FdtReader	reader	Font information.
FdtReader.FontTableEntry	glyph	Glyph.

Returns

Type	Description
System.Int32	Width adjustment in pixel unit.

GetRecommendedFamilyAndSize(GameFontFamily, Single)

Gets the recommend GameFontFamilyAndSize given family and size.

Declaration

public static GameFontFamilyAndSize GetRecommendedFamilyAndSize(GameFontFamily family, float size)

Parameters

Type	Name	Description
GameFontFamily	family	Font family.
System.Single	size	Font size in points.

Returns

Type	Description
GameFontFamilyAndSize	Recommended GameFontFamilyAndSize.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.ValueType.ToString()