TextServerΒΆ
Inherits: RefCounted < Object
Inherited By: TextServerExtension
Interface for the fonts and complex text layouts.
DescriptionΒΆ
TextServer is the API backend for managing fonts, and rendering complex text.
MethodsΒΆ
EnumerationsΒΆ
enum FontAntialiasing:
FONT_ANTIALIASING_NONE = 0 --- Font glyphs are rasterized as 1-bit bitmaps.
FONT_ANTIALIASING_GRAY = 1 --- Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
FONT_ANTIALIASING_LCD = 2 --- Font glyphs are rasterized for LCD screens.
LCD sub-pixel layout is determined by the value of gui/theme/lcd_subpixel_layout project settings.
LCD sub-pixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
enum FontLCDSubpixelLayout:
FONT_LCD_SUBPIXEL_LAYOUT_NONE = 0 --- Unknown or unsupported sub-pixel layout, LCD sub-pixel anti-aliasing is disabled.
FONT_LCD_SUBPIXEL_LAYOUT_HRGB = 1 --- Horizontal RGB sub-pixel layout.
FONT_LCD_SUBPIXEL_LAYOUT_HBGR = 2 --- Horizontal BGR sub-pixel layout.
FONT_LCD_SUBPIXEL_LAYOUT_VRGB = 3 --- Vertical RGB sub-pixel layout.
FONT_LCD_SUBPIXEL_LAYOUT_VBGR = 4 --- Vertical BGR sub-pixel layout.
enum Direction:
DIRECTION_AUTO = 0 --- Text direction is determined based on contents and current locale.
DIRECTION_LTR = 1 --- Text is written from left to right.
DIRECTION_RTL = 2 --- Text is written from right to left.
enum Orientation:
ORIENTATION_HORIZONTAL = 0 --- Text is written horizontally.
ORIENTATION_VERTICAL = 1 --- Left to right text is written vertically from top to bottom.
Right to left text is written vertically from bottom to top.
flags JustificationFlag:
JUSTIFICATION_NONE = 0 --- Do not justify text.
JUSTIFICATION_KASHIDA = 1 --- Justify text by adding and removing kashidas.
JUSTIFICATION_WORD_BOUND = 2 --- Justify text by changing width of the spaces between the words.
JUSTIFICATION_TRIM_EDGE_SPACES = 4 --- Remove trailing and leading spaces from the justified text.
JUSTIFICATION_AFTER_LAST_TAB = 8 --- Only apply justification to the part of the text after the last tab.
JUSTIFICATION_CONSTRAIN_ELLIPSIS = 16 --- Apply justification to the trimmed line with ellipsis.
enum AutowrapMode:
AUTOWRAP_OFF = 0 --- Autowrap is disabled.
AUTOWRAP_ARBITRARY = 1 --- Wraps the text inside the node's bounding rectangle by allowing to break lines at arbitrary positions, which is useful when very limited space is available.
AUTOWRAP_WORD = 2 --- Wraps the text inside the node's bounding rectangle by soft-breaking between words.
AUTOWRAP_WORD_SMART = 3 --- Behaves similarly to AUTOWRAP_WORD, but force-breaks a word if that single word does not fit in one line.
flags LineBreakFlag:
BREAK_NONE = 0 --- Do not break the line.
BREAK_MANDATORY = 1 --- Break the line at the line mandatory break characters (e.g.
"\n").BREAK_WORD_BOUND = 2 --- Break the line between the words.
BREAK_GRAPHEME_BOUND = 4 --- Break the line between any unconnected graphemes.
BREAK_ADAPTIVE = 8 --- Should be used only in conjunction with BREAK_WORD_BOUND, break the line between any unconnected graphemes, if it's impossible to break it between the words.
BREAK_TRIM_EDGE_SPACES = 16 --- Remove edge spaces from the broken line segments.
enum VisibleCharactersBehavior:
VC_CHARS_BEFORE_SHAPING = 0 --- Trims text before the shaping. e.g, increasing Label.visible_characters or RichTextLabel.visible_characters value is visually identical to typing the text.
VC_CHARS_AFTER_SHAPING = 1 --- Displays glyphs that are mapped to the first Label.visible_characters or RichTextLabel.visible_characters characters from the beginning of the text.
VC_GLYPHS_AUTO = 2 --- Displays Label.visible_ratio or RichTextLabel.visible_ratio glyphs, starting from the left or from the right, depending on Control.layout_direction value.
VC_GLYPHS_LTR = 3 --- Displays Label.visible_ratio or RichTextLabel.visible_ratio glyphs, starting from the left.
VC_GLYPHS_RTL = 4 --- Displays Label.visible_ratio or RichTextLabel.visible_ratio glyphs, starting from the right.
enum OverrunBehavior:
OVERRUN_NO_TRIMMING = 0 --- No text trimming is performed.
OVERRUN_TRIM_CHAR = 1 --- Trims the text per character.
OVERRUN_TRIM_WORD = 2 --- Trims the text per word.
OVERRUN_TRIM_ELLIPSIS = 3 --- Trims the text per character and adds an ellipsis to indicate that parts are hidden.
OVERRUN_TRIM_WORD_ELLIPSIS = 4 --- Trims the text per word and adds an ellipsis to indicate that parts are hidden.
flags TextOverrunFlag:
OVERRUN_NO_TRIM = 0 --- No trimming is performed.
OVERRUN_TRIM = 1 --- Trims the text when it exceeds the given width.
OVERRUN_TRIM_WORD_ONLY = 2 --- Trims the text per word instead of per grapheme.
OVERRUN_ADD_ELLIPSIS = 4 --- Determines whether an ellipsis should be added at the end of the text.
OVERRUN_ENFORCE_ELLIPSIS = 8 --- Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
OVERRUN_JUSTIFICATION_AWARE = 16
flags GraphemeFlag:
GRAPHEME_IS_VALID = 1 --- Grapheme is supported by the font, and can be drawn.
GRAPHEME_IS_RTL = 2 --- Grapheme is part of right-to-left or bottom-to-top run.
GRAPHEME_IS_VIRTUAL = 4 --- Grapheme is not part of source text, it was added by justification process.
GRAPHEME_IS_SPACE = 8 --- Grapheme is whitespace.
GRAPHEME_IS_BREAK_HARD = 16 --- Grapheme is mandatory break point (e.g.
"\n").GRAPHEME_IS_BREAK_SOFT = 32 --- Grapheme is optional break point (e.g. space).
GRAPHEME_IS_TAB = 64 --- Grapheme is the tabulation character.
GRAPHEME_IS_ELONGATION = 128 --- Grapheme is kashida.
GRAPHEME_IS_PUNCTUATION = 256 --- Grapheme is punctuation character.
GRAPHEME_IS_UNDERSCORE = 512 --- Grapheme is underscore character.
GRAPHEME_IS_CONNECTED = 1024 --- Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL = 2048 --- It is safe to insert a U+0640 before this grapheme for elongation.
enum Hinting:
HINTING_NONE = 0 --- Disables font hinting (smoother but less crisp).
HINTING_LIGHT = 1 --- Use the light font hinting mode.
HINTING_NORMAL = 2 --- Use the default font hinting mode (crisper but less smooth).
Note: This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
enum SubpixelPositioning:
SUBPIXEL_POSITIONING_DISABLED = 0 --- Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
SUBPIXEL_POSITIONING_AUTO = 1 --- Glyph horizontal position is rounded based on font size.
To one quarter of the pixel size if font size is smaller or equal to SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE.
To one half of the pixel size if font size is smaller or equal to SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE.
To the whole pixel size for larger fonts.
SUBPIXEL_POSITIONING_ONE_HALF = 2 --- Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
SUBPIXEL_POSITIONING_ONE_QUARTER = 3 --- Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE = 20 --- Maximum font size which will use one half of the pixel subpixel positioning in SUBPIXEL_POSITIONING_AUTO mode.
SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE = 16 --- Maximum font size which will use one quarter of the pixel subpixel positioning in SUBPIXEL_POSITIONING_AUTO mode.
enum Feature:
FEATURE_SIMPLE_LAYOUT = 1 --- TextServer supports simple text layouts.
FEATURE_BIDI_LAYOUT = 2</