Version: 2022.3
LanguageEnglish
  • C#

FaceInfo

struct in UnityEngine.TextCore

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

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

Properties

ascentLineThe Ascent line is typically located at the top of the tallest glyph in the typeface.
baselineThe Baseline is an imaginary line upon which all glyphs appear to rest on.
capLineThe Cap line is typically located at the top of capital letters.
descentLineThe Descent line is typically located at the bottom of the glyph with the lowest descender in the typeface.
familyNameThe name of the font typeface also known as family name.
lineHeightThe line height represents the distance between consecutive lines of text.
meanLineThe Mean line is typically located at the top of lowercase letters.
pointSizeThe point size used for sampling the typeface.
scaleThe relative scale of the typeface.
strikethroughOffsetThe position of the strikethrough.
strikethroughThicknessThe thickness of the strikethrough.
styleNameThe style name of the typeface which defines both the visual style and weight of the typeface.
subscriptOffsetThe position of characters using subscript.
subscriptSizeThe relative size / scale of subscript characters.
superscriptOffsetThe position of characters using superscript.
superscriptSizeThe relative size / scale of superscript characters.
tabWidthThe width of the tab character.
underlineOffsetThe position of the underline.
underlineThicknessThe thickness of the underline.

Public Methods

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