Struct FaceInfo

A structure that contains information about a given typeface and for a specific point size.

Inherited Members
Namespace: UnityEngine.TextCore
Assembly: UnityEngine.dll
Syntax
[Serializable]
public struct FaceInfo

Properties

| Improve this Doc View Source

ascentLine

The Ascent line is typically located at the top of the tallest glyph in the typeface. This represents the distance between the baseline and the tallest ascender. This value is usually positive.

Declaration
public float ascentLine { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

baseline

The Baseline is an imaginary line upon which all glyphs appear to rest on. This value is typically zero.

Declaration
public float baseline { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

capLine

The Cap line is typically located at the top of capital letters. This value represents the distance between the baseline and the top of capital letters.

Declaration
public float capLine { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

descentLine

The Descent line is typically located at the bottom of the glyph with the lowest descender in the typeface. This represents the distance between the baseline and the lowest descender. This value is usually negative.

Declaration
public float descentLine { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

familyName

The name of the font typeface also known as family name.

Declaration
public string familyName { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

lineHeight

The line height represents the distance between consecutive lines of text. This is the distance from baseline to baseline. It is usually computed as line height = ascent - descent + line gap.

Declaration
public float lineHeight { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

meanLine

The Mean line is typically located at the top of lowercase letters. This value represents the distance between the baseline and the top of lowercase letters.

Declaration
public float meanLine { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

pointSize

The point size used for sampling the typeface. This is also referenced as sampling point size.

Declaration
public int pointSize { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

scale

The relative scale of the typeface. Default value is 1.0f.

Declaration
public float scale { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

strikethroughOffset

The position of the strikethrough.

Declaration
public float strikethroughOffset { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

strikethroughThickness

The thickness of the strikethrough.

Declaration
public float strikethroughThickness { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

styleName

The style name of the typeface which defines both the visual style and weight of the typeface.

Declaration
public string styleName { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

subscriptOffset

The position of characters using subscript.

Declaration
public float subscriptOffset { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

subscriptSize

The relative size / scale of subscript characters.

Declaration
public float subscriptSize { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

superscriptOffset

The position of characters using superscript.

Declaration
public float superscriptOffset { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

superscriptSize

The relative size / scale of superscript characters.

Declaration
public float superscriptSize { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

tabWidth

The width of the tab character. This width is typically the same as the space character.

Declaration
public float tabWidth { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

underlineOffset

The position of the underline.

Declaration
public float underlineOffset { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

underlineThickness

The thickness of the underline.

Declaration
public float underlineThickness { get; set; }
Property Value
Type Description
Single

Methods

| Improve this Doc View Source

Compare(FaceInfo)

Compares the information in this FaceInfo structure with the information in the given FaceInfo structure to determine whether they have the same values.

Declaration
public bool Compare(FaceInfo other)
Parameters
Type Name Description
FaceInfo other

The FaceInfo structure to compare this FaceInfo structure with.
Returns
Type Description
Boolean

Returns true if the FaceInfo structures have the same values. False if not.

Extension Methods