Skip to content
Download
API reference

TextShaping

Inherits: Shared < Object

Inherited by: TextShapingExtension

A server interface for font management and text rendering.

TextShaping 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 TextShaping instance, use the following code:

ts : TextShaping = TextShaping.get_driver()
ReturnsMethod
voidadd_driver(driver)
RIDcreate_font()
RIDcreate_font_linked_variation(font_rid)
RIDcreate_shaped_text(direction, orientation)
voiddraw_hex_code_box(canvas, size, pos, index, color)
TextShapingfind_driver(name)
voidfont_clear_glyphs(font_rid, size)
voidfont_clear_kerning_map(font_rid, size)
voidfont_clear_size_cache(font_rid)
voidfont_clear_system_fallback_cache()
voidfont_clear_textures(font_rid, size)
voidfont_draw_glyph(font_rid, canvas, size, pos, index, color, oversampling)
voidfont_draw_glyph_outline(font_rid, canvas, size, outline_size, pos, index, color, oversampling)
TextShaping.FontAntialiasingfont_get_antialiasing(font_rid)
floatfont_get_ascent(font_rid, size)
floatfont_get_baseline_offset(font_rid)
intfont_get_char_from_glyph_index(font_rid, size, glyph_index)
floatfont_get_descent(font_rid, size)
boolfont_get_disable_embedded_bitmaps(font_rid)
floatfont_get_embolden(font_rid)
intfont_get_face_count(font_rid)
intfont_get_face_index(font_rid)
intfont_get_fixed_size(font_rid)
TextShaping.FixedSizeScaleModefont_get_fixed_size_scale_mode(font_rid)
boolfont_get_generate_mipmaps(font_rid)
Vector2font_get_glyph_advance(font_rid, size, glyph)
Dictionaryfont_get_glyph_contours(font, size, index)
intfont_get_glyph_index(font_rid, size, char, variation_selector)
[]i32font_get_glyph_list(font_rid, size)
Vector2font_get_glyph_offset(font_rid, size, glyph)
Vector2font_get_glyph_size(font_rid, size, glyph)
intfont_get_glyph_texture_idx(font_rid, size, glyph)
RIDfont_get_glyph_texture_rid(font_rid, size, glyph)
Vector2font_get_glyph_texture_size(font_rid, size, glyph)
Rect2font_get_glyph_uv_rect(font_rid, size, glyph)
TextShaping.Hintingfont_get_hinting(font_rid)
boolfont_get_keep_rounding_remainders(font_rid)
Vector2font_get_kerning(font_rid, size, glyph_pair)
[]Vector2ifont_get_kerning_list(font_rid, size)
boolfont_get_language_support_override(font_rid, language)
[]Stringfont_get_language_support_overrides(font_rid)
intfont_get_msdf_pixel_range(font_rid)
intfont_get_msdf_size(font_rid)
Stringfont_get_name(font_rid)
Dictionaryfont_get_opentype_feature_overrides(font_rid)
Dictionaryfont_get_ot_name_strings(font_rid)
floatfont_get_oversampling(font_rid)
[]Colorfont_get_palette_colors(font_rid, index)
intfont_get_palette_count(font_rid)
[]Colorfont_get_palette_custom_colors(font_rid)
Stringfont_get_palette_name(font_rid, index)
floatfont_get_scale(font_rid, size)
boolfont_get_script_support_override(font_rid, script)
[]Stringfont_get_script_support_overrides(font_rid)
[]Dictionaryfont_get_size_cache_info(font_rid)
[]Vector2ifont_get_size_cache_list(font_rid)
intfont_get_spacing(font_rid, spacing)
intfont_get_stretch(font_rid)
TextShaping.FontStylefont_get_style(font_rid)
Stringfont_get_style_name(font_rid)
TextShaping.SubpixelPositioningfont_get_subpixel_positioning(font_rid)
Stringfont_get_supported_chars(font_rid)
[]i32font_get_supported_glyphs(font_rid)
intfont_get_texture_count(font_rid, size)
Imagefont_get_texture_image(font_rid, size, texture_index)
[]i32font_get_texture_offsets(font_rid, size, texture_index)
Transform2Dfont_get_transform(font_rid)
floatfont_get_underline_position(font_rid, size)
floatfont_get_underline_thickness(font_rid, size)
intfont_get_used_palette(font_rid)
Dictionaryfont_get_variation_coordinates(font_rid)
intfont_get_weight(font_rid)
boolfont_has_char(font_rid, char)
boolfont_is_allow_system_fallback(font_rid)
boolfont_is_force_autohinter(font_rid)
boolfont_is_language_supported(font_rid, language)
boolfont_is_modulate_color_glyphs(font_rid)
boolfont_is_multichannel_signed_distance_field(font_rid)
boolfont_is_script_supported(font_rid, script)
voidfont_remove_glyph(font_rid, size, glyph)
voidfont_remove_kerning(font_rid, size, glyph_pair)
voidfont_remove_language_support_override(font_rid, language)
voidfont_remove_script_support_override(font_rid, script)
voidfont_remove_size_cache(font_rid, size)
voidfont_remove_texture(font_rid, size, texture_index)
voidfont_render_glyph(font_rid, size, index)
voidfont_render_range(font_rid, size, start, end)
voidfont_set_allow_system_fallback(font_rid, allow_system_fallback)
voidfont_set_antialiasing(font_rid, antialiasing)
voidfont_set_ascent(font_rid, size, ascent)
voidfont_set_baseline_offset(font_rid, baseline_offset)
voidfont_set_data(font_rid, data)
voidfont_set_descent(font_rid, size, descent)
voidfont_set_disable_embedded_bitmaps(font_rid, disable_embedded_bitmaps)
voidfont_set_embolden(font_rid, strength)
voidfont_set_face_index(font_rid, face_index)
voidfont_set_fixed_size(font_rid, fixed_size)
voidfont_set_fixed_size_scale_mode(font_rid, fixed_size_scale_mode)
voidfont_set_force_autohinter(font_rid, force_autohinter)
voidfont_set_generate_mipmaps(font_rid, generate_mipmaps)
voidfont_set_glyph_advance(font_rid, size, glyph, advance)
voidfont_set_glyph_offset(font_rid, size, glyph, offset)
voidfont_set_glyph_size(font_rid, size, glyph, gl_size)
voidfont_set_glyph_texture_idx(font_rid, size, glyph, texture_idx)
voidfont_set_glyph_uv_rect(font_rid, size, glyph, uv_rect)
voidfont_set_hinting(font_rid, hinting)
voidfont_set_keep_rounding_remainders(font_rid, keep_rounding_remainders)
voidfont_set_kerning(font_rid, size, glyph_pair, kerning)
voidfont_set_language_support_override(font_rid, language, supported)
voidfont_set_modulate_color_glyphs(font_rid, modulate)
voidfont_set_msdf_pixel_range(font_rid, msdf_pixel_range)
voidfont_set_msdf_size(font_rid, msdf_size)
voidfont_set_multichannel_signed_distance_field(font_rid, msdf)
voidfont_set_name(font_rid, name)
voidfont_set_opentype_feature_overrides(font_rid, overrides)
voidfont_set_oversampling(font_rid, oversampling)
voidfont_set_palette_custom_colors(font_rid, colors)
voidfont_set_scale(font_rid, size, scale)
voidfont_set_script_support_override(font_rid, script, supported)
voidfont_set_spacing(font_rid, spacing, value)
voidfont_set_stretch(font_rid, weight)
voidfont_set_style(font_rid, style)
voidfont_set_style_name(font_rid, name)
voidfont_set_subpixel_positioning(font_rid, subpixel_positioning)
voidfont_set_texture_image(font_rid, size, texture_index, image)
voidfont_set_texture_offsets(font_rid, size, texture_index, offset)
voidfont_set_transform(font_rid, transform)
voidfont_set_underline_position(font_rid, size, underline_position)
voidfont_set_underline_thickness(font_rid, size, underline_thickness)
voidfont_set_used_palette(font_rid, index)
voidfont_set_variation_coordinates(font_rid, variation_coordinates)
voidfont_set_weight(font_rid, weight)
Dictionaryfont_supported_feature_list(font_rid)
Dictionaryfont_supported_variation_list(font_rid)
voidfree_rid(rid)
TextShapingget_driver()
TextShapingget_driver_at(index)
intget_driver_count()
[]Dictionaryget_drivers()
intget_features()
Vector2get_hex_code_box_size(size, index)
Stringget_name()
[]u8get_support_data()
Stringget_support_data_filename()
Stringget_support_data_info()
boolhas(rid)
boolhas_feature(feature)
intis_confusable(string, dict)
boolis_locale_right_to_left(locale)
boolis_locale_using_support_data(locale)
boolis_valid_identifier(string)
boolis_valid_letter(unicode)
boolload_support_data(filename)
intname_to_tag(name)
[]Vector3iparse_structured_text(parser_type, args, text)
voidremove_driver(driver)
boolsave_support_data(filename)
voidset_driver(driver)
intshaped_get_run_count(shaped)
TextShaping.Directionshaped_get_run_direction(shaped, index)
RIDshaped_get_run_font_rid(shaped, index)
intshaped_get_run_font_size(shaped, index)
Vector2ishaped_get_run_glyph_range(shaped, index)
Stringshaped_get_run_language(shaped, index)
Variantshaped_get_run_object(shaped, index)
Vector2ishaped_get_run_range(shaped, index)
Stringshaped_get_run_text(shaped, index)
intshaped_get_span_count(shaped)
Variantshaped_get_span_embedded_object(shaped, index)
Variantshaped_get_span_meta(shaped, index)
Variantshaped_get_span_object(shaped, index)
Stringshaped_get_span_text(shaped, index)
Stringshaped_get_text(shaped)
voidshaped_set_span_update_font(shaped, index, fonts, size, opentype_features)
boolshaped_text_add_object(shaped, key, size, inline_align, length, baseline)
boolshaped_text_add_string(shaped, text, fonts, size, opentype_features, language, meta)
voidshaped_text_clear(rid)
intshaped_text_closest_character_pos(shaped, pos)
voidshaped_text_draw(shaped, canvas, pos, clip_l, clip_r, color, oversampling)
voidshaped_text_draw_outline(shaped, canvas, pos, clip_l, clip_r, outline_size, color, oversampling)
RIDshaped_text_duplicate(rid)
floatshaped_text_fit_to_width(shaped, width, justification_flags)
floatshaped_text_get_ascent(shaped)
Dictionaryshaped_text_get_carets(shaped, position)
[]i32shaped_text_get_character_breaks(shaped)
intshaped_text_get_custom_ellipsis(shaped)
Stringshaped_text_get_custom_punctuation(shaped)
floatshaped_text_get_descent(shaped)
TextShaping.Directionshaped_text_get_direction(shaped)
TextShaping.Directionshaped_text_get_dominant_direction_in_range(shaped, start, end)
intshaped_text_get_ellipsis_glyph_count(shaped)
[]Dictionaryshaped_text_get_ellipsis_glyphs(shaped)
intshaped_text_get_ellipsis_pos(shaped)
intshaped_text_get_glyph_count(shaped)
[]Dictionaryshaped_text_get_glyphs(shaped)
Vector2shaped_text_get_grapheme_bounds(shaped, pos)
TextShaping.Directionshaped_text_get_inferred_direction(shaped)
[]i32shaped_text_get_line_breaks(shaped, width, start, break_flags)
[]i32shaped_text_get_line_breaks_adv(shaped, width, start, once, break_flags)
intshaped_text_get_object_glyph(shaped, key)
Vector2ishaped_text_get_object_range(shaped, key)
Rect2shaped_text_get_object_rect(shaped, key)
Arrayshaped_text_get_objects(shaped)
TextShaping.Orientationshaped_text_get_orientation(shaped)
RIDshaped_text_get_parent(shaped)
boolshaped_text_get_preserve_control(shaped)
boolshaped_text_get_preserve_invalid(shaped)
Vector2ishaped_text_get_range(shaped)
[]Vector2shaped_text_get_selection(shaped, start, end)
Vector2shaped_text_get_size(shaped)
intshaped_text_get_spacing(shaped, spacing)
intshaped_text_get_trim_pos(shaped)
floatshaped_text_get_underline_position(shaped)
floatshaped_text_get_underline_thickness(shaped)
floatshaped_text_get_width(shaped)
[]i32shaped_text_get_word_breaks(shaped, grapheme_flags, skip_grapheme_flags)
boolshaped_text_has_object(shaped, key)
boolshaped_text_has_visible_chars(shaped)
intshaped_text_hit_test_grapheme(shaped, coords)
intshaped_text_hit_test_position(shaped, coords)
boolshaped_text_is_ready(shaped)
intshaped_text_next_character_pos(shaped, pos)
intshaped_text_next_grapheme_pos(shaped, pos)
voidshaped_text_overrun_trim_to_width(shaped, width, overrun_trim_flags)
intshaped_text_prev_character_pos(shaped, pos)
intshaped_text_prev_grapheme_pos(shaped, pos)
boolshaped_text_resize_object(shaped, key, size, inline_align, baseline)
voidshaped_text_set_bidi_override(shaped, override)
voidshaped_text_set_custom_ellipsis(shaped, char)
voidshaped_text_set_custom_punctuation(shaped, punct)
voidshaped_text_set_direction(shaped, direction)
voidshaped_text_set_orientation(shaped, orientation)
voidshaped_text_set_preserve_control(shaped, enabled)
voidshaped_text_set_preserve_invalid(shaped, enabled)
voidshaped_text_set_spacing(shaped, spacing, value)
boolshaped_text_shape(shaped)
[]Dictionaryshaped_text_sort_logical(shaped)
RIDshaped_text_substr(shaped, start, length)
floatshaped_text_tab_align(shaped, tab_stops)
boolspoof_check(string)
[]i32string_get_character_breaks(string, language)
[]i32string_get_word_breaks(string, language, chars_per_line)
Stringstring_to_lower(string, language)
Stringstring_to_title(string, language)
Stringstring_to_upper(string, language)
Stringstrip_diacritics(string)
Stringtag_to_name(tag)

  • 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 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 — Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.

  • FONT_LCD_SUBPIXEL_LAYOUT_HRGB = 1 — Horizontal RGB subpixel layout.

  • FONT_LCD_SUBPIXEL_LAYOUT_HBGR = 2 — Horizontal BGR subpixel layout.

  • FONT_LCD_SUBPIXEL_LAYOUT_VRGB = 3 — Vertical RGB subpixel layout.

  • FONT_LCD_SUBPIXEL_LAYOUT_VBGR = 4 — Vertical BGR subpixel layout.

  • 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.

  • DIRECTION_INHERITED = 3 — Text writing direction is the same as base string writing direction. Used for BiDi override only.

  • 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.

  • 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.

  • JUSTIFICATION_SKIP_LAST_LINE = 32 — Do not apply justification to the last line of the paragraph.

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

  • AUTOWRAP_OFF = 0 — Autowrap is disabled.

  • AUTOWRAP_ARBITRARY = 1 — Wraps the text inside the actor’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 actor’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.

  • 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_INDENT = 32 — Subtract first line indentation width from all lines after the first one.

  • BREAK_TRIM_START_EDGE_SPACES = 64 — 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 — 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.

  • 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. Note: In this mode, trimmed text is not processed at all. It is not accounted for in line breaking and size calculations.

  • 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 if trimmed text is 6 characters or longer.

  • OVERRUN_TRIM_WORD_ELLIPSIS = 4 — Trims the text per word and adds an ellipsis to indicate that parts are hidden if trimmed text is 6 characters or longer.

  • OVERRUN_TRIM_ELLIPSIS_FORCE = 5 — Trims the text per character and adds an ellipsis to indicate that parts are hidden regardless of trimmed text length.

  • OVERRUN_TRIM_WORD_ELLIPSIS_FORCE = 6 — Trims the text per word and adds an ellipsis to indicate that parts are hidden regardless of trimmed text length.

  • 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 — Accounts for the text being justified before attempting to trim it (see JustificationFlag).

  • OVERRUN_SHORT_STRING_ELLIPSIS = 32 — Determines whether the ellipsis should be added regardless of the string length, otherwise it is added only if the string is 6 characters or longer.

  • 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.

  • GRAPHEME_IS_EMBEDDED_OBJECT = 4096 — Grapheme is an object replacement character for the embedded object.

  • GRAPHEME_IS_SOFT_HYPHEN = 8192 — Grapheme is a soft hyphen.

  • 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.

  • SUBPIXEL_POSITIONING_DISABLED = 0 — Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.

  • 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.

  • FEATURE_SIMPLE_LAYOUT = 1 — TextShaping supports simple text layouts.

  • FEATURE_BIDI_LAYOUT = 2 — TextShaping supports bidirectional text layouts.

  • FEATURE_VERTICAL_LAYOUT = 4 — TextShaping supports vertical layouts.

  • FEATURE_SHAPING = 8 — TextShaping supports complex text shaping.

  • FEATURE_KASHIDA_JUSTIFICATION = 16 — TextShaping supports justification using kashidas.

  • FEATURE_BREAK_ITERATORS = 32 — TextShaping supports complex line/word breaking rules (e.g. dictionary based).

  • FEATURE_FONT_BITMAP = 64 — TextShaping supports loading bitmap fonts.

  • FEATURE_FONT_DYNAMIC = 128 — TextShaping supports loading dynamic (TrueType, OpeType, etc.) fonts.

  • FEATURE_FONT_MSDF = 256 — TextShaping supports multichannel signed distance field dynamic font rendering.

  • FEATURE_FONT_SYSTEM = 512 — TextShaping supports loading system fonts.

  • FEATURE_FONT_VARIABLE = 1024 — TextShaping supports variable fonts.

  • FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION = 2048 — TextShaping supports locale dependent and context sensitive case conversion.

  • FEATURE_USE_SUPPORT_DATA = 4096 — TextShaping require external data file for some features, see load_support_data().

  • FEATURE_UNICODE_IDENTIFIERS = 8192 — TextShaping supports UAX #31 identifier validation, see is_valid_identifier().

  • CONTOUR_CURVE_TAG_ON = 1 — Contour point is on the curve.

  • CONTOUR_CURVE_TAG_OFF_CONIC = 0 — Contour point isn’t on the curve, but serves as a control point for a conic (quadratic) Bézier arc.

  • CONTOUR_CURVE_TAG_OFF_CUBIC = 2 — Contour point isn’t on the curve, but serves as a control point for a cubic Bézier arc.

  • SPACING_GLYPH = 0 — Spacing for each glyph.

  • SPACING_SPACE = 1 — Spacing for the space character.

  • SPACING_TOP = 2 — Spacing at the top of the line.

  • SPACING_BOTTOM = 3 — Spacing at the bottom of the line.

  • SPACING_MAX = 4 — Represents the size of the SpacingType enum.

  • FONT_BOLD = 1 — Font is bold.

  • FONT_ITALIC = 2 — Font is italic or oblique.

  • FONT_FIXED_WIDTH = 4 — Font has fixed-width characters (also known as monospace).

  • STRUCTURED_TEXT_DEFAULT = 0 — Use default Unicode BiDi algorithm.

  • STRUCTURED_TEXT_URI = 1 — BiDi override for URI.

  • STRUCTURED_TEXT_FILE = 2 — BiDi override for file path.

  • STRUCTURED_TEXT_EMAIL = 3 — BiDi override for email.

  • STRUCTURED_TEXT_LIST = 4 — BiDi override for lists. Structured text options: list separator String.

  • STRUCTURED_TEXT_GROST = 5

  • STRUCTURED_TEXT_CUSTOM = 6 — User defined structured text BiDi override function.

  • FIXED_SIZE_SCALE_DISABLE = 0 — Bitmap font is not scaled.

  • FIXED_SIZE_SCALE_INTEGER_ONLY = 1 — Bitmap font is scaled to the closest integer multiple of the font’s fixed size. This is the recommended option for pixel art fonts.

  • FIXED_SIZE_SCALE_ENABLED = 2 — Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.

void add_driver(driver: TextShaping) static

Registers a text shaping driver.

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(font_rid: 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(direction: TextShaping.Direction = 0, orientation: TextShaping.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 TextShapingDriverAdvanced).

Note: Orientation is ignored if server does not support FEATURE_VERTICAL_LAYOUT feature (supported by TextShapingDriverAdvanced).

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

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

TextShaping find_driver(name: String) static

Returns the registered driver named name.

void font_clear_glyphs(font_rid: RID, size: Vector2i)

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(font_rid: RID, size: int)

Removes all kerning overrides.

void font_clear_size_cache(font_rid: 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(font_rid: RID, size: Vector2i)

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(font_rid: RID, canvas: RID, size: int, pos: Vector2, index: int, color: Color = Color(1, 1, 1, 1), oversampling: float = 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(font_rid: RID, canvas: RID, size: int, outline_size: int, pos: Vector2, index: int, color: Color = Color(1, 1, 1, 1), oversampling: float = 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.

TextShaping.FontAntialiasing font_get_antialiasing(font_rid: RID) const

Returns font anti-aliasing mode.

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

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

float font_get_baseline_offset(font_rid: RID) const

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

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

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

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

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

bool font_get_disable_embedded_bitmaps(font_rid: RID) const

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

float font_get_embolden(font_rid: RID) const

Returns font embolden strength.

int font_get_face_count(font_rid: RID) const

Returns number of faces in the TrueType / OpenType collection.

int font_get_face_index(font_rid: RID) const

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

int font_get_fixed_size(font_rid: RID) const

Returns bitmap font fixed size.

TextShaping.FixedSizeScaleMode font_get_fixed_size_scale_mode(font_rid: RID) const

Returns bitmap font scaling mode.

bool font_get_generate_mipmaps(font_rid: RID) const

Returns true if font texture mipmap generation is enabled.

Vector2 font_get_glyph_advance(font_rid: RID, size: int, glyph: int) 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(font: RID, size: int, index: int) const

Returns outline contours of the glyph as a Dictionary with the following contents:

points - []Vector3, containing outline points. x and y are point coordinates. z is the type of the point, using the ContourPointTag values.

contours - []i32, containing indices the end points of each contour.

orientation - [bool], contour orientation. If true, clockwise contours must be filled.

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

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

[]i32 font_get_glyph_list(font_rid: RID, size: Vector2i) const

Returns list of rendered glyphs in the cache entry.

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

Returns glyph offset from the baseline.

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

Returns size of the glyph.

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

Returns index of the cache texture containing the glyph.

RID font_get_glyph_texture_rid(font_rid: RID, size: Vector2i, glyph: int) 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(font_rid: RID, size: Vector2i, glyph: int) 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(font_rid: RID, size: Vector2i, glyph: int) const

Returns rectangle in the cache texture containing the glyph.

TextShaping.Hinting font_get_hinting(font_rid: RID) const

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

bool font_get_keep_rounding_remainders(font_rid: 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(font_rid: RID, size: int, glyph_pair: Vector2i) const

Returns kerning for the pair of glyphs.

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

Returns list of the kerning overrides.

bool font_get_language_support_override(font_rid: RID, language: String)

Returns true if support override is enabled for the language.

[]String font_get_language_support_overrides(font_rid: RID)

Returns list of language support overrides.

int font_get_msdf_pixel_range(font_rid: RID) const

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

int font_get_msdf_size(font_rid: RID) const

Returns source font size used to generate MSDF textures.

String font_get_name(font_rid: RID) const

Returns font family name.

Dictionary font_get_opentype_feature_overrides(font_rid: RID) const

Returns font OpenType feature set override.

Dictionary font_get_ot_name_strings(font_rid: RID) const

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

float font_get_oversampling(font_rid: 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.

[]Color font_get_palette_colors(font_rid: RID, index: int) const

Returns the array in the predefined color palette at index. Palette contains all colors used to render font glyphs. Each palette has the same number of colors. Colors can be overridden using font_set_palette_custom_colors().

int font_get_palette_count(font_rid: RID) const

Returns the number of predefined color palettes. Palette contains all colors used to render font glyphs. Each palette has the same number of colors.

[]Color font_get_palette_custom_colors(font_rid: RID) const

Returns array of custom colors to override predefined palette.

String font_get_palette_name(font_rid: RID, index: int) const

Returns the name of the predefined color palette at index. Palette contains all colors used to render font glyphs. Each palette has the same number of colors.

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

Returns scaling factor of the color bitmap font.

bool font_get_script_support_override(font_rid: RID, script: String)

Returns true if support override is enabled for the script.

[]String font_get_script_support_overrides(font_rid: RID)

Returns list of script support overrides.

[]Dictionary font_get_size_cache_info(font_rid: 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(font_rid: 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(font_rid: RID, spacing: TextShaping.SpacingType) const

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

int font_get_stretch(font_rid: RID) const

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

TextShaping.FontStyle font_get_style(font_rid: RID) const

Returns font style flags.

String font_get_style_name(font_rid: RID) const

Returns font style name.

TextShaping.SubpixelPositioning font_get_subpixel_positioning(font_rid: RID) const

Returns font subpixel glyph positioning mode.

String font_get_supported_chars(font_rid: RID) const

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

[]i32 font_get_supported_glyphs(font_rid: RID) const

Returns an array containing all glyph indices in the font.

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

Returns number of textures used by font cache entry.

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

Returns font cache texture image data.

[]i32 font_get_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int) const

Returns array containing glyph packing data.

Transform2D font_get_transform(font_rid: RID) const

Returns 2D transform applied to the font outlines.

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

Returns pixel offset of the underline below the baseline.

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

Returns thickness of the underline in pixels.

int font_get_used_palette(font_rid: RID) const

Returns used palette index.

Dictionary font_get_variation_coordinates(font_rid: RID) const

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

int font_get_weight(font_rid: 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(font_rid: RID, char: int) const

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

bool font_is_allow_system_fallback(font_rid: RID) const

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

bool font_is_force_autohinter(font_rid: 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(font_rid: RID, language: String) const

Returns true if the font supports the given language (as a ISO 639 code).

bool font_is_modulate_color_glyphs(font_rid: RID) const

Returns true if color modulation is applied when drawing the font’s colored glyphs.

font_is_multichannel_signed_distance_field

Section titled “font_is_multichannel_signed_distance_field”

bool font_is_multichannel_signed_distance_field(font_rid: 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(font_rid: RID, script: String) const

Returns true if the font supports the given script (as a ISO 15924 code).

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

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(font_rid: RID, size: int, glyph_pair: Vector2i)

Removes kerning override for the pair of glyphs.

void font_remove_language_support_override(font_rid: RID, language: String)

Remove language support override.

void font_remove_script_support_override(font_rid: RID, script: String)

Removes script support override.

void font_remove_size_cache(font_rid: RID, size: Vector2i)

Removes specified font size from the cache entry.

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

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(font_rid: RID, size: Vector2i, index: int)

Renders specified glyph to the font cache texture.

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

Renders the range of characters to the font cache texture.

void font_set_allow_system_fallback(font_rid: RID, allow_system_fallback: bool)

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

void font_set_antialiasing(font_rid: RID, antialiasing: TextShaping.FontAntialiasing)

Sets font anti-aliasing mode.

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

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

void font_set_baseline_offset(font_rid: RID, baseline_offset: float)

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

void font_set_data(font_rid: RID, data: []u8)

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

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

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

void font_set_disable_embedded_bitmaps(font_rid: RID, disable_embedded_bitmaps: bool)

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

void font_set_embolden(font_rid: RID, strength: float)

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(font_rid: RID, face_index: int)

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

void font_set_fixed_size(font_rid: RID, fixed_size: int)

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(font_rid: RID, fixed_size_scale_mode: TextShaping.FixedSizeScaleMode)

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

void font_set_force_autohinter(font_rid: RID, force_autohinter: bool)

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

void font_set_generate_mipmaps(font_rid: RID, generate_mipmaps: bool)

If set to true font texture mipmap generation is enabled.

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

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(font_rid: RID, size: Vector2i, glyph: int, offset: Vector2)

Sets glyph offset from the baseline.

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

Sets size of the glyph.

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

Sets index of the cache texture containing the glyph.

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

Sets rectangle in the cache texture containing the glyph.

void font_set_hinting(font_rid: RID, hinting: TextShaping.Hinting)

Sets font hinting mode. Used by dynamic fonts only.

void font_set_keep_rounding_remainders(font_rid: RID, keep_rounding_remainders: bool)

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(font_rid: RID, size: int, glyph_pair: Vector2i, kerning: Vector2)

Sets kerning for the pair of glyphs.

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

Adds override for font_is_language_supported().

void font_set_modulate_color_glyphs(font_rid: RID, modulate: bool)

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(font_rid: RID, msdf_pixel_range: int)

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

void font_set_msdf_size(font_rid: RID, msdf_size: int)

Sets source font size used to generate MSDF textures.

font_set_multichannel_signed_distance_field

Section titled “font_set_multichannel_signed_distance_field”

void font_set_multichannel_signed_distance_field(font_rid: RID, msdf: bool)

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(font_rid: RID, name: String)

Sets the font family name.

void font_set_opentype_feature_overrides(font_rid: RID, overrides: Dictionary)

Sets font OpenType feature set override.

void font_set_oversampling(font_rid: RID, oversampling: float)

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_palette_custom_colors(font_rid: RID, colors: []Color)

Sets array of custom colors to override predefined palette. Set to empty array to reset overrides. Use Color(0, 0, 0, 0), to keep predefined palette color at specific position.

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

Sets scaling factor of the color bitmap font.

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

Adds override for font_is_script_supported().

void font_set_spacing(font_rid: RID, spacing: TextShaping.SpacingType, value: int)

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

void font_set_stretch(font_rid: RID, weight: int)

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(font_rid: RID, style: TextShaping.FontStyle)

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(font_rid: RID, name: String)

Sets the font style name.

void font_set_subpixel_positioning(font_rid: RID, subpixel_positioning: TextShaping.SubpixelPositioning)

Sets font subpixel glyph positioning mode.

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

Sets font cache texture image data.

void font_set_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int, offset: []i32)

Sets array containing glyph packing data.

void font_set_transform(font_rid: RID, transform: Transform2D)

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(font_rid: RID, size: int, underline_position: float)

Sets pixel offset of the underline below the baseline.

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

Sets thickness of the underline in pixels.

void font_set_used_palette(font_rid: RID, index: int)

Sets used palette index.

void font_set_variation_coordinates(font_rid: RID, variation_coordinates: Dictionary)

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

void font_set_weight(font_rid: RID, weight: int)

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(font_rid: RID) const

Returns the dictionary of the supported OpenType features.

Dictionary font_supported_variation_list(font_rid: RID) const

Returns the dictionary of the supported OpenType variation coordinates.

void free_rid(rid: RID)

Frees an object created by this TextShaping.

TextShaping get_driver() static

Returns the primary driver, the one the engine uses.

TextShaping get_driver_at(index: int) static

Returns the registered driver at index.

int get_driver_count() static

Returns the number of registered drivers.

[]Dictionary get_drivers() static

Returns a list of the registered drivers, each a Dictionary with id and name.

int get_features() const

Returns text server features, see Feature.

Vector2 get_hex_code_box_size(size: int, index: int) 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.

[]u8 get_support_data() const

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

String get_support_data_filename() const

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

String get_support_data_info() const

Returns TextShaping 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(feature: TextShaping.Feature) const

Returns true if the server supports a feature.

int is_confusable(string: String, dict: []String) 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(locale: String) const

Returns true if locale is right-to-left.

bool is_locale_using_support_data(locale: String) const

Returns true if the locale requires text server support data for line/word breaking.

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(unicode: int) 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(filename: String)

Loads optional TextShaping database (e.g. ICU break iterators and dictionaries).

Note: This function should be called before any other TextShaping functions used, otherwise it won’t have any effect.

int name_to_tag(name: String) const

Converts the given readable name of a feature, variation, script, or language to an OpenType tag.

[]Vector3i parse_structured_text(parser_type: TextShaping.StructuredTextParser, args: Array, text: String) const

Default implementation of the BiDi algorithm override function.

void remove_driver(driver: TextShaping) static

Removes a registered driver. The primary driver can’t be removed.

bool save_support_data(filename: String) const

Saves optional TextShaping database (e.g. ICU break iterators and dictionaries) to the file.

Note: This function is used by during project export, to include TextShaping database.

void set_driver(driver: TextShaping) static

Makes driver the primary driver.

int shaped_get_run_count(shaped: RID) const

Returns the number of uniform text runs in the buffer.

TextShaping.Direction shaped_get_run_direction(shaped: RID, index: int) const

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

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

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

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

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

Vector2i shaped_get_run_glyph_range(shaped: RID, index: int) const

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

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

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

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

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

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

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

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

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

int shaped_get_span_count(shaped: RID) const

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

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

Returns text embedded object key.

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

Returns text span metadata.

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

Returns the text span embedded object key.

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

Returns the text span source text.

String shaped_get_text(shaped: RID) const

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

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

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

bool shaped_text_add_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment = 5, length: int = 1, baseline: float = 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(shaped: RID, text: String, fonts: []RID, size: int, opentype_features: Dictionary = {}, language: String = "", meta: Variant = 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(shaped: RID, pos: int) const

Returns composite character position closest to the pos.

void shaped_text_draw(shaped: RID, canvas: RID, pos: Vector2, clip_l: float = -1, clip_r: float = -1, color: Color = Color(1, 1, 1, 1), oversampling: float = 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(shaped: RID, canvas: RID, pos: Vector2, clip_l: float = -1, clip_r: float = -1, outline_size: int = 1, color: Color = Color(1, 1, 1, 1), oversampling: float = 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.

RID shaped_text_duplicate(rid: RID)

Duplicates shaped text buffer.

float shaped_text_fit_to_width(shaped: RID, width: float, justification_flags: TextShaping.JustificationFlag = 3)

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

float shaped_text_get_ascent(shaped: RID) 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(shaped: RID, position: int) const

Returns shapes of the carets corresponding to the character offset position in the text. Returned caret shape is 1 pixel wide rectangle.

[]i32 shaped_text_get_character_breaks(shaped: RID) const

Returns array of the composite character boundaries.

int shaped_text_get_custom_ellipsis(shaped: RID) const

Returns ellipsis character used for text clipping.

String shaped_text_get_custom_punctuation(shaped: RID) const

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

float shaped_text_get_descent(shaped: RID) 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.

TextShaping.Direction shaped_text_get_direction(shaped: RID) const

Returns direction of the text.

shaped_text_get_dominant_direction_in_range

Section titled “shaped_text_get_dominant_direction_in_range”

TextShaping.Direction shaped_text_get_dominant_direction_in_range(shaped: RID, start: int, end: int) const

Returns dominant direction of in the range of text.

int shaped_text_get_ellipsis_glyph_count(shaped: RID) const

Returns number of glyphs in the ellipsis.

[]Dictionary shaped_text_get_ellipsis_glyphs(shaped: RID) const

Returns array of the glyphs in the ellipsis.

int shaped_text_get_ellipsis_pos(shaped: RID) const

Returns position of the ellipsis.

int shaped_text_get_glyph_count(shaped: RID) const

Returns number of glyphs in the buffer.

[]Dictionary shaped_text_get_glyphs(shaped: RID) const

Returns an array of glyphs in the visual order.

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

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

TextShaping.Direction shaped_text_get_inferred_direction(shaped: RID) const

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

[]i32 shaped_text_get_line_breaks(shaped: RID, width: float, start: int = 0, break_flags: TextShaping.LineBreakFlag = 3) const

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

[]i32 shaped_text_get_line_breaks_adv(shaped: RID, width: []f32, start: int = 0, once: bool = true, break_flags: TextShaping.LineBreakFlag = 3) const

Breaks text to the lines and columns. Returns character ranges for each segment.

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

Returns the glyph index of the inline object.

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

Returns the character range of the inline object.

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

Returns bounding rectangle of the inline object.

Array shaped_text_get_objects(shaped: RID) const

Returns array of inline objects.

TextShaping.Orientation shaped_text_get_orientation(shaped: RID) const

Returns text orientation.

RID shaped_text_get_parent(shaped: RID) const

Returns the parent buffer from which the substring originates.

bool shaped_text_get_preserve_control(shaped: RID) const

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

bool shaped_text_get_preserve_invalid(shaped: RID) 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(shaped: RID) const

Returns substring buffer character range in the parent buffer.

[]Vector2 shaped_text_get_selection(shaped: RID, start: int, end: int) const

Returns selection rectangles for the specified character range.

Vector2 shaped_text_get_size(shaped: RID) const

Returns size of the text.

int shaped_text_get_spacing(shaped: RID, spacing: TextShaping.SpacingType) const

Returns extra spacing added between glyphs or lines in pixels.

int shaped_text_get_trim_pos(shaped: RID) const

Returns the position of the overrun trim.

float shaped_text_get_underline_position(shaped: RID) const

Returns pixel offset of the underline below the baseline.

float shaped_text_get_underline_thickness(shaped: RID) const

Returns thickness of the underline.

float shaped_text_get_width(shaped: RID) const

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

[]i32 shaped_text_get_word_breaks(shaped: RID, grapheme_flags: TextShaping.GraphemeFlag = 264, skip_grapheme_flags: TextShaping.GraphemeFlag = 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_object(shaped: RID, key: Variant) const

Returns true if an object with key is embedded in this shaped text buffer.

bool shaped_text_has_visible_chars(shaped: RID) const

Returns true if text buffer contains any visible characters.

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

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

int shaped_text_hit_test_position(shaped: RID, coords: float) 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(shaped: RID) const

Returns true if buffer is successfully shaped.

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

Returns composite character end position closest to the pos.

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

Returns grapheme end position closest to the pos.

void shaped_text_overrun_trim_to_width(shaped: RID, width: float = 0, overrun_trim_flags: TextShaping.TextOverrunFlag = 0)

Trims text if it exceeds the given width.

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

Returns composite character start position closest to the pos.

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

Returns grapheme start position closest to the pos.

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

Sets new size and alignment of embedded object.

void shaped_text_set_bidi_override(shaped: RID, override: Array)

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(shaped: RID, char: int)

Sets ellipsis character used for text clipping.

void shaped_text_set_custom_punctuation(shaped: RID, punct: String)

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

void shaped_text_set_direction(shaped: RID, direction: TextShaping.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 TextShapingDriverAdvanced).

void shaped_text_set_orientation(shaped: RID, orientation: TextShaping.Orientation = 0)

Sets desired text orientation.

Note: Orientation is ignored if server does not support FEATURE_VERTICAL_LAYOUT feature (supported by TextShapingDriverAdvanced).

void shaped_text_set_preserve_control(shaped: RID, enabled: bool)

If set to true text buffer will display control characters.

void shaped_text_set_preserve_invalid(shaped: RID, enabled: bool)

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

void shaped_text_set_spacing(shaped: RID, spacing: TextShaping.SpacingType, value: int)

Sets extra spacing added between glyphs or lines in pixels.

bool shaped_text_shape(shaped: RID)

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(shaped: RID)

Returns text glyphs in the logical order.

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

Returns text buffer for the substring of the text in the shaped text buffer (including inline objects).

float shaped_text_tab_align(shaped: RID, tab_stops: []f32)

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.

[]i32 string_get_character_breaks(string: String, language: String = "") const

Returns array of the composite character boundaries.

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

[]i32 string_get_word_breaks(string: String, language: String = "", chars_per_line: int = 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.

ts : TextShaping = TextShaping.get_driver()
# Corresponds to the substrings "The", "Gobu", "Engine", and "4".
print(ts.string_get_word_breaks("The Gobu Engine, 4")) # Prints [0, 3, 4, 8, 9, 15, 17, 18]
# Corresponds to the substrings "The", "Gobu", "Engin", and "e, 4".
print(ts.string_get_word_breaks("The Gobu Engine, 4", "en", 5)) # Prints [0, 3, 4, 8, 9, 14, 14, 18]
# Corresponds to the substrings "The Gobu" and "Engine, 4".
print(ts.string_get_word_breaks("The Gobu Engine, 4", "en", 10)) # Prints [0, 8, 9, 18]

String string_to_lower(string: String, language: String = "") 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 TextShapingDriverAdvanced).

Note: The result may be longer or shorter than the original.

String string_to_title(string: String, language: String = "") 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 TextShapingDriverAdvanced).

Note: The result may be longer or shorter than the original.

String string_to_upper(string: String, language: String = "") 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 TextShapingDriverAdvanced).

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(tag: int) const

Converts the given OpenType tag to the readable name of a feature, variation, script, or language.