TextServer¶
Inherits: Object
Interface for the fonts and complex text layouts.
Description¶
TextServer is the API backend for managing fonts, and rendering complex text.
Methods¶
Enumerations¶
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.
enum JustificationFlag:
JUSTIFICATION_NONE = 0 --- Do not justify text.
JUSTIFICATION_KASHIDA = 16 --- Justify text by adding and removing kashidas.
JUSTIFICATION_WORD_BOUND = 32 --- Justify text by changing width of the spaces between the words.
JUSTIFICATION_TRIM_EDGE_SPACES = 64 --- Remove trailing and leading spaces from the justified text.
JUSTIFICATION_AFTER_LAST_TAB = 128 --- Only apply justification to the part of the text after the last tab.
enum 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.
enum GraphemeFlag:
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.
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).
enum Feature:
FEATURE_BIDI_LAYOUT = 1 --- TextServer supports bidirectional layouts.
FEATURE_VERTICAL_LAYOUT = 2 --- TextServer supports vertical layouts.
FEATURE_SHAPING = 4 --- TextServer supports complex text shaping.
FEATURE_KASHIDA_JUSTIFICATION = 8 --- TextServer supports justification using kashidas.
FEATURE_BREAK_ITERATORS = 16 --- TextServer supports complex line/word breaking rules (e.g. dictionary based).
FEATURE_FONT_SYSTEM = 32 --- TextServer supports loading system fonts.
FEATURE_FONT_VARIABLE = 64
FEATURE_USE_SUPPORT_DATA = 128
Method Descriptions¶
RID create_font_memory ( PackedByteArray data, String type, int base_size=16 )
Creates new font from the data in memory. To free the resulting font, use free_rid method.
Note: For non-scalable fonts base_size is ignored, use font_get_base_size to check actual font size.
Creates new font from the file. To free the resulting font, use free_rid method.
Note: For non-scalable fonts base_size is ignored, use font_get_base_size to check actual font size.
Creates new font from the system font. To free the resulting font, use free_rid method.
Note: This method is supported by servers with the FEATURE_FONT_SYSTEM feature.
Note: For non-scalable fonts base_size is ignored, use font_get_base_size to check actual font size.
RID create_shaped_text ( Direction direction=0, Orientation orientation=0 )
Creates new buffer for complex text layout, with the given direction and orientation. To free the resulting buffer, use free_rid method.
Note: Direction is ignored if server does not support FEATURE_BIDI_LAYOUT feature.
Note: Orientation is ignored if server does not support FEATURE_VERTICAL_LAYOUT feature.
Draws box displaying character hexadecimal code. Used for replacing missing characters.
Vector2 font_draw_glyph ( RID font, RID canvas, int size, Vector2 pos, int index, Color color=Color( 1, 1, 1, 1 ) ) const
Draws single glyph into a canvas item at the position, using font at the size size.
Note: Glyph index is specific to the font, use glyphs indices returned by shaped_text_get_glyphs or font_get_glyph_index.
Vector2 font_draw_glyph_outline ( RID font, RID canvas, int size, int outline_size, Vector2 pos, int index, Color color=Color( 1, 1, 1, 1 ) ) const
Draws single glyph outline of size outline_size into a canvas item at the position, using font at the size size.
Note: Glyph index is specific to the font, use glyphs indices returned by shaped_text_get_glyphs or font_get_glyph_index.
Returns true, if font anti-aliasing is supported and enabled.
Returns the font ascent (number of pixels above the baseline).
Returns the default size of the font.
Returns the font descent (number of pixels below the baseline).
Returns true, if distance field hint is enabled.
Returns true, if autohinter is supported and enabled.
Returns advance of the glyph.
Returns the glyph index of a char, optionally modified by the variation_selector.
Returns a kerning of the pair of glyphs.
Returns the total font height (ascent plus descent) in pixels.
Returns the font hinting.
Returns true if support override is enabled for the language.
PackedStringArray font_get_language_support_overrides ( RID font )
Returns list of language support overrides.
float font_get_oversampling ( ) const
Returns the font oversampling factor, shared by all fonts in the TextServer.
Returns true if support override is enabled for the script.
PackedStringArray font_get_script_support_overrides ( RID font )
Returns list of script support overrides.
Returns a string containing all the characters available in the font.
Returns underline offset (number of pixels below the baseline).
Returns underline thickness in pixels.
Returns ";" separated list of supported variation coordinates, each coordinate is returned in the following format: "tag,min_value,max_value,default_value".
Returns variation coordinates. Returned string is identical to the string set by font_set_variations, to get default values use font_get_variation_list instead.
Returns true if char is available in the font.
Returns true, if font supports glyph outlines.
Returns true, if font supports given language (ISO 639 code).
Returns true, if font supports given script (ISO 15924 code).
Remove language support override.
Removes script support override.
Sets font anti-aliasing.
Sets font distance field hint.
Sets font hinting.
Adds override for font_is_language_supported.
void font_set_oversampling ( float oversampling )
Sets oversampling factor, shared by all font in the TextServer.
Adds override for font_is_script_supported.
Sets variation coordinates, value is a comma separated list of the in the "tag=value" format. Tags are case-sensitive. Unsupported or incorrectly formatted coordinates will be silently ignored.
Convert a number from the Western Arabic (0..9) to the numeral systems used in language.
void free_rid ( RID rid )
Frees an object created by this TextServer.
String get_name ( ) const
Returns the name of the server interface.
PackedStringArray get_system_fonts ( ) const
Returns list of available system fonts.
Note: This method is supported by servers with the FEATURE_FONT_SYSTEM feature.
Returns true if rid is valid resource owned by this text server.
Returns true if the server supports a feature.
Returns true if locale is right-to-left.
Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
Note: This function should be called before any other TextServer functions used, otherwise it won't have any effect.
Convert a number from the numeral systems used in language to Western Arabic (0..9).
Returns percent sign used in the language.
Adds inline object to the text buffer, key must be unique.
bool shaped_text_add_string ( RID shaped, String text, Array fonts, int size, String opentype_features="", String language="" )
Adds text span and font to draw it to the text buffer.
void shaped_text_clear ( RID arg0 )
Clears text buffer (removes text and inline objects).
void shaped_text_draw ( RID shaped, RID canvas, Vector2 pos, float clip_w=-1, Color color=Color( 1, 1, 1, 1 ) ) const
Draw shaped text into a canvas item at a given position, with color. pos specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
void shaped_text_draw_outline ( RID shaped, RID canvas, Vector2 pos, float clip_w=-1, int outline_size=1, Color color=Color( 1, 1, 1, 1 ) ) const
Draw the outline of the shaped text into a canvas item at a given position, with color. pos specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
Adjusts text with to fit to specified width, returns new text width.
Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
Note: overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
Dictionary shaped_text_get_carets ( RID shaped, int position ) const
Returns shapes of the carets corresponding to the character offset position in the text. Returned caret shape is 1 pixel wide rectangle.
Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
Note: overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
Returns direction of the text.
Returns dominant direction of in the range of text.
Returns text glyphs.
Breaks text to the lines and returns character ranges for each line.
Array shaped_text_get_line_breaks_adv ( RID shaped, PackedFloat32Array width, int start=0, bool once=true, int break_flags=3 ) const
Breaks text to the lines and columns. Returns character ranges for each segment.
Returns bounding rectangle of the inline object.
Returns array of inline objects.
Orientation shaped_text_get_orientation ( RID shaped ) const
Returns text orientation.
Sets text orientation.
Returns true if text buffer is configured to display control characters.
Returns true if text buffer is configured to display hexadecimal codes in place of invalid characters.
Note: If set to false, nothing is displayed in place of invalid characters.
Returns substring buffer character range in the parent buffer.
Returns selection rectangles for the specified character range.
Returns size of the text.
Returns pixel offset of the underline below the baseline.
Returns thickness of the underline.
Returns width (for horizontal layout) or height (for vertical) of the text.
Breaks text into words and returns array of character ranges.
Returns grapheme index at the specified pixel offset at the baseline, or -1 if none is found.
Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
Returns true if buffer is successfully shaped.
Returns composite character end position closest to the pos.
Returns composite character start position closest to the pos.
Overrides BiDi for the structured text.
Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
Sets desired text direction. If set to TEXT_DIRECTION_AUTO, direction will be detected based on the buffer contents and current locale.
Note: Direction is ignored if server does not support FEATURE_BIDI_LAYOUT feature.
void shaped_text_set_orientation ( RID shaped, Orientation orientation=0 )
Sets desired text orientation.
Note: Orientation is ignored if server does not support FEATURE_VERTICAL_LAYOUT feature.
If set to true text buffer will display control characters.
If set to true text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
Shapes buffer if it's not shaped. Returns true if the string is shaped successfully.
Note: It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested.
Returns text buffer for the substring of the text in the shaped text buffer (including inline objects).
float shaped_text_tab_align ( RID shaped, PackedFloat32Array tab_stops )
Aligns shaped text to the given tab-stops.