Class reference

TextServer

Inherits RefCounted

A server interface for font management and text rendering.

Description

TextServer is the API backend for managing fonts and rendering text. Note: This is a low-level API, consider using TextLine, TextParagraph, and Font classes instead. This is an abstract class, so to get the currently active TextServer instance, use the following code:

		var ts = TextServerManager.get_primary_interface()

		var ts = TextServerManager.GetPrimaryInterface();

Methods

`RID create_font()`

Creates a new, empty font cache entry resource. To free the resulting resource, use the free_rid() method.

`RID create_font_linked_variation(RID font_rid)`

Creates a new variation existing font which is reusing the same glyph cache and font data. To free the resulting resource, use the free_rid() method.

`RID create_shaped_text(int direction = 0, int orientation = 0)`

Creates a 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 (supported by TextServerAdvanced). Note: Orientation is ignored if server does not support FEATURE_VERTICAL_LAYOUT feature (supported by TextServerAdvanced).

`void draw_hex_code_box(RID canvas, int size, Vector2 pos, int index, Color color) const`

Draws box displaying character hexadecimal code. Used for replacing missing characters.

`void font_clear_glyphs(RID font_rid, Vector2i size)`

Removes all rendered glyph information from the cache entry. Note: This function will not remove textures associated with the glyphs, use font_remove_texture() to remove them manually.

`void font_clear_kerning_map(RID font_rid, int size)`

Removes all kerning overrides.

`void font_clear_size_cache(RID font_rid)`

Removes all font sizes from the cache entry.

`void font_clear_system_fallback_cache()`

Frees all automatically loaded system fonts.

`void font_clear_textures(RID font_rid, Vector2i size)`

Removes all textures from font cache entry. Note: This function will not remove glyphs associated with the texture, use font_remove_glyph() to remove them manually.

`void font_draw_glyph(RID font_rid, RID canvas, int size, Vector2 pos, int index, Color color = Color(1, 1, 1, 1), float oversampling = 0.0) const`

Draws single glyph into a canvas item at the position, using font_rid at the size size. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. Note: Glyph index is specific to the font, use glyphs indices returned by shaped_text_get_glyphs() or font_get_glyph_index(). Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

`void font_draw_glyph_outline(RID font_rid, RID canvas, int size, int outline_size, Vector2 pos, int index, Color color = Color(1, 1, 1, 1), float oversampling = 0.0) const`

Draws single glyph outline of size outline_size into a canvas item at the position, using font_rid at the size size. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. Note: Glyph index is specific to the font, use glyphs indices returned by shaped_text_get_glyphs() or font_get_glyph_index(). Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

`int font_get_antialiasing(RID font_rid) const`

Returns font anti-aliasing mode.

`float font_get_ascent(RID font_rid, int size) const`

Returns the font ascent (number of pixels above the baseline).

`float font_get_baseline_offset(RID font_rid) const`

Returns extra baseline offset (as a fraction of font height).

`int font_get_char_from_glyph_index(RID font_rid, int size, int glyph_index) const`

Returns character code associated with glyph_index, or 0 if glyph_index is invalid. See font_get_glyph_index().

`float font_get_descent(RID font_rid, int size) const`

Returns the font descent (number of pixels below the baseline).

`bool font_get_disable_embedded_bitmaps(RID font_rid) const`

Returns whether the font's embedded bitmap loading is disabled.

`float font_get_embolden(RID font_rid) const`

Returns font embolden strength.

`int font_get_face_count(RID font_rid) const`

Returns number of faces in the TrueType / OpenType collection.

`int font_get_face_index(RID font_rid) const`

Returns an active face index in the TrueType / OpenType collection.

`int font_get_fixed_size(RID font_rid) const`

Returns bitmap font fixed size.

`int font_get_fixed_size_scale_mode(RID font_rid) const`

Returns bitmap font scaling mode.

`bool font_get_generate_mipmaps(RID font_rid) const`

Returns true if font texture mipmap generation is enabled.

`float font_get_global_oversampling() const`

Deprecated.

Use Viewport oversampling, or the [code skip-lint]oversampling[/code] argument of the [code skip-lint]draw_*[/code] methods instead.

Deprecated. This method always returns 1.0.

`Vector2 font_get_glyph_advance(RID font_rid, int size, int glyph) const`

Returns glyph advance (offset of the next glyph). Note: Advance for glyphs outlines is the same as the base glyph advance and is not saved.

`Dictionary font_get_glyph_contours(RID font, int size, int index) const`

Returns outline contours of the glyph as a Dictionary with the following contents: points - PackedVector3Array, containing outline points. x and y are point coordinates. z is the type of the point, using the ContourPointTag values. contours - PackedInt32Array, containing indices the end points of each contour. orientation - bool, contour orientation. If true, clockwise contours must be filled. - Two successive CONTOUR_CURVE_TAG_ON points indicate a line segment. - One CONTOUR_CURVE_TAG_OFF_CONIC point between two CONTOUR_CURVE_TAG_ON points indicates a single conic (quadratic) Bézier arc. - Two CONTOUR_CURVE_TAG_OFF_CUBIC points between two CONTOUR_CURVE_TAG_ON points indicate a single cubic Bézier arc. - Two successive CONTOUR_CURVE_TAG_OFF_CONIC points indicate two successive conic (quadratic) Bézier arcs with a virtual CONTOUR_CURVE_TAG_ON point at their middle. - Each contour is closed. The last point of a contour uses the first point of a contour as its next point, and vice versa. The first point can be CONTOUR_CURVE_TAG_OFF_CONIC point.

`int font_get_glyph_index(RID font_rid, int size, int char, int variation_selector) const`

Returns the glyph index of a char, optionally modified by the variation_selector. See font_get_char_from_glyph_index().

`PackedInt32Array font_get_glyph_list(RID font_rid, Vector2i size) const`

Returns list of rendered glyphs in the cache entry.

`Vector2 font_get_glyph_offset(RID font_rid, Vector2i size, int glyph) const`

Returns glyph offset from the baseline.

`Vector2 font_get_glyph_size(RID font_rid, Vector2i size, int glyph) const`

Returns size of the glyph.

`int font_get_glyph_texture_idx(RID font_rid, Vector2i size, int glyph) const`

Returns index of the cache texture containing the glyph.

`RID font_get_glyph_texture_rid(RID font_rid, Vector2i size, int glyph) const`

Returns resource ID of the cache texture containing the glyph. Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

`Vector2 font_get_glyph_texture_size(RID font_rid, Vector2i size, int glyph) const`

Returns size of the cache texture containing the glyph. Note: If there are pending glyphs to render, calling this function might trigger the texture cache update.

`Rect2 font_get_glyph_uv_rect(RID font_rid, Vector2i size, int glyph) const`

Returns rectangle in the cache texture containing the glyph.

`int font_get_hinting(RID font_rid) const`

Returns the font hinting mode. Used by dynamic fonts only.

`bool font_get_keep_rounding_remainders(RID font_rid) const`

Returns glyph position rounding behavior. If set to true, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.

`Vector2 font_get_kerning(RID font_rid, int size, Vector2i glyph_pair) const`

Returns kerning for the pair of glyphs.

`Vector2i[] font_get_kerning_list(RID font_rid, int size) const`

Returns list of the kerning overrides.

`bool font_get_language_support_override(RID font_rid, String language)`

Returns true if support override is enabled for the language.

`PackedStringArray font_get_language_support_overrides(RID font_rid)`

Returns list of language support overrides.

`int font_get_msdf_pixel_range(RID font_rid) const`

Returns the width of the range around the shape between the minimum and maximum representable signed distance.

`int font_get_msdf_size(RID font_rid) const`

Returns source font size used to generate MSDF textures.

`String font_get_name(RID font_rid) const`

Returns font family name.

`Dictionary font_get_opentype_feature_overrides(RID font_rid) const`

Returns font OpenType feature set override.

`Dictionary font_get_ot_name_strings(RID font_rid) const`

Returns Dictionary with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).

`float font_get_oversampling(RID font_rid) const`

Returns oversampling factor override. If set to a positive value, overrides the oversampling factor of the viewport this font is used in. See Viewport.oversampling. This value doesn't override the [code skip-lint]oversampling[/code] parameter of [code skip-lint]draw_*[/code] methods. Used by dynamic fonts only.

`float font_get_scale(RID font_rid, int size) const`

Returns scaling factor of the color bitmap font.

`bool font_get_script_support_override(RID font_rid, String script)`

Returns true if support override is enabled for the script.

`PackedStringArray font_get_script_support_overrides(RID font_rid)`

Returns list of script support overrides.

`Dictionary[] font_get_size_cache_info(RID font_rid) const`

Returns font cache information, each entry contains the following fields: Vector2i size_px - font size in pixels, float viewport_oversampling - viewport oversampling factor, int glyphs - number of rendered glyphs, int textures - number of used textures, int textures_size - size of texture data in bytes.

`Vector2i[] font_get_size_cache_list(RID font_rid) const`

Returns list of the font sizes in the cache. Each size is Vector2i with font size and outline size.

`int font_get_spacing(RID font_rid, int spacing) const`

Returns the spacing for spacing in pixels (not relative to the font size).

`int font_get_stretch(RID font_rid) const`

Returns font stretch amount, compared to a normal width. A percentage value between 50% and 200%.

`int font_get_style(RID font_rid) const`

Returns font style flags.

`String font_get_style_name(RID font_rid) const`

Returns font style name.

`int font_get_subpixel_positioning(RID font_rid) const`

Returns font subpixel glyph positioning mode.

`String font_get_supported_chars(RID font_rid) const`

Returns a string containing all the characters available in the font.

`PackedInt32Array font_get_supported_glyphs(RID font_rid) const`

Returns an array containing all glyph indices in the font.

`int font_get_texture_count(RID font_rid, Vector2i size) const`

Returns number of textures used by font cache entry.

`Image font_get_texture_image(RID font_rid, Vector2i size, int texture_index) const`

Returns font cache texture image data.

`PackedInt32Array font_get_texture_offsets(RID font_rid, Vector2i size, int texture_index) const`

Returns array containing glyph packing data.

`Transform2D font_get_transform(RID font_rid) const`

Returns 2D transform applied to the font outlines.

`float font_get_underline_position(RID font_rid, int size) const`

Returns pixel offset of the underline below the baseline.

`float font_get_underline_thickness(RID font_rid, int size) const`

Returns thickness of the underline in pixels.

`Dictionary font_get_variation_coordinates(RID font_rid) const`

Returns variation coordinates for the specified font cache entry. See font_supported_variation_list() for more info.

`int font_get_weight(RID font_rid) const`

Returns weight (boldness) of the font. A value in the 100...999 range, normal font weight is 400, bold font weight is 700.

`bool font_has_char(RID font_rid, int char) const`

Returns true if a Unicode char is available in the font.

`bool font_is_allow_system_fallback(RID font_rid) const`

Returns true if system fonts can be automatically used as fallbacks.

`bool font_is_force_autohinter(RID font_rid) const`

Returns true if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.

`bool font_is_language_supported(RID font_rid, String language) const`

Returns true, if font supports given language (ISO 639 code).

`bool font_is_modulate_color_glyphs(RID font_rid) const`

Returns true, if color modulation is applied when drawing colored glyphs.

`bool font_is_multichannel_signed_distance_field(RID font_rid) const`

Returns true if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.

`bool font_is_script_supported(RID font_rid, String script) const`

Returns true, if font supports given script (ISO 15924 code).

`void font_remove_glyph(RID font_rid, Vector2i size, int glyph)`

Removes specified rendered glyph information from the cache entry. Note: This function will not remove textures associated with the glyphs, use font_remove_texture() to remove them manually.

`void font_remove_kerning(RID font_rid, int size, Vector2i glyph_pair)`

Removes kerning override for the pair of glyphs.

`void font_remove_language_support_override(RID font_rid, String language)`

Remove language support override.

`void font_remove_script_support_override(RID font_rid, String script)`

Removes script support override.

`void font_remove_size_cache(RID font_rid, Vector2i size)`

Removes specified font size from the cache entry.

`void font_remove_texture(RID font_rid, Vector2i size, int texture_index)`

Removes specified texture from the cache entry. Note: This function will not remove glyphs associated with the texture, remove them manually, using font_remove_glyph().

`void font_render_glyph(RID font_rid, Vector2i size, int index)`

Renders specified glyph to the font cache texture.

`void font_render_range(RID font_rid, Vector2i size, int start, int end)`

Renders the range of characters to the font cache texture.

`void font_set_allow_system_fallback(RID font_rid, bool allow_system_fallback)`

If set to true, system fonts can be automatically used as fallbacks.

`void font_set_antialiasing(RID font_rid, int antialiasing)`

Sets font anti-aliasing mode.

`void font_set_ascent(RID font_rid, int size, float ascent)`

Sets the font ascent (number of pixels above the baseline).

`void font_set_baseline_offset(RID font_rid, float baseline_offset)`

Sets extra baseline offset (as a fraction of font height).

`void font_set_data(RID font_rid, PackedByteArray data)`

Sets font source data, e.g contents of the dynamic font source file.

`void font_set_descent(RID font_rid, int size, float descent)`

Sets the font descent (number of pixels below the baseline).

`void font_set_disable_embedded_bitmaps(RID font_rid, bool disable_embedded_bitmaps)`

If set to true, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).

`void font_set_embolden(RID font_rid, float strength)`

Sets font embolden strength. If strength is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.

`void font_set_face_index(RID font_rid, int face_index)`

Sets an active face index in the TrueType / OpenType collection.

`void font_set_fixed_size(RID font_rid, int fixed_size)`

Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.

`void font_set_fixed_size_scale_mode(RID font_rid, int fixed_size_scale_mode)`

Sets bitmap font scaling mode. This property is used only if fixed_size is greater than zero.

`void font_set_force_autohinter(RID font_rid, bool force_autohinter)`

If set to true auto-hinting is preferred over font built-in hinting.

`void font_set_generate_mipmaps(RID font_rid, bool generate_mipmaps)`

If set to true font texture mipmap generation is enabled.

`void font_set_global_oversampling(float oversampling)`

Deprecated.

Use Viewport oversampling, or the [code skip-lint]oversampling[/code] argument of the [code skip-lint]draw_*[/code] methods instead.

Deprecated. This method does nothing.

`void font_set_glyph_advance(RID font_rid, int size, int glyph, Vector2 advance)`

Sets glyph advance (offset of the next glyph). Note: Advance for glyphs outlines is the same as the base glyph advance and is not saved.

`void font_set_glyph_offset(RID font_rid, Vector2i size, int glyph, Vector2 offset)`

Sets glyph offset from the baseline.

`void font_set_glyph_size(RID font_rid, Vector2i size, int glyph, Vector2 gl_size)`

Sets size of the glyph.

`void font_set_glyph_texture_idx(RID font_rid, Vector2i size, int glyph, int texture_idx)`

Sets index of the cache texture containing the glyph.

`void font_set_glyph_uv_rect(RID font_rid, Vector2i size, int glyph, Rect2 uv_rect)`

Sets rectangle in the cache texture containing the glyph.

`void font_set_hinting(RID font_rid, int hinting)`

Sets font hinting mode. Used by dynamic fonts only.

`void font_set_keep_rounding_remainders(RID font_rid, bool keep_rounding_remainders)`

Sets glyph position rounding behavior. If set to true, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.

`void font_set_kerning(RID font_rid, int size, Vector2i glyph_pair, Vector2 kerning)`

Sets kerning for the pair of glyphs.

`void font_set_language_support_override(RID font_rid, String language, bool supported)`

Adds override for font_is_language_supported().

`void font_set_modulate_color_glyphs(RID font_rid, bool force_autohinter)`

If set to true, color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only.

`void font_set_msdf_pixel_range(RID font_rid, int msdf_pixel_range)`

Sets the width of the range around the shape between the minimum and maximum representable signed distance.

`void font_set_msdf_size(RID font_rid, int msdf_size)`

Sets source font size used to generate MSDF textures.

`void font_set_multichannel_signed_distance_field(RID font_rid, bool msdf)`

If set to true, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. Note: MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts.

`void font_set_name(RID font_rid, String name)`

Sets the font family name.

`void font_set_opentype_feature_overrides(RID font_rid, Dictionary overrides)`

Sets font OpenType feature set override.

`void font_set_oversampling(RID font_rid, float oversampling)`

If set to a positive value, overrides the oversampling factor of the viewport this font is used in. See Viewport.oversampling. This value doesn't override the [code skip-lint]oversampling[/code] parameter of [code skip-lint]draw_*[/code] methods. Used by dynamic fonts only.

`void font_set_scale(RID font_rid, int size, float scale)`

Sets scaling factor of the color bitmap font.

`void font_set_script_support_override(RID font_rid, String script, bool supported)`

Adds override for font_is_script_supported().

`void font_set_spacing(RID font_rid, int spacing, int value)`

Sets the spacing for spacing to value in pixels (not relative to the font size).

`void font_set_stretch(RID font_rid, int weight)`

Sets font stretch amount, compared to a normal width. A percentage value between 50% and 200%. Note: This value is used for font matching only and will not affect font rendering. Use font_set_face_index(), font_set_variation_coordinates(), or font_set_transform() instead.

`void font_set_style(RID font_rid, int style)`

Sets the font style flags. Note: This value is used for font matching only and will not affect font rendering. Use font_set_face_index(), font_set_variation_coordinates(), font_set_embolden(), or font_set_transform() instead.

`void font_set_style_name(RID font_rid, String name)`

Sets the font style name.

`void font_set_subpixel_positioning(RID font_rid, int subpixel_positioning)`

Sets font subpixel glyph positioning mode.

`void font_set_texture_image(RID font_rid, Vector2i size, int texture_index, Image image)`

Sets font cache texture image data.

`void font_set_texture_offsets(RID font_rid, Vector2i size, int texture_index, PackedInt32Array offset)`

Sets array containing glyph packing data.

`void font_set_transform(RID font_rid, Transform2D transform)`

Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs. For example, to simulate italic typeface by slanting, apply the following transform Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0).

`void font_set_underline_position(RID font_rid, int size, float underline_position)`

Sets pixel offset of the underline below the baseline.

`void font_set_underline_thickness(RID font_rid, int size, float underline_thickness)`

Sets thickness of the underline in pixels.

`void font_set_variation_coordinates(RID font_rid, Dictionary variation_coordinates)`

Sets variation coordinates for the specified font cache entry. See font_supported_variation_list() for more info.

`void font_set_weight(RID font_rid, int weight)`

Sets weight (boldness) of the font. A value in the 100...999 range, normal font weight is 400, bold font weight is 700. Note: This value is used for font matching only and will not affect font rendering. Use font_set_face_index(), font_set_variation_coordinates(), or font_set_embolden() instead.

`Dictionary font_supported_feature_list(RID font_rid) const`

Returns the dictionary of the supported OpenType features.

`Dictionary font_supported_variation_list(RID font_rid) const`

Returns the dictionary of the supported OpenType variation coordinates.

`String format_number(String number, String language = "") const`

Converts a number from the Western Arabic (0..9) to the numeral systems used in language. If language is omitted, the active locale will be used.

`void free_rid(RID rid)`

Frees an object created by this TextServer.

`int get_features() const`

Returns text server features, see Feature.

`Vector2 get_hex_code_box_size(int size, int index) const`

Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).

`String get_name() const`

Returns the name of the server interface.

`PackedByteArray get_support_data() const`

Returns default TextServer database (e.g. ICU break iterators and dictionaries).

`String get_support_data_filename() const`

Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.

`String get_support_data_info() const`

Returns TextServer database (e.g. ICU break iterators and dictionaries) description.

`bool has(RID rid)`

Returns true if rid is valid resource owned by this text server.

`bool has_feature(int feature) const`

Returns true if the server supports a feature.

`int is_confusable(String string, PackedStringArray dict) const`

Returns index of the first string in dict which is visually confusable with the string, or -1 if none is found. Note: This method doesn't detect invisible characters, for spoof detection use it in combination with spoof_check(). Note: Always returns -1 if the server does not support the FEATURE_UNICODE_SECURITY feature.

`bool is_locale_right_to_left(String locale) const`

Returns true if locale is right-to-left.

`bool is_valid_identifier(String string) const`

Returns true if string is a valid identifier. If the text server supports the FEATURE_UNICODE_IDENTIFIERS feature, a valid identifier must: - Conform to normalization form C. - Begin with a Unicode character of class XID_Start or "_". - May contain Unicode characters of class XID_Continue in the other positions. - Use UAX #31 recommended scripts only (mixed scripts are allowed). If the FEATURE_UNICODE_IDENTIFIERS feature is not supported, a valid identifier must: - Begin with a Unicode character of class XID_Start or "_". - May contain Unicode characters of class XID_Continue in the other positions.

`bool is_valid_letter(int unicode) const`

Returns true if the given code point is a valid letter, i.e. it belongs to the Unicode category "L".

`bool load_support_data(String filename)`

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.

`int name_to_tag(String name) const`

Converts readable feature, variation, script, or language name to OpenType tag.

`String parse_number(String number, String language = "") const`

Converts number from the numeral systems used in language to Western Arabic (0..9).

`Vector3i[] parse_structured_text(int parser_type, Array args, String text) const`

Default implementation of the BiDi algorithm override function.

`String percent_sign(String language = "") const`

Returns percent sign used in the language.

`bool save_support_data(String filename) const`

Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. Note: This function is used by during project export, to include TextServer database.

`int shaped_get_run_count(RID shaped) const`

Returns the number of uniform text runs in the buffer.

`int shaped_get_run_direction(RID shaped, int index) const`

Returns the direction of the index text run (in visual order).

`RID shaped_get_run_font_rid(RID shaped, int index) const`

Returns the font RID of the index text run (in visual order).

`int shaped_get_run_font_size(RID shaped, int index) const`

Returns the font size of the index text run (in visual order).

`String shaped_get_run_language(RID shaped, int index) const`

Returns the language of the index text run (in visual order).

`Variant shaped_get_run_object(RID shaped, int index) const`

Returns the embedded object of the index text run (in visual order).

`Vector2i shaped_get_run_range(RID shaped, int index) const`

Returns the source text range of the index text run (in visual order).

`String shaped_get_run_text(RID shaped, int index) const`

Returns the source text of the index text run (in visual order).

`int shaped_get_span_count(RID shaped) const`

Returns number of text spans added using shaped_text_add_string() or shaped_text_add_object().

`Variant shaped_get_span_embedded_object(RID shaped, int index) const`

Returns text embedded object key.

`Variant shaped_get_span_meta(RID shaped, int index) const`

Returns text span metadata.

`Variant shaped_get_span_object(RID shaped, int index) const`

Returns the text span embedded object key.

`String shaped_get_span_text(RID shaped, int index) const`

Returns the text span source text.

`String shaped_get_text(RID shaped) const`

Returns the text buffer source text, including object replacement characters.

`void shaped_set_span_update_font(RID shaped, int index, RID[] fonts, int size, Dictionary opentype_features = {})`

Changes text span font, font size, and OpenType features, without changing the text.

`bool shaped_text_add_object(RID shaped, Variant key, Vector2 size, int inline_align = 5, int length = 1, float baseline = 0.0)`

Adds inline object to the text buffer, key must be unique. In the text, object is represented as length object replacement characters.

`bool shaped_text_add_string(RID shaped, String text, RID[] fonts, int size, Dictionary opentype_features = {}, String language = "", Variant meta = null)`

Adds text span and font to draw it to the text buffer.

`void shaped_text_clear(RID rid)`

Clears text buffer (removes text and inline objects).

`int shaped_text_closest_character_pos(RID shaped, int pos) const`

Returns composite character position closest to the pos.

`void shaped_text_draw(RID shaped, RID canvas, Vector2 pos, float clip_l = -1, float clip_r = -1, Color color = Color(1, 1, 1, 1), float oversampling = 0.0) 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). If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. clip_l and clip_r are offsets relative to pos, going to the right in horizontal layout and downward in vertical layout. If clip_l is not negative, glyphs starting before the offset are clipped. If clip_r is not negative, glyphs ending after the offset are clipped.

`void shaped_text_draw_outline(RID shaped, RID canvas, Vector2 pos, float clip_l = -1, float clip_r = -1, int outline_size = 1, Color color = Color(1, 1, 1, 1), float oversampling = 0.0) 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). If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. clip_l and clip_r are offsets relative to pos, going to the right in horizontal layout and downward in vertical layout. If clip_l is not negative, glyphs starting before the offset are clipped. If clip_r is not negative, glyphs ending after the offset are clipped.

`float shaped_text_fit_to_width(RID shaped, float width, int justification_flags = 3)`

Adjusts text width to fit to specified width, returns new text width.

`float shaped_text_get_ascent(RID shaped) const`

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.

`PackedInt32Array shaped_text_get_character_breaks(RID shaped) const`

Returns array of the composite character boundaries.

`int shaped_text_get_custom_ellipsis(RID shaped) const`

Returns ellipsis character used for text clipping.

`String shaped_text_get_custom_punctuation(RID shaped) const`

Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.

`float shaped_text_get_descent(RID shaped) const`

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.

`int shaped_text_get_direction(RID shaped) const`

Returns direction of the text.

`int shaped_text_get_dominant_direction_in_range(RID shaped, int start, int end) const`

Returns dominant direction of in the range of text.

`int shaped_text_get_ellipsis_glyph_count(RID shaped) const`

Returns number of glyphs in the ellipsis.

`Dictionary[] shaped_text_get_ellipsis_glyphs(RID shaped) const`

Returns array of the glyphs in the ellipsis.

`int shaped_text_get_ellipsis_pos(RID shaped) const`

Returns position of the ellipsis.

`int shaped_text_get_glyph_count(RID shaped) const`

Returns number of glyphs in the buffer.

`Dictionary[] shaped_text_get_glyphs(RID shaped) const`

Returns an array of glyphs in the visual order.

`Vector2 shaped_text_get_grapheme_bounds(RID shaped, int pos) const`

Returns composite character's bounds as offsets from the start of the line.

`int shaped_text_get_inferred_direction(RID shaped) const`

Returns direction of the text, inferred by the BiDi algorithm.

`PackedInt32Array shaped_text_get_line_breaks(RID shaped, float width, int start = 0, int break_flags = 3) const`

Breaks text to the lines and returns character ranges for each line.

`PackedInt32Array 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.

`int shaped_text_get_object_glyph(RID shaped, Variant key) const`

Returns the glyph index of the inline object.

`Vector2i shaped_text_get_object_range(RID shaped, Variant key) const`

Returns the character range of the inline object.

`Rect2 shaped_text_get_object_rect(RID shaped, Variant key) const`

Returns bounding rectangle of the inline object.

`Array shaped_text_get_objects(RID shaped) const`

Returns array of inline objects.

`int shaped_text_get_orientation(RID shaped) const`

Returns text orientation.

`RID shaped_text_get_parent(RID shaped) const`

Returns the parent buffer from which the substring originates.

`bool shaped_text_get_preserve_control(RID shaped) const`

Returns true if text buffer is configured to display control characters.

`bool shaped_text_get_preserve_invalid(RID shaped) const`

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.

`Vector2i shaped_text_get_range(RID shaped) const`

Returns substring buffer character range in the parent buffer.

`PackedVector2Array shaped_text_get_selection(RID shaped, int start, int end) const`

Returns selection rectangles for the specified character range.

`Vector2 shaped_text_get_size(RID shaped) const`

Returns size of the text.

`int shaped_text_get_spacing(RID shaped, int spacing) const`

Returns extra spacing added between glyphs or lines in pixels.

`int shaped_text_get_trim_pos(RID shaped) const`

Returns the position of the overrun trim.

`float shaped_text_get_underline_position(RID shaped) const`

Returns pixel offset of the underline below the baseline.

`float shaped_text_get_underline_thickness(RID shaped) const`

Returns thickness of the underline.

`float shaped_text_get_width(RID shaped) const`

Returns width (for horizontal layout) or height (for vertical) of the text.

`PackedInt32Array shaped_text_get_word_breaks(RID shaped, int grapheme_flags = 264, int skip_grapheme_flags = 4) const`

Breaks text into words and returns array of character ranges. Use grapheme_flags to set what characters are used for breaking.

`bool shaped_text_has_visible_chars(RID shaped) const`

Returns true if text buffer contains any visible characters.

`int shaped_text_hit_test_grapheme(RID shaped, float coords) const`

Returns grapheme index at the specified pixel offset at the baseline, or -1 if none is found.

`int shaped_text_hit_test_position(RID shaped, float coords) const`

Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.

`bool shaped_text_is_ready(RID shaped) const`

Returns true if buffer is successfully shaped.

`int shaped_text_next_character_pos(RID shaped, int pos) const`

Returns composite character end position closest to the pos.

`int shaped_text_next_grapheme_pos(RID shaped, int pos) const`

Returns grapheme end position closest to the pos.

`void shaped_text_overrun_trim_to_width(RID shaped, float width = 0, int overrun_trim_flags = 0)`

Trims text if it exceeds the given width.

`int shaped_text_prev_character_pos(RID shaped, int pos) const`

Returns composite character start position closest to the pos.

`int shaped_text_prev_grapheme_pos(RID shaped, int pos) const`

Returns grapheme start position closest to the pos.

`bool shaped_text_resize_object(RID shaped, Variant key, Vector2 size, int inline_align = 5, float baseline = 0.0)`

Sets new size and alignment of embedded object.

`void shaped_text_set_bidi_override(RID shaped, Array override)`

Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.

`void shaped_text_set_custom_ellipsis(RID shaped, int char)`

Sets ellipsis character used for text clipping.

`void shaped_text_set_custom_punctuation(RID shaped, String punct)`

Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.

`void shaped_text_set_direction(RID shaped, int direction = 0)`

Sets desired text direction. If set to 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 (supported by TextServerAdvanced).

`void shaped_text_set_orientation(RID shaped, int orientation = 0)`

Sets desired text orientation. Note: Orientation is ignored if server does not support FEATURE_VERTICAL_LAYOUT feature (supported by TextServerAdvanced).

`void shaped_text_set_preserve_control(RID shaped, bool enabled)`

If set to true text buffer will display control characters.

`void shaped_text_set_preserve_invalid(RID shaped, bool enabled)`

If set to true text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.

`void shaped_text_set_spacing(RID shaped, int spacing, int value)`

Sets extra spacing added between glyphs or lines in pixels.

`bool shaped_text_shape(RID shaped)`

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.

`Dictionary[] shaped_text_sort_logical(RID shaped)`

Returns text glyphs in the logical order.

`RID shaped_text_substr(RID shaped, int start, int length) const`

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.

`bool spoof_check(String string) const`

Returns true if string is likely to be an attempt at confusing the reader. Note: Always returns false if the server does not support the FEATURE_UNICODE_SECURITY feature.

`PackedInt32Array string_get_character_breaks(String string, String language = "") const`

Returns array of the composite character boundaries.

				var ts = TextServerManager.get_primary_interface()
				print(ts.string_get_character_breaks("Test ❤️‍🔥 Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]

`PackedInt32Array string_get_word_breaks(String string, String language = "", int chars_per_line = 0) const`

Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even. When chars_per_line is greater than zero, line break boundaries are returned instead.

				var ts = TextServerManager.get_primary_interface()
				# Corresponds to the substrings "The", "Redot", "Engine", and "4".
				print(ts.string_get_word_breaks("The Redot Engine, 4")) # Prints [0, 3, 4, 9, 10, 16, 18, 19]
				# Corresponds to the substrings "The", "Redot", "Engin", and "e, 4".
				print(ts.string_get_word_breaks("The Redot Engine, 4", "en", 5)) # Prints [0, 3, 4, 9, 10, 15, 15, 19]
				# Corresponds to the substrings "The Redot" and "Engine, 4".
				print(ts.string_get_word_breaks("The Redot Engine, 4", "en", 10)) # Prints [0, 9, 10, 19]

`String string_to_lower(String string, String language = "") const`

Returns the string converted to lowercase. Note: Casing is locale dependent and context sensitive if server support FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION feature (supported by TextServerAdvanced). Note: The result may be longer or shorter than the original.

`String string_to_title(String string, String language = "") const`

Returns the string converted to title case. Note: Casing is locale dependent and context sensitive if server support FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION feature (supported by TextServerAdvanced). Note: The result may be longer or shorter than the original.

`String string_to_upper(String string, String language = "") const`

Returns the string converted to uppercase. Note: Casing is locale dependent and context sensitive if server support FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION feature (supported by TextServerAdvanced). Note: The result may be longer or shorter than the original.

`String strip_diacritics(String string) const`

Strips diacritics from the string. Note: The result may be longer or shorter than the original.

`String tag_to_name(int tag) const`

Converts OpenType tag to readable feature, variation, script, or language name.

Constants

`FONT_ANTIALIASING_NONE = 0`

Enum: FontAntialiasing

Font glyphs are rasterized as 1-bit bitmaps.

`FONT_ANTIALIASING_GRAY = 1`

Enum: FontAntialiasing

Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.

`FONT_ANTIALIASING_LCD = 2`

Enum: FontAntialiasing

Font glyphs are rasterized for LCD screens. LCD subpixel layout is determined by the value of the ProjectSettings.gui/theme/lcd_subpixel_layout setting. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.

`FONT_LCD_SUBPIXEL_LAYOUT_NONE = 0`

Enum: FontLCDSubpixelLayout

Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.

`FONT_LCD_SUBPIXEL_LAYOUT_HRGB = 1`

Enum: FontLCDSubpixelLayout

Horizontal RGB subpixel layout.

`FONT_LCD_SUBPIXEL_LAYOUT_HBGR = 2`

Enum: FontLCDSubpixelLayout

Horizontal BGR subpixel layout.

`FONT_LCD_SUBPIXEL_LAYOUT_VRGB = 3`

Enum: FontLCDSubpixelLayout

Vertical RGB subpixel layout.

`FONT_LCD_SUBPIXEL_LAYOUT_VBGR = 4`

Enum: FontLCDSubpixelLayout

Vertical BGR subpixel layout.

`FONT_LCD_SUBPIXEL_LAYOUT_MAX = 5`

Enum: FontLCDSubpixelLayout

Represents the size of the FontLCDSubpixelLayout enum.

`DIRECTION_AUTO = 0`

Enum: Direction

Text direction is determined based on contents and current locale.

`DIRECTION_LTR = 1`

Enum: Direction

Text is written from left to right.

`DIRECTION_RTL = 2`

Enum: Direction

Text is written from right to left.

`DIRECTION_INHERITED = 3`

Enum: Direction

Text writing direction is the same as base string writing direction. Used for BiDi override only.

`ORIENTATION_HORIZONTAL = 0`

Enum: Orientation

Text is written horizontally.

`ORIENTATION_VERTICAL = 1`

Enum: Orientation

Left to right text is written vertically from top to bottom. Right to left text is written vertically from bottom to top.

`JUSTIFICATION_NONE = 0`

Enum: JustificationFlag

Do not justify text.

`JUSTIFICATION_KASHIDA = 1`

Enum: JustificationFlag

Justify text by adding and removing kashidas.

`JUSTIFICATION_WORD_BOUND = 2`

Enum: JustificationFlag

Justify text by changing width of the spaces between the words.

`JUSTIFICATION_TRIM_EDGE_SPACES = 4`

Enum: JustificationFlag

Remove trailing and leading spaces from the justified text.

`JUSTIFICATION_AFTER_LAST_TAB = 8`

Enum: JustificationFlag

Only apply justification to the part of the text after the last tab.

`JUSTIFICATION_CONSTRAIN_ELLIPSIS = 16`

Enum: JustificationFlag

Apply justification to the trimmed line with ellipsis.

`JUSTIFICATION_SKIP_LAST_LINE = 32`

Enum: JustificationFlag

Do not apply justification to the last line of the paragraph.

`JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS = 64`

Enum: JustificationFlag

Do not apply justification to the last line of the paragraph with visible characters (takes precedence over JUSTIFICATION_SKIP_LAST_LINE).

`JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE = 128`

Enum: JustificationFlag

Always apply justification to the paragraphs with a single line (JUSTIFICATION_SKIP_LAST_LINE and JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS are ignored).

`AUTOWRAP_OFF = 0`

Enum: AutowrapMode

Autowrap is disabled.

`AUTOWRAP_ARBITRARY = 1`

Enum: AutowrapMode

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`

Enum: AutowrapMode

Wraps the text inside the node's bounding rectangle by soft-breaking between words.

`AUTOWRAP_WORD_SMART = 3`

Enum: AutowrapMode

Behaves similarly to AUTOWRAP_WORD, but force-breaks a word if that single word does not fit in one line.

`BREAK_NONE = 0`

Enum: LineBreakFlag

Do not break the line.

`BREAK_MANDATORY = 1`

Enum: LineBreakFlag

Break the line at the line mandatory break characters (e.g. "\n").

`BREAK_WORD_BOUND = 2`

Enum: LineBreakFlag

Break the line between the words.

`BREAK_GRAPHEME_BOUND = 4`

Enum: LineBreakFlag

Break the line between any unconnected graphemes.

`BREAK_ADAPTIVE = 8`

Enum: LineBreakFlag

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`

Enum: LineBreakFlag

Deprecated.

Use BREAK_TRIM_START_EDGE_SPACES | BREAK_TRIM_END_EDGE_SPACES instead.

Remove edge spaces from the broken line segments.

`BREAK_TRIM_INDENT = 32`

Enum: LineBreakFlag

Subtract first line indentation width from all lines after the first one.

`BREAK_TRIM_START_EDGE_SPACES = 64`

Enum: LineBreakFlag

Remove spaces and line break characters from the start of broken line segments. E.g, after line breaking, the second segment of the following text test \n next, is next if the flag is set, and next if it is not.

`BREAK_TRIM_END_EDGE_SPACES = 128`

Enum: LineBreakFlag

Remove spaces and line break characters from the end of broken line segments. E.g, after line breaking, the first segment of the following text test \n next, is test if the flag is set, and test \n if it is not.