UnityEngine.TextCoreFontEngineModule

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

The Ascent line is typically located at the top of the tallest glyph in the typeface.

The Baseline is an imaginary line upon which all glyphs appear to rest on.

The Cap line is typically located at the top of capital letters.

The Descent line is typically located at the bottom of the glyph with the lowest descender in the typeface.

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

The line height represents the distance between consecutive lines of text.

The Mean line is typically located at the top of lowercase letters.

The point size used for sampling the typeface.

The relative scale of the typeface.

The position of the strikethrough.

The thickness of the strikethrough.

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

The position of characters using subscript.

The relative size / scale of subscript characters.

The position of characters using superscript.

The relative size / scale of superscript characters.

The width of the tab character.

The position of the underline.

The thickness of the underline.

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

The FaceInfo structure to compare this FaceInfo structure with. Returns true if the FaceInfo structures have the same values. False if not.

A Glyph is the visual representation of a text element or character.

The index of the atlas texture that contains this glyph.

Glyph class definition type.

A rectangle that defines the position of a glyph within an atlas texture.

The index of the glyph in the source font file.

The metrics that define the size, position and spacing of a glyph when performing text layout.

The relative scale of the glyph. The default value is 1.0.

Compares two glyphs to determine if they have the same values.

The glyph to compare with. Returns true if the glyphs have the same values. False if not.

Constructor for a new glyph.

Glyph used as a reference for the new glyph. The index of the glyph in the font file. The metrics of the glyph. The GlyphRect defining the position of the glyph in the atlas texture. The relative scale of the glyph. The index of the atlas texture that contains the glyph.

Constructor for a new glyph.

Options to specify the glyph class definition type.

Defines the glyph as a Base glyph.

Defines the glyph as a Component glyph.

Defines the glyph as a Ligature.

Defines the glyph as a Mark glyph.

Defines the glyph as Undefined.

A set of values that define the size, position and spacing of a glyph when performing text layout.

The height of the glyph.

The horizontal distance to increase (left to right) or decrease (right to left) the drawing position relative to the origin of the text element.

The horizontal distance from the current drawing position (origin) relative to the element's left bounding box edge (bbox).

The vertical distance from the current baseline relative to the element's top bounding box edge (bbox).

The width of the glyph.

Constructs a new GlyphMetrics structure.

The width of the glyph. The height of the glyph. The horizontal bearingX. The horizontal bearingY. The horizontal advance.

A rectangle that defines the position of a glyph within an atlas texture.

The height of the glyph.

The width of the glyph.

The x position of the glyph in the font atlas texture.

The y position of the glyph in the font atlas texture.

A GlyphRect with all values set to zero. Shorthand for writing GlyphRect(0, 0, 0, 0).

Constructor for a new GlyphRect.

The x position of the glyph in the atlas texture. The y position of the glyph in the atlas texture. The width of the glyph. The height of the glyph. The Rect used to construct the new GlyphRect.

Constructor for a new GlyphRect.

The x position of the glyph in the atlas texture. The y position of the glyph in the atlas texture. The width of the glyph. The height of the glyph. The Rect used to construct the new GlyphRect.

The FontEngine is used to access data from source font files. This includes information about individual characters, glyphs and relevant metrics typically used in the process of text parsing, layout and rendering. The types of font files supported are TrueType (.ttf, .ttc) and OpenType (.otf). The FontEngine is also used to raster the visual representation of characters known as glyphs in a given font atlas texture.

Destroy and unload resources used by the Font Engine.

A value of zero (0) if the Font Engine and used resources were successfully released.

Get the FaceInfo for the currently loaded and sized typeface.

Returns the FaceInfo of the currently loaded typeface.

Gets the font faces and styles for the currently loaded font.

An array that contains the names of the font faces and styles.

Gets the family and style names of the system fonts.

String array that contains the family and style names of the system fonts.

Initialize the Font Engine and required resources.

A value of zero (0) if the initialization of the Font Engine was successful.

Load a source font file.

The path of the source font file relative to the project. The point size used to scale the font face. The byte array that contains the source font file. The font to load the data from. The Unity font must be set to Dynamic mode with Include Font Data selected. The face index of the font face to load. When the font file is a TrueType collection (.TTC), this specifies the face index of the font face to load. If the font file is a TrueType Font (.TTF) or OpenType Font (.OTF) file, the face index is always zero (0). The family name of the font face to load. The style name of the font face to load. A value of zero (0) if the font face was loaded successfully.

Load a source font file.

Set the size of the currently loaded font face.

The point size used to scale the font face. A value of zero (0) if the font face was successfully scaled to the given point size.

Try to get the glyph index for the character at the given Unicode value.

The unicode value of the character for which to lookup the glyph index. The index of the glyph for the given unicode character or the .notdef glyph (index 0) if no glyph is available for the given Unicode value. Returns true if the given unicode has a glyph index.

Try loading the glyph for the given index value and if available populate the glyph.

The index of the glyph that should be loaded. The glyph loading flag that should be used to load the glyph. The glyph using the provided index or the .notdef glyph (index 0) if no glyph was found at that index. Returns true if a glyph exists at the given index. Otherwise returns false.

Try loading a glyph for the given unicode value. If available, populates the glyph and returns true. Otherwise returns false and populates the glyph with the .notdef / missing glyph data.

The glyph loading flag that should be used to load the glyph. The glyph using the provided index or the .notdef glyph (index 0) if no glyph was found at that index. The Unicode value of the character whose glyph should be loaded. Returns true if a glyph exists for the given unicode value. Otherwise returns false.

Unloads all currently loaded font faces and removes them from the cache.

A value of zero (0) if the font faces were successfully unloaded and removed from the cache.

Unloads current font face and removes it from the cache.

A value of zero (0) if the font face was successfully unloaded and removed from the cache.

Error code returned by the various FontEngine functions.

Error code returned when the FontEngine glyph packing or rendering process has been cancelled.

Error code returned by the LoadGlyph function when referencing an invalid Unicode character value.

Error code indicating an invalid font face.

Error code indicating an invalid font file.

Error code returned by the LoadFontFace function when the source font file is of an unknown or invalid format.

Error code returned by the LoadFontFace function when the file path to the source font file appears invalid.

Error code returned by the LoadFontFace function when the source font file appears invalid or improperly formatted.

Error code returned by the LoadGlyph function when referencing an invalid or out of range glyph index value.

Error code indicating failure to initialize the font engine library.

Error code indicating failure to initialize the font engine library and / or successfully load a font face.

Error code returned by the LoadGlyph or SetFaceSize functions using an invalid pointSize value.

Error code indicating failure to load one of the tables of the font file.

OpenType Layout related errors.

Error code returned when the function was successfully executed.

The positional adjustment values of a glyph.

The index of the glyph in the source font file.

The GlyphValueRecord contains the positional adjustments of the glyph.

Constructor for new glyph adjustment record.

The index of the glyph in the source font file. The GlyphValueRecord contains the positional adjustments of the glyph.

The various options (flags) used by the FontEngine when loading glyphs from a font face.

Load glyph metrics without allocating and loading the bitmap data.

Load glyph metrics and render using color bitmaps.

Load glyph metrics without using the 'hdmx' table. This flag is mostly used to validate font data.

Load glyph metrics and bitmap representation if available for the current face size.

Load glyphs using the auto hinter instead of the font's native hinter.

Load glyph metrics and render outline using 1-bit monochrome.

Load glyphs using the font's native hinter.

Load glyphs and ignore embedded bitmap strikes.

Load glyphs without hinting.

Load glyphs at default font units without scaling. This flag implies LOAD_NO_HINTING and LOAD_NO_BITMAP and unsets LOAD_RENDER.

Load glyph metrics and render outline using 8-bit or antialiased image of the glyph.

The modes available when packing glyphs into an atlas texture.

Place the glyph into the smallest free space available in which it can fit.

Place the glyph against the longer side of a free space to minimize the length of the longer leftover side.

Place the glyph against the short side of a free space to minimize the length of the shorter leftover side.

Place the glyph into available free space in a Tetris like fashion.

Place the glyph into the available free space by trying to maximize the contact point between it and other glyphs.

The positional adjustment values of a pair of glyphs.

The positional adjustment values for the first glyph.

The positional adjustment values for the second glyph.

Constructor for new glyph pair adjustment record.

The positional adjustment values for the first glyph. The positional adjustment values for the second glyph.

The rendering modes used by the Font Engine to render glyphs.

Renders a color bitmap image representation of the glyph no hinting.

Renders a color bitmap image representation of the glyph with hinting.

Renders a bitmap representation of the glyph from a binary (1-bit monochrome) image of the glyph outline with no hinting.

Renders a bitmap representation of the glyph from a binary (1-bit monochrome) image of the glyph outline with hinting.

Renders a signed distance field (SDF) representation of the glyph from a binary (1-bit monochrome) image of the glyph outline with no hinting.

Renders a signed distance field (SDF) representation of the glyph from an 8-bit or antialiased image of the glyph outline with no hinting.

Renders a signed distance field (SDF) representation of the glyph from an 8-bit or antialiased image of the glyph outline with hinting.

Renders a bitmap representation of the glyph from an 8-bit or antialiased image of the glyph outline with no hinting.

Renders a bitmap representation of the glyph from an 8-bit or antialiased image of the glyph outline with hinting.

The values used to adjust the position of a glyph or set of glyphs.

The positional adjustment that affects the horizontal advance of the glyph.

The positional adjustment that affects the horizontal bearing X of the glyph.

The positional adjustment that affects the vertical advance of the glyph.

The positional adjustment that affectsthe horizontal bearing Y of the glyph.

Constructor for new glyph value record.

The positional adjustment that affects the horizontal bearing X of the glyph. The positional adjustment that affects the horizontal bearing Y of the glyph. The positional adjustment that affects the horizontal advance of the glyph. The positional adjustment that affects the vertical advance of the glyph.