Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

TextServerExtension

Inherits: TextServer < RefCounted < Object

Inherited By: TextServerAdvanced, TextServerDummy, TextServerFallback

Base class for TextServer custom implementations (plugins).

Description

External TextServer implementations should inherit from this class.

Methods

void	_cleanup ( ) virtual
RID	_create_font ( ) virtual
RID	_create_shaped_text ( Direction direction, Orientation orientation ) virtual
void	_draw_hex_code_box ( RID canvas, int size, Vector2 pos, int index, Color color ) virtual const
void	_font_clear_glyphs ( RID font_rid, Vector2i size ) virtual
void	_font_clear_kerning_map ( RID font_rid, int size ) virtual
void	_font_clear_size_cache ( RID font_rid ) virtual
void	_font_clear_textures ( RID font_rid, Vector2i size ) virtual
void	_font_draw_glyph ( RID font_rid, RID canvas, int size, Vector2 pos, int index, Color color ) virtual const
void	_font_draw_glyph_outline ( RID font_rid, RID canvas, int size, int outline_size, Vector2 pos, int index, Color color ) virtual const
FontAntialiasing	_font_get_antialiasing ( RID font_rid ) virtual const
float	_font_get_ascent ( RID font_rid, int size ) virtual const
float	_font_get_descent ( RID font_rid, int size ) virtual const
float	_font_get_embolden ( RID font_rid ) virtual const
int	_font_get_face_count ( RID font_rid ) virtual const
int	_font_get_face_index ( RID font_rid ) virtual const
int	_font_get_fixed_size ( RID font_rid ) virtual const
bool	_font_get_generate_mipmaps ( RID font_rid ) virtual const
float	_font_get_global_oversampling ( ) virtual const
Vector2	_font_get_glyph_advance ( RID font_rid, int size, int glyph ) virtual const
Dictionary	_font_get_glyph_contours ( RID font_rid, int size, int index ) virtual const
int	_font_get_glyph_index ( RID font_rid, int size, int char, int variation_selector ) virtual const
PackedInt32Array	_font_get_glyph_list ( RID font_rid, Vector2i size ) virtual const
Vector2	_font_get_glyph_offset ( RID font_rid, Vector2i size, int glyph ) virtual const
Vector2	_font_get_glyph_size ( RID font_rid, Vector2i size, int glyph ) virtual const
int	_font_get_glyph_texture_idx ( RID font_rid, Vector2i size, int glyph ) virtual const
RID	_font_get_glyph_texture_rid ( RID font_rid, Vector2i size, int glyph ) virtual const
Vector2	_font_get_glyph_texture_size ( RID font_rid, Vector2i size, int glyph ) virtual const
Rect2	_font_get_glyph_uv_rect ( RID font_rid, Vector2i size, int glyph ) virtual const
Hinting	_font_get_hinting ( RID font_rid ) virtual const
Vector2	_font_get_kerning ( RID font_rid, int size, Vector2i glyph_pair ) virtual const
Vector2i[]	_font_get_kerning_list ( RID font_rid, int size ) virtual const
bool	_font_get_language_support_override ( RID font_rid, String language ) virtual
PackedStringArray	_font_get_language_support_overrides ( RID font_rid ) virtual
int	_font_get_msdf_pixel_range ( RID font_rid ) virtual const
int	_font_get_msdf_size ( RID font_rid ) virtual const
String	_font_get_name ( RID font_rid ) virtual const
Dictionary	_font_get_opentype_feature_overrides ( RID font_rid ) virtual const
float	_font_get_oversampling ( RID font_rid ) virtual const
float	_font_get_scale ( RID font_rid, int size ) virtual const
bool	_font_get_script_support_override ( RID font_rid, String script ) virtual
PackedStringArray	_font_get_script_support_overrides ( RID font_rid ) virtual
Vector2i[]	_font_get_size_cache_list ( RID font_rid ) virtual const
int	_font_get_stretch ( RID font_rid ) virtual const
FontStyle	_font_get_style ( RID font_rid ) virtual const
String	_font_get_style_name ( RID font_rid ) virtual const
SubpixelPositioning	_font_get_subpixel_positioning ( RID font_rid ) virtual const
String	_font_get_supported_chars ( RID font_rid ) virtual const
int	_font_get_texture_count ( RID font_rid, Vector2i size ) virtual const
Image	_font_get_texture_image ( RID font_rid, Vector2i size, int texture_index ) virtual const
PackedInt32Array	_font_get_texture_offsets ( RID font_rid, Vector2i size, int texture_index ) virtual const
Transform2D	_font_get_transform ( RID font_rid ) virtual const
float	_font_get_underline_position ( RID font_rid, int size ) virtual const
float	_font_get_underline_thickness ( RID font_rid, int size ) virtual const
Dictionary	_font_get_variation_coordinates ( RID font_rid ) virtual const
int	_font_get_weight ( RID font_rid ) virtual const
bool	_font_has_char ( RID font_rid, int char ) virtual const
bool	_font_is_allow_system_fallback ( RID font_rid ) virtual const
bool	_font_is_force_autohinter ( RID font_rid ) virtual const
bool	_font_is_language_supported ( RID font_rid, String language ) virtual const
bool	_font_is_multichannel_signed_distance_field ( RID font_rid ) virtual const
bool	_font_is_script_supported ( RID font_rid, String script ) virtual const
void	_font_remove_glyph ( RID font_rid, Vector2i size, int glyph ) virtual
void	_font_remove_kerning ( RID font_rid, int size, Vector2i glyph_pair ) virtual
void	_font_remove_language_support_override ( RID font_rid, String language ) virtual
void	_font_remove_script_support_override ( RID font_rid, String script ) virtual
void	_font_remove_size_cache ( RID font_rid, Vector2i size ) virtual
void	_font_remove_texture ( RID font_rid, Vector2i size, int texture_index ) virtual
void	_font_render_glyph ( RID font_rid, Vector2i size, int index ) virtual
void	_font_render_range ( RID font_rid, Vector2i size, int start, int end ) virtual
void	_font_set_allow_system_fallback ( RID font_rid, bool allow_system_fallback ) virtual
void	_font_set_antialiasing ( RID font_rid, FontAntialiasing antialiasing ) virtual
void	_font_set_ascent ( RID font_rid, int size, float ascent ) virtual
void	_font_set_data ( RID font_rid, PackedByteArray data ) virtual
void	_font_set_data_ptr ( RID font_rid, const uint8_t* data_ptr, int data_size ) virtual
void	_font_set_descent ( RID font_rid, int size, float descent ) virtual
void	_font_set_embolden ( RID font_rid, float strength ) virtual
void	_font_set_face_index ( RID font_rid, int face_index ) virtual
void	_font_set_fixed_size ( RID font_rid, int fixed_size ) virtual
void	_font_set_force_autohinter ( RID font_rid, bool force_autohinter ) virtual
void	_font_set_generate_mipmaps ( RID font_rid, bool generate_mipmaps ) virtual
void	_font_set_global_oversampling ( float oversampling ) virtual
void	_font_set_glyph_advance ( RID font_rid, int size, int glyph, Vector2 advance ) virtual
void	_font_set_glyph_offset ( RID font_rid, Vector2i size, int glyph, Vector2 offset ) virtual
void	_font_set_glyph_size ( RID font_rid, Vector2i size, int glyph, Vector2 gl_size ) virtual
void	_font_set_glyph_texture_idx ( RID font_rid, Vector2i size, int glyph, int texture_idx ) virtual
void	_font_set_glyph_uv_rect ( RID font_rid, Vector2i size, int glyph, Rect2 uv_rect ) virtual
void	_font_set_hinting ( RID font_rid, Hinting hinting ) virtual
void	_font_set_kerning ( RID font_rid, int size, Vector2i glyph_pair, Vector2 kerning ) virtual
void	_font_set_language_support_override ( RID font_rid, String language, bool supported ) virtual
void	_font_set_msdf_pixel_range ( RID font_rid, int msdf_pixel_range ) virtual
void	_font_set_msdf_size ( RID font_rid, int msdf_size ) virtual
void	_font_set_multichannel_signed_distance_field ( RID font_rid, bool msdf ) virtual
void	_font_set_name ( RID font_rid, String name ) virtual
void	_font_set_opentype_feature_overrides ( RID font_rid, Dictionary overrides ) virtual
void	_font_set_oversampling ( RID font_rid, float oversampling ) virtual
void	_font_set_scale ( RID font_rid, int size, float scale ) virtual
void	_font_set_script_support_override ( RID font_rid, String script, bool supported ) virtual
void	_font_set_stretch ( RID font_rid, int stretch ) virtual
void	_font_set_style ( RID font_rid, FontStyle style ) virtual
void	_font_set_style_name ( RID font_rid, String name_style ) virtual
void	_font_set_subpixel_positioning ( RID font_rid, SubpixelPositioning subpixel_positioning ) virtual
void	_font_set_texture_image ( RID font_rid, Vector2i size, int texture_index, Image image ) virtual
void	_font_set_texture_offsets ( RID font_rid, Vector2i size, int texture_index, PackedInt32Array offset ) virtual
void	_font_set_transform ( RID font_rid, Transform2D transform ) virtual
void	_font_set_underline_position ( RID font_rid, int size, float underline_position ) virtual
void	_font_set_underline_thickness ( RID font_rid, int size, float underline_thickness ) virtual
void	_font_set_variation_coordinates ( RID font_rid, Dictionary variation_coordinates ) virtual
void	_font_set_weight ( RID font_rid, int weight ) virtual
Dictionary	_font_supported_feature_list ( RID font_rid ) virtual const
Dictionary	_font_supported_variation_list ( RID font_rid ) virtual const
String	_format_number ( String string, String language ) virtual const
void	_free_rid ( RID rid ) virtual
int	_get_features ( ) virtual const
Vector2	_get_hex_code_box_size ( int size, int index ) virtual const
String	_get_name ( ) virtual const
String	_get_support_data_filename ( ) virtual const
String	_get_support_data_info ( ) virtual const
bool	_has ( RID rid ) virtual
bool	_has_feature ( Feature feature ) virtual const
int	_is_confusable ( String string, PackedStringArray dict ) virtual const
bool	_is_locale_right_to_left ( String locale ) virtual const
bool	_is_valid_identifier ( String string ) virtual const
bool	_load_support_data ( String filename ) virtual
int	_name_to_tag ( String name ) virtual const
String	_parse_number ( String string, String language ) virtual const
Vector3i[]	_parse_structured_text ( StructuredTextParser parser_type, Array args, String text ) virtual const
String	_percent_sign ( String language ) virtual const
bool	_save_support_data ( String filename ) virtual const
int	_shaped_get_span_count ( RID shaped ) virtual const
Variant	_shaped_get_span_meta ( RID shaped, int index ) virtual const
void	_shaped_set_span_update_font ( RID shaped, int index, RID[] fonts, int size, Dictionary opentype_features ) virtual
bool	_shaped_text_add_object ( RID shaped, Variant key, Vector2 size, InlineAlignment inline_align, int length, float baseline ) virtual
bool	_shaped_text_add_string ( RID shaped, String text, RID[] fonts, int size, Dictionary opentype_features, String language, Variant meta ) virtual
void