mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
classref: Sync with current master branch (46a568e0a)
This commit is contained in:
Rémi Verschelde
+145
-33
@@ -43,6 +43,8 @@ Methods
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`font_draw_glyph_outline<class_TextServer_method_font_draw_glyph_outline>` **(** :ref:`RID<class_RID>` font_rid, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`int<class_int>` outline_size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` | :ref:`font_get_antialiasing<class_TextServer_method_font_get_antialiasing>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`font_get_ascent<class_TextServer_method_font_get_ascent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`font_get_descent<class_TextServer_method_font_get_descent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
|
||||
@@ -65,7 +67,7 @@ Methods
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` char, :ref:`int<class_int>` variation_selector **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`font_get_glyph_list<class_TextServer_method_font_get_glyph_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const| |
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_glyph_list<class_TextServer_method_font_get_glyph_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_offset<class_TextServer_method_font_get_glyph_offset>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -83,7 +85,7 @@ Methods
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`font_get_kerning<class_TextServer_method_font_get_kerning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`font_get_kerning_list<class_TextServer_method_font_get_kerning_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
|
||||
| :ref:`Vector2i[]<class_Vector2i>` | :ref:`font_get_kerning_list<class_TextServer_method_font_get_kerning_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`font_get_language_support_override<class_TextServer_method_font_get_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -105,7 +107,7 @@ Methods
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_script_support_overrides<class_TextServer_method_font_get_script_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`font_get_size_cache_list<class_TextServer_method_font_get_size_cache_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
|
||||
| :ref:`Vector2i[]<class_Vector2i>` | :ref:`font_get_size_cache_list<class_TextServer_method_font_get_size_cache_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`FontStyle<enum_TextServer_FontStyle>` | :ref:`font_get_style<class_TextServer_method_font_get_style>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -131,8 +133,6 @@ Methods
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`font_has_char<class_TextServer_method_font_has_char>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`font_is_antialiased<class_TextServer_method_font_is_antialiased>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`font_is_force_autohinter<class_TextServer_method_font_is_force_autohinter>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |const| |
|
||||
@@ -157,7 +157,7 @@ Methods
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`font_render_range<class_TextServer_method_font_render_range>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`font_set_antialiased<class_TextServer_method_font_set_antialiased>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` antialiased **)** |
|
||||
| void | :ref:`font_set_antialiasing<class_TextServer_method_font_set_antialiasing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)** |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`font_set_ascent<class_TextServer_method_font_set_ascent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)** |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -249,15 +249,19 @@ Methods
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_feature<class_TextServer_method_has_feature>` **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`is_confusable<class_TextServer_method_is_confusable>` **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_locale_right_to_left<class_TextServer_method_is_locale_right_to_left>` **(** :ref:`String<class_String>` locale **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>` **(** :ref:`String<class_String>` string **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`load_support_data<class_TextServer_method_load_support_data>` **(** :ref:`String<class_String>` filename **)** |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`name_to_tag<class_TextServer_method_name_to_tag>` **(** :ref:`String<class_String>` name **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`parse_number<class_TextServer_method_parse_number>` **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`parse_structured_text<class_TextServer_method_parse_structured_text>` **(** :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser_type, :ref:`Array<class_Array>` args, :ref:`String<class_String>` text **)** |const| |
|
||||
| :ref:`Vector2i[]<class_Vector2i>` | :ref:`parse_structured_text<class_TextServer_method_parse_structured_text>` **(** :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser_type, :ref:`Array<class_Array>` args, :ref:`String<class_String>` text **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`percent_sign<class_TextServer_method_percent_sign>` **(** :ref:`String<class_String>` language="" **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -295,13 +299,13 @@ Methods
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_glyph_count<class_TextServer_method_shaped_text_get_ellipsis_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`shaped_text_get_ellipsis_glyphs<class_TextServer_method_shaped_text_get_ellipsis_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
|
||||
| :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_ellipsis_glyphs<class_TextServer_method_shaped_text_get_ellipsis_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
|
||||
| :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_grapheme_bounds<class_TextServer_method_shaped_text_get_grapheme_bounds>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -371,12 +375,14 @@ Methods
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>` **(** :ref:`RID<class_RID>` shaped **)** |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`shaped_text_sort_logical<class_TextServer_method_shaped_text_sort_logical>` **(** :ref:`RID<class_RID>` shaped **)** |
|
||||
| :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_sort_logical<class_TextServer_method_shaped_text_sort_logical>` **(** :ref:`RID<class_RID>` shaped **)** |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`shaped_text_substr<class_TextServer_method_shaped_text_substr>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`shaped_text_tab_align<class_TextServer_method_shaped_text_tab_align>` **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)** |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>` **(** :ref:`String<class_String>` string **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`string_get_word_breaks<class_TextServer_method_string_get_word_breaks>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const| |
|
||||
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`string_to_lower<class_TextServer_method_string_to_lower>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const| |
|
||||
@@ -391,6 +397,54 @@ Methods
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_TextServer_FontAntialiasing:
|
||||
|
||||
.. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
|
||||
|
||||
.. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
|
||||
|
||||
.. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
|
||||
|
||||
enum **FontAntialiasing**:
|
||||
|
||||
- **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 sub-pixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings.
|
||||
|
||||
LCD sub-pixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_TextServer_FontLCDSubpixelLayout:
|
||||
|
||||
.. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
|
||||
|
||||
.. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
|
||||
|
||||
.. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
|
||||
|
||||
.. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
|
||||
|
||||
.. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
|
||||
|
||||
enum **FontLCDSubpixelLayout**:
|
||||
|
||||
- **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = **0** --- Unknown or unsupported sub-pixel layout, LCD sub-pixel anti-aliasing is disabled.
|
||||
|
||||
- **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = **1** --- Horizontal RGB sub-pixel layout.
|
||||
|
||||
- **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = **2** --- Horizontal BGR sub-pixel layout.
|
||||
|
||||
- **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = **3** --- Vertical RGB sub-pixel layout.
|
||||
|
||||
- **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = **4** --- Vertical BGR sub-pixel layout.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_TextServer_Direction:
|
||||
|
||||
.. _class_TextServer_constant_DIRECTION_AUTO:
|
||||
@@ -521,11 +575,11 @@ enum **VisibleCharactersBehavior**:
|
||||
|
||||
- **VC_CHARS_AFTER_SHAPING** = **1** --- Displays glyphs that are mapped to the first :ref:`Label.visible_characters<class_Label_property_visible_characters>` or :ref:`RichTextLabel.visible_characters<class_RichTextLabel_property_visible_characters>` characters from the beginning of the text.
|
||||
|
||||
- **VC_GLYPHS_AUTO** = **2** --- Displays :ref:`Label.percent_visible<class_Label_property_percent_visible>` or :ref:`RichTextLabel.percent_visible<class_RichTextLabel_property_percent_visible>` glyphs, starting from the left or from the right, depending on :ref:`Control.layout_direction<class_Control_property_layout_direction>` value.
|
||||
- **VC_GLYPHS_AUTO** = **2** --- Displays :ref:`Label.visible_ratio<class_Label_property_visible_ratio>` or :ref:`RichTextLabel.visible_ratio<class_RichTextLabel_property_visible_ratio>` glyphs, starting from the left or from the right, depending on :ref:`Control.layout_direction<class_Control_property_layout_direction>` value.
|
||||
|
||||
- **VC_GLYPHS_LTR** = **3** --- Displays :ref:`Label.percent_visible<class_Label_property_percent_visible>` or :ref:`RichTextLabel.percent_visible<class_RichTextLabel_property_percent_visible>` glyphs, starting from the left.
|
||||
- **VC_GLYPHS_LTR** = **3** --- Displays :ref:`Label.visible_ratio<class_Label_property_visible_ratio>` or :ref:`RichTextLabel.visible_ratio<class_RichTextLabel_property_visible_ratio>` glyphs, starting from the left.
|
||||
|
||||
- **VC_GLYPHS_RTL** = **4** --- Displays :ref:`Label.percent_visible<class_Label_property_percent_visible>` or :ref:`RichTextLabel.percent_visible<class_RichTextLabel_property_percent_visible>` glyphs, starting from the right.
|
||||
- **VC_GLYPHS_RTL** = **4** --- Displays :ref:`Label.visible_ratio<class_Label_property_visible_ratio>` or :ref:`RichTextLabel.visible_ratio<class_RichTextLabel_property_visible_ratio>` glyphs, starting from the right.
|
||||
|
||||
----
|
||||
|
||||
@@ -609,6 +663,8 @@ flags **TextOverrunFlag**:
|
||||
|
||||
.. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
|
||||
|
||||
.. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
|
||||
|
||||
flags **GraphemeFlag**:
|
||||
|
||||
- **GRAPHEME_IS_VALID** = **1** --- Grapheme is supported by the font, and can be drawn.
|
||||
@@ -633,6 +689,8 @@ flags **GraphemeFlag**:
|
||||
|
||||
- **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.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_TextServer_Hinting:
|
||||
@@ -717,6 +775,10 @@ enum **SubpixelPositioning**:
|
||||
|
||||
.. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
|
||||
|
||||
.. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
|
||||
|
||||
.. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
|
||||
|
||||
enum **Feature**:
|
||||
|
||||
- **FEATURE_SIMPLE_LAYOUT** = **1** --- TextServer supports simple text layouts.
|
||||
@@ -743,7 +805,11 @@ enum **Feature**:
|
||||
|
||||
- **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = **2048** --- TextServer supports locale dependent and context sensitive case conversion.
|
||||
|
||||
- **FEATURE_USE_SUPPORT_DATA** = **4096** --- TextServer require external data file for some features.
|
||||
- **FEATURE_USE_SUPPORT_DATA** = **4096** --- TextServer require external data file for some features, see :ref:`load_support_data<class_TextServer_method_load_support_data>`.
|
||||
|
||||
- **FEATURE_UNICODE_IDENTIFIERS** = **8192** --- TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`.
|
||||
|
||||
- **FEATURE_UNICODE_SECURITY** = **16384** --- TextServer supports `Unicode Technical Report #36 <https://unicode.org/reports/tr36/>`__ and `Unicode Technical Standard #39 <https://unicode.org/reports/tr39/>`__ based spoof detection features.
|
||||
|
||||
----
|
||||
|
||||
@@ -934,6 +1000,14 @@ Draws single glyph outline of size ``outline_size`` into a canvas item at the po
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_font_get_antialiasing:
|
||||
|
||||
- :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing** **(** :ref:`RID<class_RID>` font_rid **)** |const|
|
||||
|
||||
Returns font anti-aliasing mode.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_font_get_ascent:
|
||||
|
||||
- :ref:`float<class_float>` **font_get_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
|
||||
@@ -1032,7 +1106,7 @@ Returns the glyph index of a ``char``, optionally modified by the ``variation_se
|
||||
|
||||
.. _class_TextServer_method_font_get_glyph_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **font_get_glyph_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_glyph_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
|
||||
|
||||
Returns list of rendered glyphs in the cache entry.
|
||||
|
||||
@@ -1108,7 +1182,7 @@ Returns kerning for the pair of glyphs.
|
||||
|
||||
.. _class_TextServer_method_font_get_kerning_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **font_get_kerning_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
|
||||
- :ref:`Vector2i[]<class_Vector2i>` **font_get_kerning_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
|
||||
|
||||
Returns list of the kerning overrides.
|
||||
|
||||
@@ -1196,7 +1270,7 @@ Returns list of script support overrides.
|
||||
|
||||
.. _class_TextServer_method_font_get_size_cache_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **font_get_size_cache_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
|
||||
- :ref:`Vector2i[]<class_Vector2i>` **font_get_size_cache_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
|
||||
|
||||
Returns list of the font sizes in the cache. Each size is ``Vector2i`` with font size and outline size.
|
||||
|
||||
@@ -1298,14 +1372,6 @@ Returns ``true`` if a Unicode ``char`` is available in the font.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_font_is_antialiased:
|
||||
|
||||
- :ref:`bool<class_bool>` **font_is_antialiased** **(** :ref:`RID<class_RID>` font_rid **)** |const|
|
||||
|
||||
Returns ``true`` if font 8-bit anitialiased glyph rendering is supported and enabled.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_font_is_force_autohinter:
|
||||
|
||||
- :ref:`bool<class_bool>` **font_is_force_autohinter** **(** :ref:`RID<class_RID>` font_rid **)** |const|
|
||||
@@ -1406,11 +1472,11 @@ Renders the range of characters to the font cache texture.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_font_set_antialiased:
|
||||
.. _class_TextServer_method_font_set_antialiasing:
|
||||
|
||||
- void **font_set_antialiased** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` antialiased **)**
|
||||
- void **font_set_antialiasing** **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)**
|
||||
|
||||
If set to ``true``, 8-bit antialiased glyph rendering is used, otherwise 1-bit rendering is used. Used by dynamic fonts only.
|
||||
Sets font anti-aliasing mode.
|
||||
|
||||
----
|
||||
|
||||
@@ -1782,6 +1848,18 @@ Returns ``true`` if the server supports a feature.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_is_confusable:
|
||||
|
||||
- :ref:`int<class_int>` **is_confusable** **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const|
|
||||
|
||||
Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
|
||||
|
||||
\ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check<class_TextServer_method_spoof_check>`.
|
||||
|
||||
\ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_is_locale_right_to_left:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_locale_right_to_left** **(** :ref:`String<class_String>` locale **)** |const|
|
||||
@@ -1790,6 +1868,30 @@ Returns ``true`` if locale is right-to-left.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_is_valid_identifier:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_valid_identifier** **(** :ref:`String<class_String>` string **)** |const|
|
||||
|
||||
Returns ``true`` is ``string`` is a valid identifier.
|
||||
|
||||
If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_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 :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_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.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_load_support_data:
|
||||
|
||||
- :ref:`bool<class_bool>` **load_support_data** **(** :ref:`String<class_String>` filename **)**
|
||||
@@ -1812,13 +1914,13 @@ Converts readable feature, variation, script or language name to OpenType tag.
|
||||
|
||||
- :ref:`String<class_String>` **parse_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
|
||||
|
||||
Converts a number from the numeral systems used in ``language`` to Western Arabic (0..9).
|
||||
Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_parse_structured_text:
|
||||
|
||||
- :ref:`Array<class_Array>` **parse_structured_text** **(** :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser_type, :ref:`Array<class_Array>` args, :ref:`String<class_String>` text **)** |const|
|
||||
- :ref:`Vector2i[]<class_Vector2i>` **parse_structured_text** **(** :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser_type, :ref:`Array<class_Array>` args, :ref:`String<class_String>` text **)** |const|
|
||||
|
||||
Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
|
||||
|
||||
@@ -1976,7 +2078,7 @@ Returns number of glyphs in the ellipsis.
|
||||
|
||||
.. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
|
||||
|
||||
- :ref:`Array<class_Array>` **shaped_text_get_ellipsis_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
|
||||
- :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_ellipsis_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
|
||||
|
||||
Returns array of the glyphs in the ellipsis.
|
||||
|
||||
@@ -2000,7 +2102,7 @@ Returns number of glyphs in the buffer.
|
||||
|
||||
.. _class_TextServer_method_shaped_text_get_glyphs:
|
||||
|
||||
- :ref:`Array<class_Array>` **shaped_text_get_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
|
||||
- :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
|
||||
|
||||
Returns an array of glyphs in the visual order.
|
||||
|
||||
@@ -2290,7 +2392,7 @@ Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped succe
|
||||
|
||||
.. _class_TextServer_method_shaped_text_sort_logical:
|
||||
|
||||
- :ref:`Array<class_Array>` **shaped_text_sort_logical** **(** :ref:`RID<class_RID>` shaped **)**
|
||||
- :ref:`Dictionary[]<class_Dictionary>` **shaped_text_sort_logical** **(** :ref:`RID<class_RID>` shaped **)**
|
||||
|
||||
Returns text glyphs in the logical order.
|
||||
|
||||
@@ -2312,6 +2414,16 @@ Aligns shaped text to the given tab-stops.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_spoof_check:
|
||||
|
||||
- :ref:`bool<class_bool>` **spoof_check** **(** :ref:`String<class_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 :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
|
||||
|
||||
----
|
||||
|
||||
.. _class_TextServer_method_string_get_word_breaks:
|
||||
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_word_breaks** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
|
||||
|
||||
Reference in New Issue
Block a user