1547 lines
63 KiB
XML
1547 lines
63 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="TextServerExtension" inherits="TextServer" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Base class for TextServer custom implementations (plugins).
|
|
</brief_description>
|
|
<description>
|
|
External TextServer implementations should inherit from this class.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="create_font" qualifiers="virtual">
|
|
<return type="RID" />
|
|
<description>
|
|
Creates new, empty font cache entry resource. To free the resulting resourec, use [method free_rid] method.
|
|
</description>
|
|
</method>
|
|
<method name="create_shaped_text" qualifiers="virtual">
|
|
<return type="RID" />
|
|
<param index="0" name="direction" type="int" enum="TextServer.Direction" />
|
|
<param index="1" name="orientation" type="int" enum="TextServer.Orientation" />
|
|
<description>
|
|
Creates new buffer for complex text layout, with the given [param direction] and [param orientation]. To free the resulting buffer, use [method free_rid] method.
|
|
</description>
|
|
</method>
|
|
<method name="draw_hex_code_box" qualifiers="virtual const">
|
|
<return type="void" />
|
|
<param index="0" name="canvas" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="pos" type="Vector2" />
|
|
<param index="3" name="index" type="int" />
|
|
<param index="4" name="color" type="Color" />
|
|
<description>
|
|
Draws box displaying character hexadecimal code. Used for replacing missing characters.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="font_clear_glyphs" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<description>
|
|
Removes all rendered glyphs information from the cache entry.
|
|
</description>
|
|
</method>
|
|
<method name="font_clear_kerning_map" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<description>
|
|
Removes all kerning overrides.
|
|
</description>
|
|
</method>
|
|
<method name="font_clear_size_cache" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Removes all font sizes from the cache entry.
|
|
</description>
|
|
</method>
|
|
<method name="font_clear_textures" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<description>
|
|
Removes all textures from font cache entry.
|
|
</description>
|
|
</method>
|
|
<method name="font_draw_glyph" qualifiers="virtual const">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="canvas" type="RID" />
|
|
<param index="2" name="size" type="int" />
|
|
<param index="3" name="pos" type="Vector2" />
|
|
<param index="4" name="index" type="int" />
|
|
<param index="5" name="color" type="Color" />
|
|
<description>
|
|
Draws single glyph into a canvas item at the position, using [param font_rid] at the size [param size].
|
|
</description>
|
|
</method>
|
|
<method name="font_draw_glyph_outline" qualifiers="virtual const">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="canvas" type="RID" />
|
|
<param index="2" name="size" type="int" />
|
|
<param index="3" name="outline_size" type="int" />
|
|
<param index="4" name="pos" type="Vector2" />
|
|
<param index="5" name="index" type="int" />
|
|
<param index="6" name="color" type="Color" />
|
|
<description>
|
|
Draws single glyph outline of size [param outline_size] into a canvas item at the position, using [param font_rid] at the size [param size].
|
|
</description>
|
|
</method>
|
|
<method name="font_get_antialiasing" qualifiers="virtual const">
|
|
<return type="int" enum="TextServer.FontAntialiasing" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns font anti-aliasing mode.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_ascent" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<description>
|
|
Returns the font ascent (number of pixels above the baseline).
|
|
</description>
|
|
</method>
|
|
<method name="font_get_descent" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<description>
|
|
Returns the font descent (number of pixels below the baseline).
|
|
</description>
|
|
</method>
|
|
<method name="font_get_embolden" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns font embolden strength.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_face_count" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns number of faces in the TrueType / OpenType collection.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_face_index" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns an active face index in the TrueType / OpenType collection.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_fixed_size" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns bitmap font fixed size.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_generate_mipmaps" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns [code]true[/code] if font texture mipmap generation is enabled.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_global_oversampling" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<description>
|
|
Returns the font oversampling factor, shared by all fonts in the TextServer.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_advance" qualifiers="virtual const">
|
|
<return type="Vector2" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<description>
|
|
Returns glyph advance (offset of the next glyph).
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_contours" qualifiers="virtual const">
|
|
<return type="Dictionary" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="index" type="int" />
|
|
<description>
|
|
Returns outline contours of the glyph as a [code]Dictionary[/code] with the following contents:
|
|
[code]points[/code] - [PackedVector3Array], containing outline points. [code]x[/code] and [code]y[/code] are point coordinates. [code]z[/code] is the type of the point, using the [enum TextServer.ContourPointTag] values.
|
|
[code]contours[/code] - [PackedInt32Array], containing indices the end points of each contour.
|
|
[code]orientation[/code] - [bool], contour orientation. If [code]true[/code], clockwise contours must be filled.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_index" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="char" type="int" />
|
|
<param index="3" name="variation_selector" type="int" />
|
|
<description>
|
|
Returns the glyph index of a [param char], optionally modified by the [param variation_selector].
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_list" qualifiers="virtual const">
|
|
<return type="PackedInt32Array" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<description>
|
|
Returns list of rendered glyphs in the cache entry.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_offset" qualifiers="virtual const">
|
|
<return type="Vector2" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<description>
|
|
Returns glyph offset from the baseline.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_size" qualifiers="virtual const">
|
|
<return type="Vector2" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<description>
|
|
Returns size of the glyph.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_texture_idx" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<description>
|
|
Returns index of the cache texture containing the glyph.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_texture_rid" qualifiers="virtual const">
|
|
<return type="RID" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<description>
|
|
Returns resource id of the cache texture containing the glyph.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_texture_size" qualifiers="virtual const">
|
|
<return type="Vector2" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<description>
|
|
Returns size of the cache texture containing the glyph.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_glyph_uv_rect" qualifiers="virtual const">
|
|
<return type="Rect2" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<description>
|
|
Returns rectangle in the cache texture containing the glyph.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_hinting" qualifiers="virtual const">
|
|
<return type="int" enum="TextServer.Hinting" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns the font hinting mode. Used by dynamic fonts only.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_kerning" qualifiers="virtual const">
|
|
<return type="Vector2" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="glyph_pair" type="Vector2i" />
|
|
<description>
|
|
Returns kerning for the pair of glyphs.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_kerning_list" qualifiers="virtual const">
|
|
<return type="Vector2i[]" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<description>
|
|
Returns list of the kerning overrides.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_language_support_override" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="language" type="String" />
|
|
<description>
|
|
Returns [code]true[/code] if support override is enabled for the [param language].
|
|
</description>
|
|
</method>
|
|
<method name="font_get_language_support_overrides" qualifiers="virtual">
|
|
<return type="PackedStringArray" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns list of language support overrides.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_msdf_pixel_range" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns the width of the range around the shape between the minimum and maximum representable signed distance.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_msdf_size" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns source font size used to generate MSDF textures.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_name" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns font family name.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_opentype_feature_overrides" qualifiers="virtual const">
|
|
<return type="Dictionary" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns font OpenType feature set override.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_oversampling" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_scale" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<description>
|
|
Returns scaling factor of the color bitmap font.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_script_support_override" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="script" type="String" />
|
|
<description>
|
|
Returns [code]true[/code] if support override is enabled for the [param script].
|
|
</description>
|
|
</method>
|
|
<method name="font_get_script_support_overrides" qualifiers="virtual">
|
|
<return type="PackedStringArray" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns list of script support overrides.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_size_cache_list" qualifiers="virtual const">
|
|
<return type="Vector2i[]" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_style" qualifiers="virtual const">
|
|
<return type="int" enum="TextServer.FontStyle" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns font style flags, see [enum TextServer.FontStyle].
|
|
</description>
|
|
</method>
|
|
<method name="font_get_style_name" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns font style name.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_subpixel_positioning" qualifiers="virtual const">
|
|
<return type="int" enum="TextServer.SubpixelPositioning" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns font sub-pixel glyph positioning mode.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_supported_chars" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns a string containing all the characters available in the font.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_texture_count" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<description>
|
|
Returns number of textures used by font cache entry.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_texture_image" qualifiers="virtual const">
|
|
<return type="Image" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="texture_index" type="int" />
|
|
<description>
|
|
Returns font cache texture image data.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_texture_offsets" qualifiers="virtual const">
|
|
<return type="PackedInt32Array" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="texture_index" type="int" />
|
|
<description>
|
|
Returns array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_transform" qualifiers="virtual const">
|
|
<return type="Transform2D" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns 2D transform applied to the font outlines.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_underline_position" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<description>
|
|
Returns pixel offset of the underline below the baseline.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_underline_thickness" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<description>
|
|
Returns thickness of the underline in pixels.
|
|
</description>
|
|
</method>
|
|
<method name="font_get_variation_coordinates" qualifiers="virtual const">
|
|
<return type="Dictionary" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info.
|
|
</description>
|
|
</method>
|
|
<method name="font_has_char" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="char" type="int" />
|
|
<description>
|
|
Returns [code]true[/code] if a Unicode [param char] is available in the font.
|
|
</description>
|
|
</method>
|
|
<method name="font_is_force_autohinter" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns [code]true[/code] if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
|
|
</description>
|
|
</method>
|
|
<method name="font_is_language_supported" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="language" type="String" />
|
|
<description>
|
|
Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code).
|
|
</description>
|
|
</method>
|
|
<method name="font_is_multichannel_signed_distance_field" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns [code]true[/code] if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
|
|
</description>
|
|
</method>
|
|
<method name="font_is_script_supported" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="script" type="String" />
|
|
<description>
|
|
Returns [code]true[/code], if font supports given script (ISO 15924 code).
|
|
</description>
|
|
</method>
|
|
<method name="font_remove_glyph" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<description>
|
|
Removes specified rendered glyph information from the cache entry.
|
|
</description>
|
|
</method>
|
|
<method name="font_remove_kerning" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="glyph_pair" type="Vector2i" />
|
|
<description>
|
|
Removes kerning override for the pair of glyphs.
|
|
</description>
|
|
</method>
|
|
<method name="font_remove_language_support_override" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="language" type="String" />
|
|
<description>
|
|
Remove language support override.
|
|
</description>
|
|
</method>
|
|
<method name="font_remove_script_support_override" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="script" type="String" />
|
|
<description>
|
|
Removes script support override.
|
|
</description>
|
|
</method>
|
|
<method name="font_remove_size_cache" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<description>
|
|
Removes specified font size from the cache entry.
|
|
</description>
|
|
</method>
|
|
<method name="font_remove_texture" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="texture_index" type="int" />
|
|
<description>
|
|
Removes specified texture from the cache entry.
|
|
</description>
|
|
</method>
|
|
<method name="font_render_glyph" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="index" type="int" />
|
|
<description>
|
|
Renders specified glyph to the font cache texture.
|
|
</description>
|
|
</method>
|
|
<method name="font_render_range" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="start" type="int" />
|
|
<param index="3" name="end" type="int" />
|
|
<description>
|
|
Renders the range of characters to the font cache texture.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_antialiasing" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="antialiasing" type="int" enum="TextServer.FontAntialiasing" />
|
|
<description>
|
|
Sets font anti-aliasing mode.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_ascent" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="ascent" type="float" />
|
|
<description>
|
|
Sets the font ascent (number of pixels above the baseline).
|
|
</description>
|
|
</method>
|
|
<method name="font_set_data" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="data" type="PackedByteArray" />
|
|
<description>
|
|
Sets font source data, e.g contents of the dynamic font source file.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_data_ptr" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="data_ptr" type="const uint8_t*" />
|
|
<param index="2" name="data_size" type="int" />
|
|
<description>
|
|
Sets font source data, e.g contents of the dynamic font source file. [param data_ptr] memory buffer must remain accessible during font lifetime.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_descent" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="descent" type="float" />
|
|
<description>
|
|
Sets the font descent (number of pixels below the baseline).
|
|
</description>
|
|
</method>
|
|
<method name="font_set_embolden" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="strength" type="float" />
|
|
<description>
|
|
Sets font embolden strength. If [param strength] is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_face_index" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="face_index" type="int" />
|
|
<description>
|
|
Sets an active face index in the TrueType / OpenType collection.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_fixed_size" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="fixed_size" type="int" />
|
|
<description>
|
|
Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_force_autohinter" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="force_autohinter" type="bool" />
|
|
<description>
|
|
If set to [code]true[/code] auto-hinting is preferred over font built-in hinting.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_generate_mipmaps" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="generate_mipmaps" type="bool" />
|
|
<description>
|
|
If set to [code]true[/code] font texture mipmap generation is enabled.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_global_oversampling" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="oversampling" type="float" />
|
|
<description>
|
|
Sets oversampling factor, shared by all font in the TextServer.
|
|
[b]Note:[/b] This value can be automatically changed by display server.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_glyph_advance" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<param index="3" name="advance" type="Vector2" />
|
|
<description>
|
|
Sets glyph advance (offset of the next glyph).
|
|
</description>
|
|
</method>
|
|
<method name="font_set_glyph_offset" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<param index="3" name="offset" type="Vector2" />
|
|
<description>
|
|
Sets glyph offset from the baseline.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_glyph_size" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<param index="3" name="gl_size" type="Vector2" />
|
|
<description>
|
|
Sets size of the glyph.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_glyph_texture_idx" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<param index="3" name="texture_idx" type="int" />
|
|
<description>
|
|
Sets index of the cache texture containing the glyph.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_glyph_uv_rect" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="glyph" type="int" />
|
|
<param index="3" name="uv_rect" type="Rect2" />
|
|
<description>
|
|
Sets rectangle in the cache texture containing the glyph.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_hinting" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="hinting" type="int" enum="TextServer.Hinting" />
|
|
<description>
|
|
Sets font hinting mode. Used by dynamic fonts only.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_kerning" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="glyph_pair" type="Vector2i" />
|
|
<param index="3" name="kerning" type="Vector2" />
|
|
<description>
|
|
Sets kerning for the pair of glyphs.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_language_support_override" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="language" type="String" />
|
|
<param index="2" name="supported" type="bool" />
|
|
<description>
|
|
Adds override for [method font_is_language_supported].
|
|
</description>
|
|
</method>
|
|
<method name="font_set_msdf_pixel_range" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="msdf_pixel_range" type="int" />
|
|
<description>
|
|
Sets the width of the range around the shape between the minimum and maximum representable signed distance.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_msdf_size" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="msdf_size" type="int" />
|
|
<description>
|
|
Sets source font size used to generate MSDF textures.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_multichannel_signed_distance_field" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="msdf" type="bool" />
|
|
<description>
|
|
If set to [code]true[/code], 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.
|
|
[b]Note:[/b] MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_name" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="name" type="String" />
|
|
<description>
|
|
Sets the font family name.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_opentype_feature_overrides" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="overrides" type="Dictionary" />
|
|
<description>
|
|
Sets font OpenType feature set override.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_oversampling" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="oversampling" type="float" />
|
|
<description>
|
|
Sets font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_scale" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="scale" type="float" />
|
|
<description>
|
|
Sets scaling factor of the color bitmap font.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_script_support_override" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="script" type="String" />
|
|
<param index="2" name="supported" type="bool" />
|
|
<description>
|
|
Adds override for [method font_is_script_supported].
|
|
</description>
|
|
</method>
|
|
<method name="font_set_style" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="style" type="int" enum="TextServer.FontStyle" />
|
|
<description>
|
|
Sets the font style flags, see [enum TextServer.FontStyle].
|
|
</description>
|
|
</method>
|
|
<method name="font_set_style_name" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="name_style" type="String" />
|
|
<description>
|
|
Sets the font style name.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_subpixel_positioning" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="subpixel_positioning" type="int" enum="TextServer.SubpixelPositioning" />
|
|
<description>
|
|
Sets font sub-pixel glyph positioning mode.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_texture_image" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="texture_index" type="int" />
|
|
<param index="3" name="image" type="Image" />
|
|
<description>
|
|
Sets font cache texture image data.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_texture_offsets" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="Vector2i" />
|
|
<param index="2" name="texture_index" type="int" />
|
|
<param index="3" name="offset" type="PackedInt32Array" />
|
|
<description>
|
|
Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_transform" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="transform" type="Transform2D" />
|
|
<description>
|
|
Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
|
|
For example, to simulate italic typeface by slanting, apply the following transform [code]Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)[/code].
|
|
</description>
|
|
</method>
|
|
<method name="font_set_underline_position" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="underline_position" type="float" />
|
|
<description>
|
|
Sets pixel offset of the underline below the baseline.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_underline_thickness" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="size" type="int" />
|
|
<param index="2" name="underline_thickness" type="float" />
|
|
<description>
|
|
Sets thickness of the underline in pixels.
|
|
</description>
|
|
</method>
|
|
<method name="font_set_variation_coordinates" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<param index="1" name="variation_coordinates" type="Dictionary" />
|
|
<description>
|
|
Sets variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info.
|
|
</description>
|
|
</method>
|
|
<method name="font_supported_feature_list" qualifiers="virtual const">
|
|
<return type="Dictionary" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns the dictionary of the supported OpenType features.
|
|
</description>
|
|
</method>
|
|
<method name="font_supported_variation_list" qualifiers="virtual const">
|
|
<return type="Dictionary" />
|
|
<param index="0" name="font_rid" type="RID" />
|
|
<description>
|
|
Returns the dictionary of the supported OpenType variation coordinates.
|
|
</description>
|
|
</method>
|
|
<method name="format_number" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="string" type="String" />
|
|
<param index="1" name="language" type="String" />
|
|
<description>
|
|
Converts a number from the Western Arabic (0..9) to the numeral systems used in [param language].
|
|
</description>
|
|
</method>
|
|
<method name="free_rid" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="rid" type="RID" />
|
|
<description>
|
|
Frees an object created by this [TextServer].
|
|
</description>
|
|
</method>
|
|
<method name="get_features" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns text server features, see [enum TextServer.Feature].
|
|
</description>
|
|
</method>
|
|
<method name="get_hex_code_box_size" qualifiers="virtual const">
|
|
<return type="Vector2" />
|
|
<param index="0" name="size" type="int" />
|
|
<param index="1" name="index" type="int" />
|
|
<description>
|
|
Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="get_name" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<description>
|
|
Returns the name of the server interface.
|
|
</description>
|
|
</method>
|
|
<method name="get_support_data_filename" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<description>
|
|
Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
|
|
</description>
|
|
</method>
|
|
<method name="get_support_data_info" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<description>
|
|
Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
|
|
</description>
|
|
</method>
|
|
<method name="has" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="rid" type="RID" />
|
|
<description>
|
|
Returns [code]true[/code] if [param rid] is valid resource owned by this text server.
|
|
</description>
|
|
</method>
|
|
<method name="has_feature" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="feature" type="int" enum="TextServer.Feature" />
|
|
<description>
|
|
Returns [code]true[/code] if the server supports a feature.
|
|
</description>
|
|
</method>
|
|
<method name="is_confusable" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="string" type="String" />
|
|
<param index="1" name="dict" type="PackedStringArray" />
|
|
<description>
|
|
Returns index of the first string in [param dict] which is visually confusable with the [param string], or [code]-1[/code] if none is found.
|
|
</description>
|
|
</method>
|
|
<method name="is_locale_right_to_left" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="locale" type="String" />
|
|
<description>
|
|
Returns [code]true[/code] if locale is right-to-left.
|
|
</description>
|
|
</method>
|
|
<method name="is_valid_identifier" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="string" type="String" />
|
|
<description>
|
|
Returns [code]true[/code] is [param string] is a valid identifier.
|
|
</description>
|
|
</method>
|
|
<method name="load_support_data" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="filename" type="String" />
|
|
<description>
|
|
Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
|
|
</description>
|
|
</method>
|
|
<method name="name_to_tag" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="name" type="String" />
|
|
<description>
|
|
Converts readable feature, variation, script or language name to OpenType tag.
|
|
</description>
|
|
</method>
|
|
<method name="parse_number" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="string" type="String" />
|
|
<param index="1" name="language" type="String" />
|
|
<description>
|
|
Converts a number from the numeral systems used in [param language] to Western Arabic (0..9).
|
|
</description>
|
|
</method>
|
|
<method name="parse_structured_text" qualifiers="virtual const">
|
|
<return type="Vector2i[]" />
|
|
<param index="0" name="parser_type" type="int" enum="TextServer.StructuredTextParser" />
|
|
<param index="1" name="args" type="Array" />
|
|
<param index="2" name="text" type="String" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="percent_sign" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="language" type="String" />
|
|
<description>
|
|
Returns percent sign used in the [param language].
|
|
</description>
|
|
</method>
|
|
<method name="save_support_data" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="filename" type="String" />
|
|
<description>
|
|
Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
|
|
[b]Note:[/b] This function is used by during project export, to include TextServer database.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_get_span_count" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns number of text spans added using [method shaped_text_add_string] or [method shaped_text_add_object].
|
|
</description>
|
|
</method>
|
|
<method name="shaped_get_span_meta" qualifiers="virtual const">
|
|
<return type="Variant" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="index" type="int" />
|
|
<description>
|
|
Returns text span metadata.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_set_span_update_font" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="index" type="int" />
|
|
<param index="2" name="fonts" type="RID[]" />
|
|
<param index="3" name="size" type="int" />
|
|
<param index="4" name="opentype_features" type="Dictionary" />
|
|
<description>
|
|
Changes text span font, font size and OpenType features, without changing the text.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_add_object" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="key" type="Variant" />
|
|
<param index="2" name="size" type="Vector2" />
|
|
<param index="3" name="inline_align" type="int" enum="InlineAlignment" />
|
|
<param index="4" name="length" type="int" />
|
|
<description>
|
|
Adds inline object to the text buffer, [param key] must be unique. In the text, object is represented as [param length] object replacement characters.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_add_string" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="text" type="String" />
|
|
<param index="2" name="fonts" type="RID[]" />
|
|
<param index="3" name="size" type="int" />
|
|
<param index="4" name="opentype_features" type="Dictionary" />
|
|
<param index="5" name="language" type="String" />
|
|
<param index="6" name="meta" type="Variant" />
|
|
<description>
|
|
Adds text span and font to draw it to the text buffer.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_clear" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Clears text buffer (removes text and inline objects).
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_draw" qualifiers="virtual const">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="canvas" type="RID" />
|
|
<param index="2" name="pos" type="Vector2" />
|
|
<param index="3" name="clip_l" type="float" />
|
|
<param index="4" name="clip_r" type="float" />
|
|
<param index="5" name="color" type="Color" />
|
|
<description>
|
|
Draw shaped text into a canvas item at a given position, with [param color]. [param pos] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_draw_outline" qualifiers="virtual const">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="canvas" type="RID" />
|
|
<param index="2" name="pos" type="Vector2" />
|
|
<param index="3" name="clip_l" type="float" />
|
|
<param index="4" name="clip_r" type="float" />
|
|
<param index="5" name="outline_size" type="int" />
|
|
<param index="6" name="color" type="Color" />
|
|
<description>
|
|
Draw the outline of the shaped text into a canvas item at a given position, with [param color]. [param pos] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_fit_to_width" qualifiers="virtual">
|
|
<return type="float" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="width" type="float" />
|
|
<param index="2" name="jst_flags" type="int" enum="TextServer.JustificationFlag" />
|
|
<description>
|
|
Adjusts text with to fit to specified width, returns new text width.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_ascent" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_carets" qualifiers="virtual const">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="position" type="int" />
|
|
<param index="2" name="caret" type="CaretInfo*" />
|
|
<description>
|
|
Returns shapes of the carets corresponding to the character offset [param position] in the text. Returned caret shape is 1 pixel wide rectangle.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_custom_punctuation" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_descent" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_direction" qualifiers="virtual const">
|
|
<return type="int" enum="TextServer.Direction" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns direction of the text.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_dominant_direction_in_range" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="start" type="int" />
|
|
<param index="2" name="end" type="int" />
|
|
<description>
|
|
Returns dominant direction of in the range of text.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_ellipsis_glyph_count" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns number of glyphs in the ellipsis.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_ellipsis_glyphs" qualifiers="virtual const">
|
|
<return type="const Glyph*" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns array of the glyphs in the ellipsis.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_ellipsis_pos" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns position of the ellipsis.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_glyph_count" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns number of glyphs in the buffer.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_glyphs" qualifiers="virtual const">
|
|
<return type="const Glyph*" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns an array of glyphs in the visual order.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_grapheme_bounds" qualifiers="virtual const">
|
|
<return type="Vector2" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="pos" type="int" />
|
|
<description>
|
|
Returns composite character's bounds as offsets from the start of the line.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_inferred_direction" qualifiers="virtual const">
|
|
<return type="int" enum="TextServer.Direction" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns direction of the text, inferred by the BiDi algorithm.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_line_breaks" qualifiers="virtual const">
|
|
<return type="PackedInt32Array" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="width" type="float" />
|
|
<param index="2" name="start" type="int" />
|
|
<param index="3" name="break_flags" type="int" enum="TextServer.LineBreakFlag" />
|
|
<description>
|
|
Breaks text to the lines and returns character ranges for each line.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_line_breaks_adv" qualifiers="virtual const">
|
|
<return type="PackedInt32Array" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="width" type="PackedFloat32Array" />
|
|
<param index="2" name="start" type="int" />
|
|
<param index="3" name="once" type="bool" />
|
|
<param index="4" name="break_flags" type="int" enum="TextServer.LineBreakFlag" />
|
|
<description>
|
|
Breaks text to the lines and columns. Returns character ranges for each segment.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_object_rect" qualifiers="virtual const">
|
|
<return type="Rect2" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="key" type="Variant" />
|
|
<description>
|
|
Returns bounding rectangle of the inline object.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_objects" qualifiers="virtual const">
|
|
<return type="Array" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns array of inline objects.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_orientation" qualifiers="virtual const">
|
|
<return type="int" enum="TextServer.Orientation" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
eturns text orientation.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_parent" qualifiers="virtual const">
|
|
<return type="RID" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns the parent buffer from which the substring originates.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_preserve_control" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns [code]true[/code] if text buffer is configured to display control characters.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_preserve_invalid" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters.
|
|
[b]Note:[/b] If set to [code]false[/code], nothing is displayed in place of invalid characters.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_range" qualifiers="virtual const">
|
|
<return type="Vector2i" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns substring buffer character range in the parent buffer.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_selection" qualifiers="virtual const">
|
|
<return type="PackedVector2Array" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="start" type="int" />
|
|
<param index="2" name="end" type="int" />
|
|
<description>
|
|
Returns selection rectangles for the specified character range.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_size" qualifiers="virtual const">
|
|
<return type="Vector2" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns size of the text.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_spacing" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="spacing" type="int" enum="TextServer.SpacingType" />
|
|
<description>
|
|
Returns extra spacing added between glyphs or lines in pixels.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_trim_pos" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns the position of the overrun trim.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_underline_position" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns pixel offset of the underline below the baseline.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_underline_thickness" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns thickness of the underline.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_width" qualifiers="virtual const">
|
|
<return type="float" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns width (for horizontal layout) or height (for vertical) of the text.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_get_word_breaks" qualifiers="virtual const">
|
|
<return type="PackedInt32Array" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="grapheme_flags" type="int" enum="TextServer.GraphemeFlag" />
|
|
<description>
|
|
Breaks text into words and returns array of character ranges.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_hit_test_grapheme" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="coord" type="float" />
|
|
<description>
|
|
Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_hit_test_position" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="coord" type="float" />
|
|
<description>
|
|
Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_is_ready" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns [code]true[/code] if buffer is successfully shaped.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_next_grapheme_pos" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="pos" type="int" />
|
|
<description>
|
|
Returns composite character end position closest to the [param pos].
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_overrun_trim_to_width" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="width" type="float" />
|
|
<param index="2" name="trim_flags" type="int" enum="TextServer.TextOverrunFlag" />
|
|
<description>
|
|
Trims text if it exceeds the given width.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_prev_grapheme_pos" qualifiers="virtual const">
|
|
<return type="int" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="pos" type="int" />
|
|
<description>
|
|
Returns composite character start position closest to the [param pos].
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_resize_object" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="key" type="Variant" />
|
|
<param index="2" name="size" type="Vector2" />
|
|
<param index="3" name="inline_align" type="int" enum="InlineAlignment" />
|
|
<description>
|
|
Sets new size and alignment of embedded object.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_set_bidi_override" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="override" type="Array" />
|
|
<description>
|
|
Overrides BiDi for the structured text.
|
|
Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_set_custom_punctuation" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="punct" type="String" />
|
|
<description>
|
|
Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_set_direction" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="direction" type="int" enum="TextServer.Direction" />
|
|
<description>
|
|
Sets desired text [param direction]. If set to [code]TEXT_DIRECTION_AUTO[/code], direction will be detected based on the buffer contents and current locale.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_set_orientation" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="orientation" type="int" enum="TextServer.Orientation" />
|
|
<description>
|
|
Sets desired text orientation.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_set_preserve_control" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="enabled" type="bool" />
|
|
<description>
|
|
If set to [code]true[/code] text buffer will display control characters.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_set_preserve_invalid" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="enabled" type="bool" />
|
|
<description>
|
|
If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_set_spacing" qualifiers="virtual">
|
|
<return type="void" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="spacing" type="int" enum="TextServer.SpacingType" />
|
|
<param index="2" name="value" type="int" />
|
|
<description>
|
|
Sets extra spacing added between glyphs or lines in pixels.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_shape" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_sort_logical" qualifiers="virtual">
|
|
<return type="const Glyph*" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Returns text glyphs in the logical order.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_substr" qualifiers="virtual const">
|
|
<return type="RID" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="start" type="int" />
|
|
<param index="2" name="length" type="int" />
|
|
<description>
|
|
Returns text buffer for the substring of the text in the [param shaped] text buffer (including inline objects).
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_tab_align" qualifiers="virtual">
|
|
<return type="float" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<param index="1" name="tab_stops" type="PackedFloat32Array" />
|
|
<description>
|
|
Aligns shaped text to the given tab-stops.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_update_breaks" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Updates line breaking positions in the text buffer.
|
|
[b]Note:[/b] This method is used by default line/word breaking methods, and its implementation might be omitted if custom line breaking in implemented.
|
|
</description>
|
|
</method>
|
|
<method name="shaped_text_update_justification_ops" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<param index="0" name="shaped" type="RID" />
|
|
<description>
|
|
Updates line justification positions (word breaks and elongations) in the text buffer.
|
|
[b]Note:[/b] This method is used by default line/word breaking methods, and its implementation might be omitted if custom line breaking in implemented.
|
|
</description>
|
|
</method>
|
|
<method name="spoof_check" qualifiers="virtual const">
|
|
<return type="bool" />
|
|
<param index="0" name="string" type="String" />
|
|
<description>
|
|
Returns [code]true[/code] if [param string] is likely to be an attempt at confusing the reader.
|
|
</description>
|
|
</method>
|
|
<method name="string_get_word_breaks" qualifiers="virtual const">
|
|
<return type="PackedInt32Array" />
|
|
<param index="0" name="string" type="String" />
|
|
<param index="1" name="language" type="String" />
|
|
<description>
|
|
Returns array of the word break character offsets.
|
|
</description>
|
|
</method>
|
|
<method name="string_to_lower" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="string" type="String" />
|
|
<param index="1" name="language" type="String" />
|
|
<description>
|
|
Returns the string converted to lowercase.
|
|
</description>
|
|
</method>
|
|
<method name="string_to_upper" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="string" type="String" />
|
|
<param index="1" name="language" type="String" />
|
|
<description>
|
|
Returns the string converted to uppercase.
|
|
</description>
|
|
</method>
|
|
<method name="strip_diacritics" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="string" type="String" />
|
|
<description>
|
|
Strips diacritics from the string.
|
|
[b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used.
|
|
</description>
|
|
</method>
|
|
<method name="tag_to_name" qualifiers="virtual const">
|
|
<return type="String" />
|
|
<param index="0" name="tag" type="int" />
|
|
<description>
|
|
Converts OpenType tag to readable feature, variation, script or language name.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
</class>
|