Class TextServerExtension

Base class for custom TextServer implementations (plugins).

Inheritance

TextServer

RefCounted

Object

TextServerExtension

Derived

TextServerAdvanced

TextServerDummy

TextServerFallback

Remarks

External TextServer implementations should inherit from this class.

Methods

_cleanup

Qualifiers: virtual

Optional.

This method is called before text server is unregistered.

void _cleanup

_create_font

Qualifiers: virtual

Required.

Creates a new, empty font cache entry resource.

RID _create_font

_create_font_linked_variation(RID)

Qualifiers: virtual

Optional, implement if font supports extra spacing or baseline offset.

Creates a new variation existing font which is reusing the same glyph cache and font data.

RID _create_font_linked_variation(RID font_rid)

Parameters

font_rid RID

_create_shaped_text(int, int)

Qualifiers: virtual

Required.

Creates a new buffer for complex text layout, with the given direction and orientation.

RID _create_shaped_text(int direction, int orientation)

Parameters

direction int

orientation int

_draw_hex_code_box(RID, int, Vector2, int, Color)

Qualifiers: virtualconst

Optional.

Draws box displaying character hexadecimal code.

void _draw_hex_code_box(RID canvas, int size, Vector2 pos, int index, Color color)

Parameters

canvas RID

size int

pos Vector2

index int

color Color

_font_clear_glyphs(RID, Vector2i)

Qualifiers: virtual

Required.

Removes all rendered glyph information from the cache entry.

void _font_clear_glyphs(RID font_rid, Vector2i size)

Parameters

font_rid RID

size Vector2i

_font_clear_kerning_map(RID, int)

Qualifiers: virtual

Optional.

Removes all kerning overrides.

void _font_clear_kerning_map(RID font_rid, int size)

Parameters

font_rid RID

size int

_font_clear_size_cache(RID)

Qualifiers: virtual

Required.

Removes all font sizes from the cache entry.

void _font_clear_size_cache(RID font_rid)

Parameters

font_rid RID

_font_clear_textures(RID, Vector2i)

Qualifiers: virtual

Required.

Removes all textures from font cache entry.

void _font_clear_textures(RID font_rid, Vector2i size)

Parameters

font_rid RID

size Vector2i

_font_draw_glyph(RID, RID, int, Vector2, int, Color)

Qualifiers: virtualconst

Required.

Draws single glyph into a canvas item at the position, using font_rid at the size size.

void _font_draw_glyph(RID font_rid, RID canvas, int size, Vector2 pos, int index, Color color)

Parameters

font_rid RID

canvas RID

size int

pos Vector2

index int

color Color

_font_draw_glyph_outline(RID, RID, int, int, Vector2, int, Color)

Qualifiers: virtualconst

Required.

Draws single glyph outline of size outline_size into a canvas item at the position, using font_rid at the size size.

void _font_draw_glyph_outline(RID font_rid, RID canvas, int size, int outline_size, Vector2 pos, int index, Color color)

Parameters

font_rid RID

canvas RID

size int

outline_size int

pos Vector2

index int

color Color

_font_get_antialiasing(RID)

Qualifiers: virtualconst

Optional.

Returns font anti-aliasing mode.

int _font_get_antialiasing(RID font_rid)

Parameters

font_rid RID

_font_get_ascent(RID, int)

Qualifiers: virtualconst

Required.

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

float _font_get_ascent(RID font_rid, int size)

Parameters

font_rid RID

size int

_font_get_baseline_offset(RID)

Qualifiers: virtualconst

Optional.

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

float _font_get_baseline_offset(RID font_rid)

Parameters

font_rid RID

_font_get_char_from_glyph_index(RID, int, int)

Qualifiers: virtualconst

Required.

Returns character code associated with glyph_index, or 0 if glyph_index is invalid.

int _font_get_char_from_glyph_index(RID font_rid, int size, int glyph_index)

Parameters

font_rid RID

size int

glyph_index int

_font_get_descent(RID, int)

Qualifiers: virtualconst

Required.

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

float _font_get_descent(RID font_rid, int size)

Parameters

font_rid RID

size int

_font_get_disable_embedded_bitmaps(RID)

Qualifiers: virtualconst

Optional.

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

bool _font_get_disable_embedded_bitmaps(RID font_rid)

Parameters

font_rid RID

_font_get_embolden(RID)

Qualifiers: virtualconst

Optional.

Returns font embolden strength.

float _font_get_embolden(RID font_rid)

Parameters

font_rid RID

_font_get_face_count(RID)

Qualifiers: virtualconst

Optional.

Returns number of faces in the TrueType / OpenType collection.

int _font_get_face_count(RID font_rid)

Parameters

font_rid RID

_font_get_face_index(RID)

Qualifiers: virtualconst

Optional.

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

int _font_get_face_index(RID font_rid)

Parameters

font_rid RID

_font_get_fixed_size(RID)

Qualifiers: virtualconst

Required.

Returns bitmap font fixed size.

int _font_get_fixed_size(RID font_rid)

Parameters

font_rid RID

_font_get_fixed_size_scale_mode(RID)

Qualifiers: virtualconst

Required.

Returns bitmap font scaling mode.

int _font_get_fixed_size_scale_mode(RID font_rid)

Parameters

font_rid RID

_font_get_generate_mipmaps(RID)

Qualifiers: virtualconst

Optional.

Returns true if font texture mipmap generation is enabled.

bool _font_get_generate_mipmaps(RID font_rid)

Parameters

font_rid RID

_font_get_global_oversampling

Qualifiers: virtualconst

Optional.

Returns the font oversampling factor, shared by all fonts in the TextServer.

float _font_get_global_oversampling

_font_get_glyph_advance(RID, int, int)

Qualifiers: virtualconst

Required.

Returns glyph advance (offset of the next glyph).

Vector2 _font_get_glyph_advance(RID font_rid, int size, int glyph)

Parameters

font_rid RID

size int

glyph int

_font_get_glyph_contours(RID, int, int)

Qualifiers: virtualconst

Optional.

Returns outline contours of the glyph.

Dictionary _font_get_glyph_contours(RID font_rid, int size, int index)

Parameters

font_rid RID

size int

index int

_font_get_glyph_index(RID, int, int, int)

Qualifiers: virtualconst

Required.

Returns the glyph index of a char, optionally modified by the variation_selector.

int _font_get_glyph_index(RID font_rid, int size, int char, int variation_selector)

Parameters

font_rid RID

size int

char int

variation_selector int

_font_get_glyph_list(RID, Vector2i)

Qualifiers: virtualconst

Required.

Returns list of rendered glyphs in the cache entry.

PackedInt32Array _font_get_glyph_list(RID font_rid, Vector2i size)

Parameters

font_rid RID

size Vector2i

_font_get_glyph_offset(RID, Vector2i, int)

Qualifiers: virtualconst

Required.

Returns glyph offset from the baseline.

Vector2 _font_get_glyph_offset(RID font_rid, Vector2i size, int glyph)

Parameters

font_rid RID

size Vector2i

glyph int

_font_get_glyph_size(RID, Vector2i, int)

Qualifiers: virtualconst

Required.

Returns size of the glyph.

Vector2 _font_get_glyph_size(RID font_rid, Vector2i size, int glyph)

Parameters

font_rid RID

size Vector2i

glyph int

_font_get_glyph_texture_idx(RID, Vector2i, int)

Qualifiers: virtualconst

Required.

Returns index of the cache texture containing the glyph.

int _font_get_glyph_texture_idx(RID font_rid, Vector2i size, int glyph)

Parameters

font_rid RID

size Vector2i

glyph int

_font_get_glyph_texture_rid(RID, Vector2i, int)

Qualifiers: virtualconst

Required.

Returns resource ID of the cache texture containing the glyph.

RID _font_get_glyph_texture_rid(RID font_rid, Vector2i size, int glyph)

Parameters

font_rid RID

size Vector2i

glyph int

_font_get_glyph_texture_size(RID, Vector2i, int)

Qualifiers: virtualconst

Required.

Returns size of the cache texture containing the glyph.

Vector2 _font_get_glyph_texture_size(RID font_rid, Vector2i size, int glyph)

Parameters

font_rid RID

size Vector2i

glyph int

_font_get_glyph_uv_rect(RID, Vector2i, int)

Qualifiers: virtualconst

Required.

Returns rectangle in the cache texture containing the glyph.

Rect2 _font_get_glyph_uv_rect(RID font_rid, Vector2i size, int glyph)

Parameters

font_rid RID

size Vector2i

glyph int

_font_get_hinting(RID)

Qualifiers: virtualconst

Optional.

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

int _font_get_hinting(RID font_rid)

Parameters

font_rid RID

_font_get_keep_rounding_remainders(RID)

Qualifiers: virtualconst

Optional.

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.

bool _font_get_keep_rounding_remainders(RID font_rid)

Parameters

font_rid RID

_font_get_kerning(RID, int, Vector2i)

Qualifiers: virtualconst

Optional.

Returns kerning for the pair of glyphs.

Vector2 _font_get_kerning(RID font_rid, int size, Vector2i glyph_pair)

Parameters

font_rid RID

size int

glyph_pair Vector2i

_font_get_kerning_list(RID, int)

Qualifiers: virtualconst

Optional.

Returns list of the kerning overrides.

Vector2i[] _font_get_kerning_list(RID font_rid, int size)

Parameters

font_rid RID

size int

_font_get_language_support_override(RID, String)

Qualifiers: virtual

Optional.

Returns true if support override is enabled for the language.

bool _font_get_language_support_override(RID font_rid, String language)

Parameters

font_rid RID

language String

_font_get_language_support_overrides(RID)

Qualifiers: virtual

Optional.

Returns list of language support overrides.

PackedStringArray _font_get_language_support_overrides(RID font_rid)

Parameters

font_rid RID

_font_get_msdf_pixel_range(RID)

Qualifiers: virtualconst

Optional.

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

int _font_get_msdf_pixel_range(RID font_rid)

Parameters

font_rid RID

_font_get_msdf_size(RID)

Qualifiers: virtualconst

Optional.

Returns source font size used to generate MSDF textures.

int _font_get_msdf_size(RID font_rid)

Parameters

font_rid RID

_font_get_name(RID)

Qualifiers: virtualconst

Optional.

Returns font family name.

String _font_get_name(RID font_rid)

Parameters

font_rid RID

_font_get_opentype_feature_overrides(RID)

Qualifiers: virtualconst

Optional.

Returns font OpenType feature set override.

Dictionary _font_get_opentype_feature_overrides(RID font_rid)

Parameters

font_rid RID

_font_get_ot_name_strings(RID)

Qualifiers: virtualconst

Optional.

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

Dictionary _font_get_ot_name_strings(RID font_rid)

Parameters

font_rid RID

_font_get_oversampling(RID)

Qualifiers: virtualconst

Optional.

Returns font oversampling factor, if set to 0.0 global oversampling factor is used instead. Used by dynamic fonts only.

float _font_get_oversampling(RID font_rid)

Parameters

font_rid RID

_font_get_scale(RID, int)

Qualifiers: virtualconst

Required.

Returns scaling factor of the color bitmap font.

float _font_get_scale(RID font_rid, int size)

Parameters

font_rid RID

size int

_font_get_script_support_override(RID, String)

Qualifiers: virtual

Optional.

Returns true if support override is enabled for the script.

bool _font_get_script_support_override(RID font_rid, String script)

Parameters

font_rid RID

script String

_font_get_script_support_overrides(RID)

Qualifiers: virtual

Optional.

Returns list of script support overrides.

PackedStringArray _font_get_script_support_overrides(RID font_rid)

Parameters

font_rid RID

_font_get_size_cache_list(RID)

Qualifiers: virtualconst

Required.

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

Vector2i[] _font_get_size_cache_list(RID font_rid)

Parameters

font_rid RID

_font_get_spacing(RID, int)

Qualifiers: virtualconst

Optional.

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

int _font_get_spacing(RID font_rid, int spacing)

Parameters

font_rid RID

spacing int

_font_get_stretch(RID)

Qualifiers: virtualconst

Optional.

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

int _font_get_stretch(RID font_rid)

Parameters

font_rid RID

_font_get_style(RID)

Qualifiers: virtualconst

Optional.

Returns font style flags, see FontStyle.

int _font_get_style(RID font_rid)

Parameters

font_rid RID

_font_get_style_name(RID)

Qualifiers: virtualconst

Optional.

Returns font style name.

String _font_get_style_name(RID font_rid)

Parameters

font_rid RID

_font_get_subpixel_positioning(RID)

Qualifiers: virtualconst

Optional.

Returns font subpixel glyph positioning mode.

int _font_get_subpixel_positioning(RID font_rid)

Parameters

font_rid RID

_font_get_supported_chars(RID)

Qualifiers: virtualconst

Required.

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

String _font_get_supported_chars(RID font_rid)

Parameters

font_rid RID

_font_get_supported_glyphs(RID)

Qualifiers: virtualconst

Required.

Returns an array containing all glyph indices in the font.

PackedInt32Array _font_get_supported_glyphs(RID font_rid)

Parameters

font_rid RID

_font_get_texture_count(RID, Vector2i)

Qualifiers: virtualconst

Required.

Returns number of textures used by font cache entry.

int _font_get_texture_count(RID font_rid, Vector2i size)

Parameters

font_rid RID

size Vector2i

_font_get_texture_image(RID, Vector2i, int)

Qualifiers: virtualconst

Required.

Returns font cache texture image data.

Image _font_get_texture_image(RID font_rid, Vector2i size, int texture_index)

Parameters

font_rid RID

size Vector2i

texture_index int

_font_get_texture_offsets(RID, Vector2i, int)

Qualifiers: virtualconst

Optional.

Returns array containing glyph packing data.

PackedInt32Array _font_get_texture_offsets(RID font_rid, Vector2i size, int texture_index)

Parameters

font_rid RID

size Vector2i

texture_index int

_font_get_transform(RID)

Qualifiers: virtualconst

Optional.

Returns 2D transform applied to the font outlines.

Transform2D _font_get_transform(RID font_rid)

Parameters

font_rid RID

_font_get_underline_position(RID, int)

Qualifiers: virtualconst

Required.

Returns pixel offset of the underline below the baseline.

float _font_get_underline_position(RID font_rid, int size)

Parameters

font_rid RID

size int

_font_get_underline_thickness(RID, int)

Qualifiers: virtualconst

Required.

Returns thickness of the underline in pixels.

float _font_get_underline_thickness(RID font_rid, int size)

Parameters

font_rid RID

size int

_font_get_variation_coordinates(RID)

Qualifiers: virtualconst

Optional.

Returns variation coordinates for the specified font cache entry.

Dictionary _font_get_variation_coordinates(RID font_rid)

Parameters

font_rid RID

_font_get_weight(RID)

Qualifiers: virtualconst

Optional.

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

int _font_get_weight(RID font_rid)

Parameters

font_rid RID

_font_has_char(RID, int)

Qualifiers: virtualconst

Required.

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

bool _font_has_char(RID font_rid, int char)

Parameters

font_rid RID

char int

_font_is_allow_system_fallback(RID)

Qualifiers: virtualconst

Optional.

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

bool _font_is_allow_system_fallback(RID font_rid)

Parameters

font_rid RID

_font_is_force_autohinter(RID)

Qualifiers: virtualconst

Optional.

Returns true if auto-hinting is supported and preferred over font built-in hinting.

bool _font_is_force_autohinter(RID font_rid)

Parameters

font_rid RID

_font_is_language_supported(RID, String)

Qualifiers: virtualconst

Optional.

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

bool _font_is_language_supported(RID font_rid, String language)

Parameters

font_rid RID

language String

_font_is_multichannel_signed_distance_field(RID)

Qualifiers: virtualconst

Optional.

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

Parameters

font_rid RID

_font_is_script_supported(RID, String)

Qualifiers: virtualconst

Optional.

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

bool _font_is_script_supported(RID font_rid, String script)

Parameters

font_rid RID

script String

_font_remove_glyph(RID, Vector2i, int)

Qualifiers: virtual

Required.

Removes specified rendered glyph information from the cache entry.

void _font_remove_glyph(RID font_rid, Vector2i size, int glyph)

Parameters

font_rid RID

size Vector2i

glyph int

_font_remove_kerning(RID, int, Vector2i)

Qualifiers: virtual

Optional.

Removes kerning override for the pair of glyphs.

void _font_remove_kerning(RID font_rid, int size, Vector2i glyph_pair)

Parameters

font_rid RID

size int

glyph_pair Vector2i

_font_remove_language_support_override(RID, String)

Qualifiers: virtual

Optional.

Remove language support override.

void _font_remove_language_support_override(RID font_rid, String language)

Parameters

font_rid RID

language String

_font_remove_script_support_override(RID, String)

Qualifiers: virtual

Optional.

Removes script support override.

void _font_remove_script_support_override(RID font_rid, String script)

Parameters

font_rid RID

script String

_font_remove_size_cache(RID, Vector2i)

Qualifiers: virtual

Required.

Removes specified font size from the cache entry.

void _font_remove_size_cache(RID font_rid, Vector2i size)

Parameters

font_rid RID

size Vector2i

_font_remove_texture(RID, Vector2i, int)

Qualifiers: virtual

Required.

Removes specified texture from the cache entry.

void _font_remove_texture(RID font_rid, Vector2i size, int texture_index)

Parameters

font_rid RID

size Vector2i

texture_index int

_font_render_glyph(RID, Vector2i, int)

Qualifiers: virtual

Optional.

Renders specified glyph to the font cache texture.

void _font_render_glyph(RID font_rid, Vector2i size, int index)

Parameters

font_rid RID

size Vector2i

index int

_font_render_range(RID, Vector2i, int, int)

Qualifiers: virtual

Optional.

Renders the range of characters to the font cache texture.

void _font_render_range(RID font_rid, Vector2i size, int start, int end)

Parameters

font_rid RID

size Vector2i

start int

end int

_font_set_allow_system_fallback(RID, bool)

Qualifiers: virtual

Optional.

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

void _font_set_allow_system_fallback(RID font_rid, bool allow_system_fallback)

Parameters

font_rid RID

allow_system_fallback bool

_font_set_antialiasing(RID, int)

Qualifiers: virtual

Optional.

Sets font anti-aliasing mode.

void _font_set_antialiasing(RID font_rid, int antialiasing)

Parameters

font_rid RID

antialiasing int

_font_set_ascent(RID, int, float)

Qualifiers: virtual

Required.

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

void _font_set_ascent(RID font_rid, int size, float ascent)

Parameters

font_rid RID

size int

ascent float

_font_set_baseline_offset(RID, float)

Qualifiers: virtual

Optional.

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

void _font_set_baseline_offset(RID font_rid, float baseline_offset)

Parameters

font_rid RID

baseline_offset float

_font_set_data(RID, PackedByteArray)

Qualifiers: virtual

Optional.

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

void _font_set_data(RID font_rid, PackedByteArray data)

Parameters

font_rid RID

data PackedByteArray

_font_set_data_ptr(RID, const uint8_t*, int)

Qualifiers: virtual

Optional.

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

void _font_set_data_ptr(RID font_rid, const uint8_t* data_ptr, int data_size)

Parameters

font_rid RID

data_ptr const uint8_t*

data_size int

_font_set_descent(RID, int, float)

Qualifiers: virtual

Required.

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

void _font_set_descent(RID font_rid, int size, float descent)

Parameters

font_rid RID

size int

descent float

_font_set_disable_embedded_bitmaps(RID, bool)

Qualifiers: virtual

Optional.

If set to true, embedded font bitmap loading is disabled.

void _font_set_disable_embedded_bitmaps(RID font_rid, bool disable_embedded_bitmaps)

Parameters

font_rid RID

disable_embedded_bitmaps bool

_font_set_embolden(RID, float)

Qualifiers: virtual

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

void _font_set_embolden(RID font_rid, float strength)

Parameters

font_rid RID

strength float

_font_set_face_index(RID, int)

Qualifiers: virtual

Optional.

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

void _font_set_face_index(RID font_rid, int face_index)

Parameters

font_rid RID

face_index int

_font_set_fixed_size(RID, int)

Qualifiers: virtual

Required.

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

Parameters

font_rid RID

fixed_size int

_font_set_fixed_size_scale_mode(RID, int)

Qualifiers: virtual

Required.

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

void _font_set_fixed_size_scale_mode(RID font_rid, int fixed_size_scale_mode)

Parameters

font_rid RID

fixed_size_scale_mode int

_font_set_force_autohinter(RID, bool)

Qualifiers: virtual

Optional.

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

void _font_set_force_autohinter(RID font_rid, bool force_autohinter)

Parameters

font_rid RID

force_autohinter bool

_font_set_generate_mipmaps(RID, bool)

Qualifiers: virtual

Optional.

If set to true font texture mipmap generation is enabled.

void _font_set_generate_mipmaps(RID font_rid, bool generate_mipmaps)

Parameters

font_rid RID

generate_mipmaps bool

_font_set_global_oversampling(float)

Qualifiers: virtual

Optional.

Sets oversampling factor, shared by all font in the TextServer.

void _font_set_global_oversampling(float oversampling)

Parameters

oversampling float

_font_set_glyph_advance(RID, int, int, Vector2)

Qualifiers: virtual

Required.

Sets glyph advance (offset of the next glyph).

void _font_set_glyph_advance(RID font_rid, int size, int glyph, Vector2 advance)

Parameters

font_rid RID

size int

glyph int

advance Vector2

_font_set_glyph_offset(RID, Vector2i, int, Vector2)

Qualifiers: virtual

Required.

Sets glyph offset from the baseline.

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

Parameters

font_rid RID

size Vector2i

glyph int

offset Vector2

_font_set_glyph_size(RID, Vector2i, int, Vector2)

Qualifiers: virtual

Required.

Sets size of the glyph.

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

Parameters

font_rid RID

size Vector2i

glyph int

gl_size Vector2

_font_set_glyph_texture_idx(RID, Vector2i, int, int)

Qualifiers: virtual

Required.

Sets index of the cache texture containing the glyph.

void _font_set_glyph_texture_idx(RID font_rid, Vector2i size, int glyph, int texture_idx)

Parameters

font_rid RID

size Vector2i

glyph int

texture_idx int

_font_set_glyph_uv_rect(RID, Vector2i, int, Rect2)

Qualifiers: virtual

Required.

Sets rectangle in the cache texture containing the glyph.

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

Parameters

font_rid RID

size Vector2i

glyph int

uv_rect Rect2

_font_set_hinting(RID, int)

Qualifiers: virtual

Optional.

Sets font hinting mode. Used by dynamic fonts only.

void _font_set_hinting(RID font_rid, int hinting)

Parameters

font_rid RID

hinting int

_font_set_keep_rounding_remainders(RID, bool)

Qualifiers: virtual

Optional.

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_keep_rounding_remainders(RID font_rid, bool keep_rounding_remainders)

Parameters

font_rid RID

keep_rounding_remainders bool

_font_set_kerning(RID, int, Vector2i, Vector2)

Qualifiers: virtual

Optional.

Sets kerning for the pair of glyphs.

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

Parameters

font_rid RID

size int

glyph_pair Vector2i

kerning Vector2

_font_set_language_support_override(RID, String, bool)

Qualifiers: virtual

Optional.

Adds override for TextServerExtension._font_is_language_supported.

void _font_set_language_support_override(RID font_rid, String language, bool supported)

Parameters

font_rid RID

language String

supported bool

_font_set_msdf_pixel_range(RID, int)

Qualifiers: virtual

Optional.

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

void _font_set_msdf_pixel_range(RID font_rid, int msdf_pixel_range)

Parameters

font_rid RID

msdf_pixel_range int

_font_set_msdf_size(RID, int)

Qualifiers: virtual

Optional.

Sets source font size used to generate MSDF textures.

void _font_set_msdf_size(RID font_rid, int msdf_size)

Parameters

font_rid RID

msdf_size int

_font_set_multichannel_signed_distance_field(RID, bool)

Qualifiers: virtual

Optional.

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.

void _font_set_multichannel_signed_distance_field(RID font_rid, bool msdf)

Parameters

font_rid RID

msdf bool

_font_set_name(RID, String)

Qualifiers: virtual

Optional.

Sets the font family name.

void _font_set_name(RID font_rid, String name)

Parameters

font_rid RID

name String

_font_set_opentype_feature_overrides(RID, Dictionary)

Qualifiers: virtual

Optional.

Sets font OpenType feature set override.

void _font_set_opentype_feature_overrides(RID font_rid, Dictionary overrides)

Parameters

font_rid RID

overrides Dictionary

_font_set_oversampling(RID, float)

Qualifiers: virtual

Optional.

Sets font oversampling factor, if set to 0.0 global oversampling factor is used instead. Used by dynamic fonts only.

void _font_set_oversampling(RID font_rid, float oversampling)

Parameters

font_rid RID

oversampling float

_font_set_scale(RID, int, float)

Qualifiers: virtual

Required.

Sets scaling factor of the color bitmap font.

void _font_set_scale(RID font_rid, int size, float scale)

Parameters

font_rid RID

size int

scale float

_font_set_script_support_override(RID, String, bool)

Qualifiers: virtual

Optional.

Adds override for TextServerExtension._font_is_script_supported.

void _font_set_script_support_override(RID font_rid, String script, bool supported)

Parameters

font_rid RID

script String

supported bool

_font_set_spacing(RID, int, int)

Qualifiers: virtual

Optional.

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

void _font_set_spacing(RID font_rid, int spacing, int value)

Parameters

font_rid RID

spacing int

value int

_font_set_stretch(RID, int)

Qualifiers: virtual

Optional.

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

void _font_set_stretch(RID font_rid, int stretch)

Parameters

font_rid RID

stretch int

_font_set_style(RID, int)

Qualifiers: virtual

Optional.

Sets the font style flags, see FontStyle.

void _font_set_style(RID font_rid, int style)

Parameters

font_rid RID

style int

_font_set_style_name(RID, String)

Qualifiers: virtual

Optional.

Sets the font style name.

void _font_set_style_name(RID font_rid, String name_style)

Parameters

font_rid RID

name_style String

_font_set_subpixel_positioning(RID, int)

Qualifiers: virtual

Optional.

Sets font subpixel glyph positioning mode.

void _font_set_subpixel_positioning(RID font_rid, int subpixel_positioning)

Parameters

font_rid RID

subpixel_positioning int

_font_set_texture_image(RID, Vector2i, int, Image)

Qualifiers: virtual

Required.

Sets font cache texture image data.

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

Parameters

font_rid RID

size Vector2i

texture_index int

image Image

_font_set_texture_offsets(RID, Vector2i, int, PackedInt32Array)

Qualifiers: virtual

Optional.

Sets array containing glyph packing data.

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

Parameters

font_rid RID

size Vector2i

texture_index int

offset PackedInt32Array

_font_set_transform(RID, Transform2D)

Qualifiers: virtual

Optional.

Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs.

void _font_set_transform(RID font_rid, Transform2D transform)

Parameters

font_rid RID

transform Transform2D

_font_set_underline_position(RID, int, float)

Qualifiers: virtual

Required.

Sets pixel offset of the underline below the baseline.

void _font_set_underline_position(RID font_rid, int size, float underline_position)

Parameters

font_rid RID

size int

underline_position float

_font_set_underline_thickness(RID, int, float)

Qualifiers: virtual

Required.

Sets thickness of the underline in pixels.

void _font_set_underline_thickness(RID font_rid, int size, float underline_thickness)

Parameters

font_rid RID

size int

underline_thickness float

_font_set_variation_coordinates(RID, Dictionary)

Qualifiers: virtual

Optional.

Sets variation coordinates for the specified font cache entry.

void _font_set_variation_coordinates(RID font_rid, Dictionary variation_coordinates)

Parameters

font_rid RID

variation_coordinates Dictionary

_font_set_weight(RID, int)

Qualifiers: virtual

Optional.

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

void _font_set_weight(RID font_rid, int weight)

Parameters

font_rid RID

weight int

_font_supported_feature_list(RID)

Qualifiers: virtualconst

Optional.

Returns the dictionary of the supported OpenType features.

Dictionary _font_supported_feature_list(RID font_rid)

Parameters

font_rid RID

_font_supported_variation_list(RID)

Qualifiers: virtualconst

Optional.

Returns the dictionary of the supported OpenType variation coordinates.

Dictionary _font_supported_variation_list(RID font_rid)

Parameters

font_rid RID

_format_number(String, String)

Qualifiers: virtualconst

Optional.

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

String _format_number(String number, String language)

Parameters

number String

language String

_free_rid(RID)

Qualifiers: virtual

Required.

Frees an object created by this TextServer.

void _free_rid(RID rid)

Parameters

rid RID

_get_features

Qualifiers: virtualconst

Required.

Returns text server features, see Feature.

int _get_features

_get_hex_code_box_size(int, int)

Qualifiers: virtualconst

Optional.

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

Vector2 _get_hex_code_box_size(int size, int index)

Parameters

size int

index int

_get_name

Qualifiers: virtualconst

Required.

Returns the name of the server interface.

String _get_name

_get_support_data

Qualifiers: virtualconst

Optional.

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

PackedByteArray _get_support_data

_get_support_data_filename

Qualifiers: virtualconst

Optional.

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

String _get_support_data_filename

_get_support_data_info

Qualifiers: virtualconst

Optional.

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

String _get_support_data_info

_has(RID)

Qualifiers: virtual

Required.

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

bool _has(RID rid)

Parameters

rid RID

_has_feature(int)

Qualifiers: virtualconst

Required.

Returns true if the server supports a feature.

bool _has_feature(int feature)

Parameters

feature int

_is_confusable(String, PackedStringArray)

Qualifiers: virtualconst

Optional.

Returns index of the first string in dict which is visually confusable with the string, or -1 if none is found.

int _is_confusable(String string, PackedStringArray dict)

Parameters

string String

dict PackedStringArray

_is_locale_right_to_left(String)

Qualifiers: virtualconst

Required.

Returns true if locale is right-to-left.

bool _is_locale_right_to_left(String locale)

Parameters

locale String

_is_valid_identifier(String)

Qualifiers: virtualconst

Optional.

Returns true if string is a valid identifier.

bool _is_valid_identifier(String string)

Parameters

string String

_is_valid_letter(int)

Qualifiers: virtualconst

bool _is_valid_letter(int unicode)

Parameters

unicode int

_load_support_data(String)

Qualifiers: virtual

Optional.

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

bool _load_support_data(String filename)

Parameters

filename String

_name_to_tag(String)

Qualifiers: virtualconst

Optional.

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

int _name_to_tag(String name)

Parameters

name String

_parse_number(String, String)

Qualifiers: virtualconst

Optional.

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

String _parse_number(String number, String language)

Parameters

number String

language String

_parse_structured_text(int, Array, String)

Qualifiers: virtualconst

Optional.

Default implementation of the BiDi algorithm override function. See StructuredTextParser for more info.

Vector3i[] _parse_structured_text(int parser_type, Array args, String text)

Parameters

parser_type int

args Array

text String

_percent_sign(String)

Qualifiers: virtualconst

Optional.

Returns percent sign used in the language.

String _percent_sign(String language)

Parameters

language String

_save_support_data(String)

Qualifiers: virtualconst

Optional.

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

bool _save_support_data(String filename)

Parameters

filename String

_shaped_get_span_count(RID)

Qualifiers: virtualconst

Required.

Returns number of text spans added using TextServerExtension._shaped_text_add_string or TextServerExtension._shaped_text_add_object.

int _shaped_get_span_count(RID shaped)

Parameters

shaped RID

_shaped_get_span_embedded_object(RID, int)

Qualifiers: virtualconst

Required.

Returns text embedded object key.

Variant _shaped_get_span_embedded_object(RID shaped, int index)

Parameters

shaped RID

index int

_shaped_get_span_meta(RID, int)

Qualifiers: virtualconst

Required.

Returns text span metadata.

Variant _shaped_get_span_meta(RID shaped, int index)

Parameters

shaped RID

index int

_shaped_set_span_update_font(RID, int, RID[], int, Dictionary)

Qualifiers: virtual

Required.

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

void _shaped_set_span_update_font(RID shaped, int index, RID[] fonts, int size, Dictionary opentype_features)

Parameters

shaped RID

index int

fonts RID[]

size int

opentype_features Dictionary

_shaped_text_add_object(RID, Variant, Vector2, int, int, float)

Qualifiers: virtual

Required.

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_object(RID shaped, Variant key, Vector2 size, int inline_align, int length, float baseline)

Parameters

shaped RID

key Variant

size Vector2

inline_align int

length int

baseline float

_shaped_text_add_string(RID, String, RID[], int, Dictionary, String, Variant)

Qualifiers: virtual

Required.

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

bool _shaped_text_add_string(RID shaped, String text, RID[] fonts, int size, Dictionary opentype_features, String language, Variant meta)

Parameters

shaped RID

text String

fonts RID[]

size int

opentype_features Dictionary

language String

meta Variant

_shaped_text_clear(RID)

Qualifiers: virtual

Required.

Clears text buffer (removes text and inline objects).

void _shaped_text_clear(RID shaped)

Parameters

shaped RID

_shaped_text_closest_character_pos(RID, int)

Qualifiers: virtualconst

Optional.

Returns composite character position closest to the pos.

int _shaped_text_closest_character_pos(RID shaped, int pos)

Parameters

shaped RID

pos int

_shaped_text_draw(RID, RID, Vector2, float, float, Color)

Qualifiers: virtualconst

Optional.

Draw shaped text into a canvas item at a given position, with color. pos specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).

void _shaped_text_draw(RID shaped, RID canvas, Vector2 pos, float clip_l, float clip_r, Color color)

Parameters

shaped RID

canvas RID

pos Vector2

clip_l float

clip_r float

color Color

_shaped_text_draw_outline(RID, RID, Vector2, float, float, int, Color)

Qualifiers: virtualconst

Optional.

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

void _shaped_text_draw_outline(RID shaped, RID canvas, Vector2 pos, float clip_l, float clip_r, int outline_size, Color color)

Parameters

shaped RID

canvas RID

pos Vector2

clip_l float

clip_r float

outline_size int

color Color

_shaped_text_fit_to_width(RID, float, int)

Qualifiers: virtual

Optional.

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

float _shaped_text_fit_to_width(RID shaped, float width, int justification_flags)

Parameters

shaped RID

width float

justification_flags int

_shaped_text_get_ascent(RID)

Qualifiers: virtualconst

Required.

Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).

float _shaped_text_get_ascent(RID shaped)

Parameters

shaped RID

_shaped_text_get_carets(RID, int, CaretInfo*)

Qualifiers: virtualconst

Optional.

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

void _shaped_text_get_carets(RID shaped, int position, CaretInfo* caret)

Parameters

shaped RID

position int

caret CaretInfo*

_shaped_text_get_character_breaks(RID)

Qualifiers: virtualconst

Optional.

Returns array of the composite character boundaries.

PackedInt32Array _shaped_text_get_character_breaks(RID shaped)

Parameters

shaped RID

_shaped_text_get_custom_ellipsis(RID)

Qualifiers: virtualconst

Optional.

Returns ellipsis character used for text clipping.

int _shaped_text_get_custom_ellipsis(RID shaped)

Parameters

shaped RID

_shaped_text_get_custom_punctuation(RID)

Qualifiers: virtualconst

Optional.

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

String _shaped_text_get_custom_punctuation(RID shaped)

Parameters

shaped RID

_shaped_text_get_descent(RID)

Qualifiers: virtualconst

Required.

Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).

float _shaped_text_get_descent(RID shaped)

Parameters

shaped RID

_shaped_text_get_direction(RID)

Qualifiers: virtualconst

Optional.

Returns direction of the text.

int _shaped_text_get_direction(RID shaped)

Parameters

shaped RID

_shaped_text_get_dominant_direction_in_range(RID, int, int)

Qualifiers: virtualconst

Optional.

Returns dominant direction of in the range of text.

int _shaped_text_get_dominant_direction_in_range(RID shaped, int start, int end)

Parameters

shaped RID

start int

end int

_shaped_text_get_ellipsis_glyph_count(RID)

Qualifiers: virtualconst

Required.

Returns number of glyphs in the ellipsis.

int _shaped_text_get_ellipsis_glyph_count(RID shaped)

Parameters

shaped RID

_shaped_text_get_ellipsis_glyphs(RID)

Qualifiers: virtualconst

Required.

Returns array of the glyphs in the ellipsis.

const Glyph* _shaped_text_get_ellipsis_glyphs(RID shaped)

Parameters

shaped RID

_shaped_text_get_ellipsis_pos(RID)

Qualifiers: virtualconst

Required.

Returns position of the ellipsis.

int _shaped_text_get_ellipsis_pos(RID shaped)

Parameters

shaped RID

_shaped_text_get_glyph_count(RID)

Qualifiers: virtualconst

Required.

Returns number of glyphs in the buffer.

int _shaped_text_get_glyph_count(RID shaped)

Parameters

shaped RID

_shaped_text_get_glyphs(RID)

Qualifiers: virtualconst

Required.

Returns an array of glyphs in the visual order.

const Glyph* _shaped_text_get_glyphs(RID shaped)

Parameters

shaped RID

_shaped_text_get_grapheme_bounds(RID, int)

Qualifiers: virtualconst

Optional.

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

Vector2 _shaped_text_get_grapheme_bounds(RID shaped, int pos)

Parameters

shaped RID

pos int

_shaped_text_get_inferred_direction(RID)

Qualifiers: virtualconst

Optional.

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

int _shaped_text_get_inferred_direction(RID shaped)

Parameters

shaped RID

_shaped_text_get_line_breaks(RID, float, int, int)

Qualifiers: virtualconst

Optional.

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

PackedInt32Array _shaped_text_get_line_breaks(RID shaped, float width, int start, int break_flags)

Parameters

shaped RID

width float

start int

break_flags int

_shaped_text_get_line_breaks_adv(RID, PackedFloat32Array, int, bool, int)

Qualifiers: virtualconst

Optional.

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

PackedInt32Array _shaped_text_get_line_breaks_adv(RID shaped, PackedFloat32Array width, int start, bool once, int break_flags)

Parameters

shaped RID

width PackedFloat32Array

start int

once bool

break_flags int

_shaped_text_get_object_glyph(RID, Variant)

Qualifiers: virtualconst

Required.

Returns the glyph index of the inline object.

int _shaped_text_get_object_glyph(RID shaped, Variant key)

Parameters

shaped RID

key Variant

_shaped_text_get_object_range(RID, Variant)

Qualifiers: virtualconst

Required.

Returns the character range of the inline object.

Vector2i _shaped_text_get_object_range(RID shaped, Variant key)

Parameters

shaped RID

key Variant

_shaped_text_get_object_rect(RID, Variant)

Qualifiers: virtualconst

Required.

Returns bounding rectangle of the inline object.

Rect2 _shaped_text_get_object_rect(RID shaped, Variant key)

Parameters

shaped RID

key Variant

_shaped_text_get_objects(RID)

Qualifiers: virtualconst

Required.

Returns array of inline objects.

Array _shaped_text_get_objects(RID shaped)

Parameters

shaped RID

_shaped_text_get_orientation(RID)

Qualifiers: virtualconst

Optional.

Returns text orientation.

int _shaped_text_get_orientation(RID shaped)

Parameters

shaped RID

_shaped_text_get_parent(RID)

Qualifiers: virtualconst

Required.

Returns the parent buffer from which the substring originates.

RID _shaped_text_get_parent(RID shaped)

Parameters

shaped RID

_shaped_text_get_preserve_control(RID)

Qualifiers: virtualconst

Optional.

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

bool _shaped_text_get_preserve_control(RID shaped)

Parameters

shaped RID

_shaped_text_get_preserve_invalid(RID)

Qualifiers: virtualconst

Optional.

Returns true if text buffer is configured to display hexadecimal codes in place of invalid characters.

bool _shaped_text_get_preserve_invalid(RID shaped)

Parameters

shaped RID

_shaped_text_get_range(RID)

Qualifiers: virtualconst

Required.

Returns substring buffer character range in the parent buffer.

Vector2i _shaped_text_get_range(RID shaped)

Parameters

shaped RID

_shaped_text_get_selection(RID, int, int)

Qualifiers: virtualconst

Optional.

Returns selection rectangles for the specified character range.

PackedVector2Array _shaped_text_get_selection(RID shaped, int start, int end)

Parameters

shaped RID

start int

end int

_shaped_text_get_size(RID)

Qualifiers: virtualconst

Required.

Returns size of the text.

Vector2 _shaped_text_get_size(RID shaped)

Parameters

shaped RID

_shaped_text_get_spacing(RID, int)

Qualifiers: virtualconst

Optional.

Returns extra spacing added between glyphs or lines in pixels.

int _shaped_text_get_spacing(RID shaped, int spacing)

Parameters

shaped RID

spacing int

_shaped_text_get_trim_pos(RID)

Qualifiers: virtualconst

Required.

Returns the position of the overrun trim.

int _shaped_text_get_trim_pos(RID shaped)

Parameters

shaped RID

_shaped_text_get_underline_position(RID)

Qualifiers: virtualconst

Required.

Returns pixel offset of the underline below the baseline.

float _shaped_text_get_underline_position(RID shaped)

Parameters

shaped RID

_shaped_text_get_underline_thickness(RID)

Qualifiers: virtualconst

Required.

Returns thickness of the underline.

float _shaped_text_get_underline_thickness(RID shaped)

Parameters

shaped RID

_shaped_text_get_width(RID)

Qualifiers: virtualconst

Required.

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

float _shaped_text_get_width(RID shaped)

Parameters

shaped RID

_shaped_text_get_word_breaks(RID, int, int)

Qualifiers: virtualconst

Optional.

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

PackedInt32Array _shaped_text_get_word_breaks(RID shaped, int grapheme_flags, int skip_grapheme_flags)

Parameters

shaped RID

grapheme_flags int

skip_grapheme_flags int

_shaped_text_hit_test_grapheme(RID, float)

Qualifiers: virtualconst

Optional.

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

int _shaped_text_hit_test_grapheme(RID shaped, float coord)

Parameters

shaped RID

coord float

_shaped_text_hit_test_position(RID, float)

Qualifiers: virtualconst

Optional.

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

int _shaped_text_hit_test_position(RID shaped, float coord)

Parameters

shaped RID

coord float

_shaped_text_is_ready(RID)

Qualifiers: virtualconst

Required.

Returns true if buffer is successfully shaped.

bool _shaped_text_is_ready(RID shaped)

Parameters

shaped RID

_shaped_text_next_character_pos(RID, int)

Qualifiers: virtualconst

Optional.

Returns composite character end position closest to the pos.

int _shaped_text_next_character_pos(RID shaped, int pos)

Parameters

shaped RID

pos int

_shaped_text_next_grapheme_pos(RID, int)

Qualifiers: virtualconst

Optional.

Returns grapheme end position closest to the pos.

int _shaped_text_next_grapheme_pos(RID shaped, int pos)

Parameters

shaped RID

pos int

_shaped_text_overrun_trim_to_width(RID, float, int)

Qualifiers: virtual

Optional.

Trims text if it exceeds the given width.

void _shaped_text_overrun_trim_to_width(RID shaped, float width, int trim_flags)

Parameters

shaped RID

width float

trim_flags int

_shaped_text_prev_character_pos(RID, int)

Qualifiers: virtualconst

Optional.

Returns composite character start position closest to the pos.

int _shaped_text_prev_character_pos(RID shaped, int pos)

Parameters

shaped RID

pos int

_shaped_text_prev_grapheme_pos(RID, int)

Qualifiers: virtualconst

Optional.

Returns grapheme start position closest to the pos.

int _shaped_text_prev_grapheme_pos(RID shaped, int pos)

Parameters

shaped RID

pos int

_shaped_text_resize_object(RID, Variant, Vector2, int, float)

Qualifiers: virtual

Required.

Sets new size and alignment of embedded object.

bool _shaped_text_resize_object(RID shaped, Variant key, Vector2 size, int inline_align, float baseline)

Parameters

shaped RID

key Variant

size Vector2

inline_align int

baseline float

_shaped_text_set_bidi_override(RID, Array)

Qualifiers: virtual

Optional.

Overrides BiDi for the structured text.

void _shaped_text_set_bidi_override(RID shaped, Array override)

Parameters

shaped RID

override Array

_shaped_text_set_custom_ellipsis(RID, int)

Qualifiers: virtual

Optional.

Sets ellipsis character used for text clipping.

void _shaped_text_set_custom_ellipsis(RID shaped, int char)

Parameters

shaped RID

char int

_shaped_text_set_custom_punctuation(RID, String)

Qualifiers: virtual

Optional.

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

void _shaped_text_set_custom_punctuation(RID shaped, String punct)

Parameters

shaped RID

punct String

_shaped_text_set_direction(RID, int)

Qualifiers: virtual

Optional.

Sets desired text direction. If set to TextServer.DIRECTION_AUTO, direction will be detected based on the buffer contents and current locale.

void _shaped_text_set_direction(RID shaped, int direction)

Parameters

shaped RID

direction int

_shaped_text_set_orientation(RID, int)

Qualifiers: virtual

Optional.

Sets desired text orientation.

void _shaped_text_set_orientation(RID shaped, int orientation)

Parameters

shaped RID

orientation int

_shaped_text_set_preserve_control(RID, bool)

Qualifiers: virtual

Optional.

If set to true text buffer will display control characters.

void _shaped_text_set_preserve_control(RID shaped, bool enabled)

Parameters

shaped RID

enabled bool

_shaped_text_set_preserve_invalid(RID, bool)

Qualifiers: virtual

Optional.

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

void _shaped_text_set_preserve_invalid(RID shaped, bool enabled)

Parameters

shaped RID

enabled bool

_shaped_text_set_spacing(RID, int, int)

Qualifiers: virtual

Optional.

Sets extra spacing added between glyphs or lines in pixels.

void _shaped_text_set_spacing(RID shaped, int spacing, int value)

Parameters

shaped RID

spacing int

value int

_shaped_text_shape(RID)

Qualifiers: virtual

Required.

Shapes buffer if it's not shaped. Returns true if the string is shaped successfully.

bool _shaped_text_shape(RID shaped)

Parameters

shaped RID

_shaped_text_sort_logical(RID)

Qualifiers: virtual

Required.

Returns text glyphs in the logical order.

const Glyph* _shaped_text_sort_logical(RID shaped)

Parameters

shaped RID

_shaped_text_substr(RID, int, int)

Qualifiers: virtualconst

Required.

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

RID _shaped_text_substr(RID shaped, int start, int length)

Parameters

shaped RID

start int

length int

_shaped_text_tab_align(RID, PackedFloat32Array)

Qualifiers: virtual

Optional.

Aligns shaped text to the given tab-stops.

float _shaped_text_tab_align(RID shaped, PackedFloat32Array tab_stops)

Parameters

shaped RID

tab_stops PackedFloat32Array

_shaped_text_update_breaks(RID)

Qualifiers: virtual

Optional.

Updates break points in the shaped text. This method is called by default implementation of text breaking functions.

bool _shaped_text_update_breaks(RID shaped)

Parameters

shaped RID

_shaped_text_update_justification_ops(RID)

Qualifiers: virtual

Optional.

Updates justification points in the shaped text. This method is called by default implementation of text justification functions.

bool _shaped_text_update_justification_ops(RID shaped)

Parameters

shaped RID

_spoof_check(String)

Qualifiers: virtualconst

Optional.

Returns true if string is likely to be an attempt at confusing the reader.

bool _spoof_check(String string)

Parameters

string String

_string_get_character_breaks(String, String)

Qualifiers: virtualconst

Optional.

Returns array of the composite character boundaries.

PackedInt32Array _string_get_character_breaks(String string, String language)

Parameters

string String

language String

_string_get_word_breaks(String, String, int)

Qualifiers: virtualconst

Optional.

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.

PackedInt32Array _string_get_word_breaks(String string, String language, int chars_per_line)

Parameters

string String

language String

chars_per_line int

_string_to_lower(String, String)

Qualifiers: virtualconst

Optional.

Returns the string converted to lowercase.

String _string_to_lower(String string, String language)

Parameters

string String

language String

_string_to_title(String, String)

Qualifiers: virtualconst

Optional.

Returns the string converted to title case.

String _string_to_title(String string, String language)

Parameters

string String

language String

_string_to_upper(String, String)

Qualifiers: virtualconst

Optional.

Returns the string converted to uppercase.

String _string_to_upper(String string, String language)

Parameters

string String

language String

_strip_diacritics(String)

Qualifiers: virtualconst

Optional.

Strips diacritics from the string.

String _strip_diacritics(String string)

Parameters

string String

_tag_to_name(int)

Qualifiers: virtualconst

Optional.

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

String _tag_to_name(int tag)

Parameters

tag int