godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/TextServer.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

1913 lines
82 KiB
XML
Raw Normal View History

[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="TextServer" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes) (cherry picked from commit 151a4ba6a59f6e965bb56ce8fbc75b14d056fa79)
2023-04-30 14:26:09 +00:00
A server interface for font management and text rendering.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes) (cherry picked from commit 151a4ba6a59f6e965bb56ce8fbc75b14d056fa79)
2023-04-30 14:26:09 +00:00
[TextServer] is the API backend for managing fonts and rendering text.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
<tutorials>
</tutorials>
<methods>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="create_font">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="RID" />
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 14:34:06 +00:00
<description>
Overhaul the top sections of the class reference (GUI classes) (cherry picked from commit 151a4ba6a59f6e965bb56ce8fbc75b14d056fa79)
2023-04-30 14:26:09 +00:00
Creates a new, empty font cache entry resource. To free the resulting resource, use the [method free_rid] method.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="create_shaped_text">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="direction" type="int" enum="TextServer.Direction" default="0" />
<param index="1" name="orientation" type="int" enum="TextServer.Orientation" default="0" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
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.
[TextServer] Implement locale and context sensitive case conversion functions.
2022-01-17 08:54:45 +00:00
[b]Note:[/b] Direction is ignored if server does not support [constant FEATURE_BIDI_LAYOUT] feature (supported by [TextServerAdvanced]).
[b]Note:[/b] Orientation is ignored if server does not support [constant FEATURE_VERTICAL_LAYOUT] feature (supported by [TextServerAdvanced]).
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="draw_hex_code_box" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Draws box displaying character hexadecimal code. Used for replacing missing characters.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_clear_glyphs">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 14:34:06 +00:00
<description>
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
Removes all rendered glyphs information from the cache entry.
[b]Note:[/b] This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually.
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 14:34:06 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_clear_kerning_map">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 14:34:06 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Removes all kerning overrides.
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 14:34:06 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_clear_size_cache">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
Removes all font sizes from the cache entry.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name="font_clear_textures">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 14:34:06 +00:00
<description>
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
Removes all textures from font cache entry.
[b]Note:[/b] This function will not remove glyphs associated with the texture, use [method font_remove_glyph] to remove them manually.
[Text Server] Restores bitmap font dynamic construction functions.
2021-02-06 14:34:06 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="font_draw_glyph" qualifiers="const">
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" default="Color(1, 1, 1, 1)" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Draws single glyph into a canvas item at the position, using [param font_rid] at the size [param size].
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index].
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
[b]Note:[/b] If there are pending glyphs to render, calling this function might trigger the texture cache update.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_draw_glyph_outline" qualifiers="const">
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" default="Color(1, 1, 1, 1)" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
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].
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index].
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
[b]Note:[/b] If there are pending glyphs to render, calling this function might trigger the texture cache update.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
<method name="font_get_antialiasing" qualifiers="const">
<return type="int" enum="TextServer.FontAntialiasing" />
<param index="0" name="font_rid" type="RID" />
<description>
Returns font anti-aliasing mode.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="font_get_ascent" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns the font ascent (number of pixels above the baseline).
</description>
</method>
<method name="font_get_descent" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns the font descent (number of pixels below the baseline).
</description>
</method>
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
<method name="font_get_embolden" qualifiers="const">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
<description>
Returns font embolden strength.
</description>
</method>
[TextServer] Adds support for TrueType / OpenType collection files (*.TTC, *.OTC).
2022-06-07 08:35:59 +00:00
<method name="font_get_face_count" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[TextServer] Adds support for TrueType / OpenType collection files (*.TTC, *.OTC).
2022-06-07 08:35:59 +00:00
<description>
Returns number of faces in the TrueType / OpenType collection.
</description>
</method>
<method name="font_get_face_index" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[TextServer] Adds support for TrueType / OpenType collection files (*.TTC, *.OTC).
2022-06-07 08:35:59 +00:00
<description>
Recturns an active face index in the TrueType / OpenType collection.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_fixed_size" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns bitmap font fixed size.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<method name="font_get_generate_mipmaps" qualifiers="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<description>
Returns [code]true[/code] if font texture mipmap generation is enabled.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_global_oversampling" qualifiers="const">
<return type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns the font oversampling factor, shared by all fonts in the TextServer.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_get_glyph_advance" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="glyph" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
Returns glyph advance (offset of the next glyph).
[b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
[Complex Text Layouts] Provide access to glyph contour points.
2020-12-10 15:30:25 +00:00
<method name="font_get_glyph_contours" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Dictionary" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="index" type="int" />
[Complex Text Layouts] Provide access to glyph contour points.
2020-12-10 15:30:25 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns outline contours of the glyph as a [code]Dictionary[/code] with the following contents:
[Complex Text Layouts] Provide access to glyph contour points.
2020-12-10 15:30:25 +00:00
[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 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>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="font_get_glyph_index" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the glyph index of a [param char], optionally modified by the [param variation_selector].
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_glyph_list" qualifiers="const">
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
<return type="PackedInt32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Returns list of rendered glyphs in the cache entry.
</description>
</method>
<method name="font_get_glyph_offset" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="glyph" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns glyph offset from the baseline.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_glyph_size" qualifiers="const">
<return type="Vector2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="glyph" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns size of the glyph.
</description>
</method>
<method name="font_get_glyph_texture_idx" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="glyph" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Returns index of the cache texture containing the glyph.
</description>
</method>
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<method name="font_get_glyph_texture_rid" qualifiers="const">
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="glyph" type="int" />
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<description>
Use capitalized ID in the doc
2022-12-08 01:40:49 +00:00
Returns resource ID of the cache texture containing the glyph.
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
[b]Note:[/b] If there are pending glyphs to render, calling this function might trigger the texture cache update.
</description>
</method>
<method name="font_get_glyph_texture_size" qualifiers="const">
<return type="Vector2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="glyph" type="int" />
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<description>
Returns size of the cache texture containing the glyph.
[b]Note:[/b] If there are pending glyphs to render, calling this function might trigger the texture cache update.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_glyph_uv_rect" qualifiers="const">
<return type="Rect2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="glyph" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Returns rectangle in the cache texture containing the glyph.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_get_hinting" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="TextServer.Hinting" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns the font hinting mode. Used by dynamic fonts only.
</description>
</method>
<method name="font_get_kerning" qualifiers="const">
<return type="Vector2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="glyph_pair" type="Vector2i" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Returns kerning for the pair of glyphs.
</description>
</method>
<method name="font_get_kerning_list" qualifiers="const">
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
<return type="Vector2i[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Returns list of the kerning overrides.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_get_language_support_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="language" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if support override is enabled for the [param language].
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_get_language_support_overrides">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns list of language support overrides.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_msdf_pixel_range" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Fix usage of "Return" in the docs
2022-01-02 17:32:49 +00:00
Returns the width of the range around the shape between the minimum and maximum representable signed distance.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name="font_get_msdf_size" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Returns source font size used to generate MSDF textures.
</description>
</method>
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<method name="font_get_name" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<description>
Returns font family name.
</description>
</method>
[TextServer] Improve ligature cursor handling. Fix mid-grapheme hit test. Fix OpenType features property handling, add default features override option. Enable mid-grapheme cursor by default.
2021-11-18 21:36:22 +00:00
<method name="font_get_opentype_feature_overrides" qualifiers="const">
<return type="Dictionary" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[TextServer] Improve ligature cursor handling. Fix mid-grapheme hit test. Fix OpenType features property handling, add default features override option. Enable mid-grapheme cursor by default.
2021-11-18 21:36:22 +00:00
<description>
Returns font OpenType feature set override.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="font_get_oversampling" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
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="const">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Returns scaling factor of the color bitmap font.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_get_script_support_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="script" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if support override is enabled for the [param script].
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_get_script_support_overrides">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns list of script support overrides.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_size_cache_list" qualifiers="const">
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
<return type="Vector2i[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[TextServer] Restore character and space extra spacing support.
2021-02-15 08:46:23 +00:00
<description>
Fix usage of "Return" in the docs
2022-01-02 17:32:49 +00:00
Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size.
[TextServer] Restore character and space extra spacing support.
2021-02-15 08:46:23 +00:00
</description>
</method>
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
<method name="font_get_stretch" qualifiers="const">
<return type="int" />
<param index="0" name="font_rid" type="RID" />
<description>
Returns font stretch amount, compared to a normal width. A percentage value between [code]50%[/code] and [code]200%[/code].
</description>
</method>
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<method name="font_get_style" qualifiers="const">
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<return type="int" enum="TextServer.FontStyle" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<description>
Returns font style flags, see [enum FontStyle].
</description>
</method>
<method name="font_get_style_name" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<description>
Returns font style name.
</description>
</method>
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
<method name="font_get_subpixel_positioning" qualifiers="const">
<return type="int" enum="TextServer.SubpixelPositioning" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
<description>
Hide Antialiasing import option on DynamicFonts with MSDF enabled Antialiasing cannot be adjusted on fonts rendered with MSDF. Internally, Godot always uses grayscale antialiasing for those fonts. This also tweaks property hints for consistency, and renames uses of "sub-pixel" to the more commonly used "subpixel".
2022-11-03 17:37:21 +00:00
Returns font subpixel glyph positioning mode.
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="font_get_supported_chars" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns a string containing all the characters available in the font.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_texture_count" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns number of textures used by font cache entry.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_texture_image" qualifiers="const">
<return type="Image" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="texture_index" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Returns font cache texture image data.
</description>
</method>
<method name="font_get_texture_offsets" qualifiers="const">
<return type="PackedInt32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="texture_index" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Improve font glyph cache packing shelf best height fit heuristic.
2022-10-18 07:10:24 +00:00
Returns array containing glyph packing data.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
<method name="font_get_transform" qualifiers="const">
<return type="Transform2D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
<description>
Returns 2D transform applied to the font outlines.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_underline_position" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns pixel offset of the underline below the baseline.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_underline_thickness" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
[Complex Text Layouts] Add variable fonts support.
2020-10-22 16:40:18 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns thickness of the underline in pixels.
[Complex Text Layouts] Add variable fonts support.
2020-10-22 16:40:18 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_get_variation_coordinates" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Dictionary" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[Complex Text Layouts] Add variable fonts support.
2020-10-22 16:40:18 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Returns variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info.
[Complex Text Layouts] Add variable fonts support.
2020-10-22 16:40:18 +00:00
</description>
</method>
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
<method name="font_get_weight" qualifiers="const">
<return type="int" />
<param index="0" name="font_rid" type="RID" />
<description>
Returns weight (boldness) of the font. A value in the [code]100...999[/code] range, normal font weight is [code]400[/code], bold font weight is [code]700[/code].
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="font_has_char" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="char" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if a Unicode [param char] is available in the font.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
<method name="font_is_allow_system_fallback" qualifiers="const">
<return type="bool" />
<param index="0" name="font_rid" type="RID" />
<description>
Returns [code]true[/code] if system fonts can be automatically used as fallbacks.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_is_force_autohinter" qualifiers="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Fix various typos Found via ` codespell -q 3 -S ./thirdparty,*.po,./DONORS.md -L ackward,ang,ans,ba,beng,cas,childs,childrens,dof,doubleclick,expct,fave,findn,gird,hist,inout,leapyear,lod,nd,numer,ois,ony,paket,seeked,sinc,switchs,te,uint,varn` Update editor/import/resource_importer_layered_texture.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update doc/classes/TileSetScenesCollectionSource.xml Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/graph_edit.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/rich_text_label.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Revert previously committed change
2022-01-02 06:03:58 +00:00
Returns [code]true[/code] if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_is_language_supported" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="language" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
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="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<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.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_is_script_supported" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="script" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns [code]true[/code], if font supports given script (ISO 15924 code).
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_remove_glyph">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="glyph" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
Removes specified rendered glyph information from the cache entry.
[b]Note:[/b] This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name="font_remove_kerning">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="glyph_pair" type="Vector2i" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Removes kerning override for the pair of glyphs.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="font_remove_language_support_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="language" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Remove language support override.
</description>
</method>
<method name="font_remove_script_support_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="script" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Removes script support override.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_remove_size_cache">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Removes specified font size from the cache entry.
</description>
</method>
<method name="font_remove_texture">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="texture_index" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Refactor Font configuration and import UI, and Font resources.
2022-05-09 09:47:10 +00:00
Removes specified texture from the cache entry.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] This function will not remove glyphs associated with the texture, remove them manually, using [method font_remove_glyph].
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name="font_render_glyph">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="index" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
Renders specified glyph to the font cache texture.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name="font_render_range">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Renders the range of characters to the font cache texture.
</description>
</method>
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
<method name="font_set_allow_system_fallback">
<return type="void" />
<param index="0" name="font_rid" type="RID" />
<param index="1" name="allow_system_fallback" type="bool" />
<description>
If set to [code]true[/code], system fonts can be automatically used as fallbacks.
</description>
</method>
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
<method name="font_set_antialiasing">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
<param index="1" name="antialiasing" type="int" enum="TextServer.FontAntialiasing" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
Sets font anti-aliasing mode.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_set_ascent">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="ascent" type="float" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets the font ascent (number of pixels above the baseline).
</description>
</method>
<method name="font_set_data">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="data" type="PackedByteArray" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Sets font source data, e.g contents of the dynamic font source file.
</description>
</method>
<method name="font_set_descent">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="descent" type="float" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets the font descent (number of pixels below the baseline).
</description>
</method>
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
<method name="font_set_embolden">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="strength" type="float" />
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Sets font embolden strength. If [param strength] is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
</description>
</method>
[TextServer] Adds support for TrueType / OpenType collection files (*.TTC, *.OTC).
2022-06-07 08:35:59 +00:00
<method name="font_set_face_index">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="face_index" type="int" />
[TextServer] Adds support for TrueType / OpenType collection files (*.TTC, *.OTC).
2022-06-07 08:35:59 +00:00
<description>
Sets an active face index in the TrueType / OpenType collection.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_set_fixed_size">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="fixed_size" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_set_force_autohinter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="force_autohinter" type="bool" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Fix various typos Found via ` codespell -q 3 -S ./thirdparty,*.po,./DONORS.md -L ackward,ang,ans,ba,beng,cas,childs,childrens,dof,doubleclick,expct,fave,findn,gird,hist,inout,leapyear,lod,nd,numer,ois,ony,paket,seeked,sinc,switchs,te,uint,varn` Update editor/import/resource_importer_layered_texture.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update doc/classes/TileSetScenesCollectionSource.xml Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/graph_edit.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/rich_text_label.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Revert previously committed change
2022-01-02 06:03:58 +00:00
If set to [code]true[/code] auto-hinting is preferred over font built-in hinting.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<method name="font_set_generate_mipmaps">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="generate_mipmaps" type="bool" />
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<description>
If set to [code]true[/code] font texture mipmap generation is enabled.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_set_global_oversampling">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="oversampling" type="float" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets oversampling factor, shared by all font in the TextServer.
Fix various typos Found via ` codespell -q 3 -S ./thirdparty,*.po,./DONORS.md -L ackward,ang,ans,ba,beng,cas,childs,childrens,dof,doubleclick,expct,fave,findn,gird,hist,inout,leapyear,lod,nd,numer,ois,ony,paket,seeked,sinc,switchs,te,uint,varn` Update editor/import/resource_importer_layered_texture.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update doc/classes/TileSetScenesCollectionSource.xml Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/graph_edit.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/rich_text_label.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Revert previously committed change
2022-01-02 06:03:58 +00:00
[b]Note:[/b] This value can be automatically changed by display server.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name="font_set_glyph_advance">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
Sets glyph advance (offset of the next glyph).
[b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name="font_set_glyph_offset">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets glyph offset from the baseline.
</description>
</method>
<method name="font_set_glyph_size">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Sets size of the glyph.
</description>
</method>
<method name="font_set_glyph_texture_idx">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets index of the cache texture containing the glyph.
</description>
</method>
<method name="font_set_glyph_uv_rect">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets rectangle in the cache texture containing the glyph.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_set_hinting">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="hinting" type="int" enum="TextServer.Hinting" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Sets font hinting mode. Used by dynamic fonts only.
</description>
</method>
<method name="font_set_kerning">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets kerning for the pair of glyphs.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_set_language_support_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="language" type="String" />
<param index="2" name="supported" type="bool" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Adds override for [method font_is_language_supported].
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_set_msdf_pixel_range">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="msdf_pixel_range" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<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">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="msdf_size" type="int" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets source font size used to generate MSDF textures.
</description>
</method>
<method name="font_set_multichannel_signed_distance_field">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="msdf" type="bool" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Improve documentation related to MSDF font rendering
2021-09-15 18:04:57 +00:00
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.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<method name="font_set_name">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="name" type="String" />
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<description>
Sets the font family name.
</description>
</method>
[TextServer] Improve ligature cursor handling. Fix mid-grapheme hit test. Fix OpenType features property handling, add default features override option. Enable mid-grapheme cursor by default.
2021-11-18 21:36:22 +00:00
<method name="font_set_opentype_feature_overrides">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="overrides" type="Dictionary" />
[TextServer] Improve ligature cursor handling. Fix mid-grapheme hit test. Fix OpenType features property handling, add default features override option. Enable mid-grapheme cursor by default.
2021-11-18 21:36:22 +00:00
<description>
Sets font OpenType feature set override.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="font_set_oversampling">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="oversampling" type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
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">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="scale" type="float" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets scaling factor of the color bitmap font.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="font_set_script_support_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="script" type="String" />
<param index="2" name="supported" type="bool" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Adds override for [method font_is_script_supported].
</description>
</method>
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
<method name="font_set_stretch">
<return type="void" />
<param index="0" name="font_rid" type="RID" />
<param index="1" name="weight" type="int" />
<description>
Sets font stretch amount, compared to a normal width. A percentage value between [code]50%[/code] and [code]200%[/code].
[b]Note:[/b] This value is used for font matching only and will not affect font rendering. Use [method font_set_face_index], [method font_set_variation_coordinates], or [method font_set_transform] instead.
</description>
</method>
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<method name="font_set_style">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="style" type="int" enum="TextServer.FontStyle" />
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<description>
Sets the font style flags, see [enum FontStyle].
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
[b]Note:[/b] This value is used for font matching only and will not affect font rendering. Use [method font_set_face_index], [method font_set_variation_coordinates], [method font_set_embolden], or [method font_set_transform] instead.
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
</description>
</method>
<method name="font_set_style_name">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="name" type="String" />
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
<description>
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
Sets the font style name.
</description>
</method>
<method name="font_set_subpixel_positioning">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="subpixel_positioning" type="int" enum="TextServer.SubpixelPositioning" />
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
<description>
Hide Antialiasing import option on DynamicFonts with MSDF enabled Antialiasing cannot be adjusted on fonts rendered with MSDF. Internally, Godot always uses grayscale antialiasing for those fonts. This also tweaks property hints for consistency, and renames uses of "sub-pixel" to the more commonly used "subpixel".
2022-11-03 17:37:21 +00:00
Sets font subpixel glyph positioning mode.
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_set_texture_image">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
[TextServer] Restore character and space extra spacing support.
2021-02-15 08:46:23 +00:00
<description>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
Sets font cache texture image data.
[TextServer] Restore character and space extra spacing support.
2021-02-15 08:46:23 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_set_texture_offsets">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Improve font glyph cache packing shelf best height fit heuristic.
2022-10-18 07:10:24 +00:00
Sets array containing glyph packing data.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
<method name="font_set_transform">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="transform" type="Transform2D" />
Add options to embolden and transform font outlines to simulate bold and italic typefaces.
2022-03-11 07:31:16 +00:00
<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>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_set_underline_position">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="underline_position" type="float" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets pixel offset of the underline below the baseline.
</description>
</method>
<method name="font_set_underline_thickness">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="underline_thickness" type="float" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets thickness of the underline in pixels.
</description>
</method>
<method name="font_set_variation_coordinates">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
<param index="1" name="variation_coordinates" type="Dictionary" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Sets variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info.
</description>
</method>
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
<method name="font_set_weight">
<return type="void" />
<param index="0" name="font_rid" type="RID" />
<param index="1" name="weight" type="int" />
<description>
Sets weight (boldness) of the font. A value in the [code]100...999[/code] range, normal font weight is [code]400[/code], bold font weight is [code]700[/code].
[b]Note:[/b] This value is used for font matching only and will not affect font rendering. Use [method font_set_face_index], [method font_set_variation_coordinates], or [method font_set_embolden] instead.
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="font_supported_feature_list" qualifiers="const">
<return type="Dictionary" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<description>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Returns the dictionary of the supported OpenType features.
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name="font_supported_variation_list" qualifiers="const">
<return type="Dictionary" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="font_rid" type="RID" />
[Complex Text Layouts] Add variable fonts support.
2020-10-22 16:40:18 +00:00
<description>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Returns the dictionary of the supported OpenType variation coordinates.
[Complex Text Layouts] Add variable fonts support.
2020-10-22 16:40:18 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="format_number" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="number" type="String" />
<param index="1" name="language" type="String" default="&quot;&quot;" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Converts a number from the Western Arabic (0..9) to the numeral systems used in [param language].
Update documentation for TextServer.format_number() when language parameter is omitted.
2022-12-19 04:11:02 +00:00
If [param language] is omitted, the active locale will be used.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="free_rid">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Frees an object created by this [TextServer].
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="get_features" qualifiers="const">
<return type="int" />
<description>
Returns text server features, see [enum Feature].
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="get_hex_code_box_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="size" type="int" />
<param index="1" name="index" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
</description>
</method>
<method name="get_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns the name of the server interface.
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="get_support_data_filename" qualifiers="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="const">
<return type="String" />
<description>
Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="has">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if [param rid] is valid resource owned by this text server.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="has_feature" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="feature" type="int" enum="TextServer.Feature" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns [code]true[/code] if the server supports a feature.
</description>
</method>
[TextServer] Add ICU Unicode security and spoofing detection.
2021-11-12 08:12:37 +00:00
<method name="is_confusable" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="string" type="String" />
<param index="1" name="dict" type="PackedStringArray" />
[TextServer] Add ICU Unicode security and spoofing detection.
2021-11-12 08:12:37 +00:00
<description>
Improve the `make_rst.py` parser for BBCode tags
2022-08-09 20:53:29 +00:00
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.
[TextServer] Add ICU Unicode security and spoofing detection.
2021-11-12 08:12:37 +00:00
[b]Note:[/b] This method doesn't detect invisible characters, for spoof detection use it in combination with [method spoof_check].
[b]Note:[/b] Always returns [code]-1[/code] if the server does not support the [constant FEATURE_UNICODE_SECURITY] feature.
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="is_locale_right_to_left" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="locale" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns [code]true[/code] if locale is right-to-left.
</description>
</method>
[TextServer] Implement ICU/UAX 31 based `is_valid_identifier` function.
2021-10-18 12:07:11 +00:00
<method name="is_valid_identifier" qualifiers="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="string" type="String" />
[TextServer] Implement ICU/UAX 31 based `is_valid_identifier` function.
2021-10-18 12:07:11 +00:00
<description>
Fix various typos in the classref (cherry picked from commit 766807506c4f40bca1fafd16ac467a33694f6269)
2023-04-18 11:53:47 +00:00
Returns [code]true[/code] if [param string] is a valid identifier.
[TextServer] Implement ICU/UAX 31 based `is_valid_identifier` function.
2021-10-18 12:07:11 +00:00
If the text server supports the [constant FEATURE_UNICODE_IDENTIFIERS] feature, a valid identifier must:
- Conform to normalization form C.
- Begin with a Unicode character of class XID_Start or [code]"_"[/code].
- May contain Unicode characters of class XID_Continue in the other positions.
- Use UAX #31 recommended scripts only (mixed scripts are allowed).
If the [constant FEATURE_UNICODE_IDENTIFIERS] feature is not supported, a valid identifier must:
- Begin with a Unicode character of class XID_Start or [code]"_"[/code].
- May contain Unicode characters of class XID_Continue in the other positions.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="load_support_data">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="filename" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] This function should be called before any other TextServer functions used, otherwise it won't have any effect.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="name_to_tag" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Converts readable feature, variation, script or language name to OpenType tag.
</description>
</method>
<method name="parse_number" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="number" type="String" />
<param index="1" name="language" type="String" default="&quot;&quot;" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Converts [param number] from the numeral systems used in [param language] to Western Arabic (0..9).
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<method name="parse_structured_text" qualifiers="const">
Implement BiDi override mode for GDScript source.
2023-01-18 07:33:35 +00:00
<return type="Vector3i[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" />
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<description>
Default implementation of the BiDi algorithm override function. See [enum StructuredTextParser] for more info.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="percent_sign" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="language" type="String" default="&quot;&quot;" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns percent sign used in the [param language].
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="save_support_data" qualifiers="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="filename" type="String" />
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<description>
Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] This function is used by during project export, to include TextServer database.
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
</description>
</method>
[TextServer] Add function to change font, font size, and OpenType features without invalidating line break points, justification points, or recreating shaped text buffer.
2022-01-20 07:30:42 +00:00
<method name="shaped_get_span_count" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[TextServer] Add function to change font, font size, and OpenType features without invalidating line break points, justification points, or recreating shaped text buffer.
2022-01-20 07:30:42 +00:00
<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="const">
<return type="Variant" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="index" type="int" />
[TextServer] Add function to change font, font size, and OpenType features without invalidating line break points, justification points, or recreating shaped text buffer.
2022-01-20 07:30:42 +00:00
<description>
Returns text span metadata.
</description>
</method>
<method name="shaped_set_span_update_font">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="index" type="int" />
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
<param index="2" name="fonts" type="RID[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="3" name="size" type="int" />
<param index="4" name="opentype_features" type="Dictionary" default="{}" />
[TextServer] Add function to change font, font size, and OpenType features without invalidating line break points, justification points, or recreating shaped text buffer.
2022-01-20 07:30:42 +00:00
<description>
Changes text span font, font size and OpenType features, without changing the text.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="shaped_text_add_object">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" default="5" />
<param index="4" name="length" type="int" default="1" />
[RTL/TextServer] Add baseline inline alignment mode for objects and RTL tables.
2022-12-08 20:01:07 +00:00
<param index="5" name="baseline" type="float" default="0.0" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds inline object to the text buffer, [param key] must be unique. In the text, object is represented as [param length] object replacement characters.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_add_string">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="text" type="String" />
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
<param index="2" name="fonts" type="RID[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="3" name="size" type="int" />
<param index="4" name="opentype_features" type="Dictionary" default="{}" />
<param index="5" name="language" type="String" default="&quot;&quot;" />
<param index="6" name="meta" type="Variant" default="null" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Adds text span and font to draw it to the text buffer.
</description>
</method>
<method name="shaped_text_clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="rid" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Clears text buffer (removes text and inline objects).
</description>
</method>
<method name="shaped_text_draw" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" default="-1" />
<param index="4" name="clip_r" type="float" default="-1" />
<param index="5" name="color" type="Color" default="Color(1, 1, 1, 1)" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
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).
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_draw_outline" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" default="-1" />
<param index="4" name="clip_r" type="float" default="-1" />
<param index="5" name="outline_size" type="int" default="1" />
<param index="6" name="color" type="Color" default="Color(1, 1, 1, 1)" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
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).
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_fit_to_width">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" default="3" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Fix typos and inconsistencies in classref * Typo fixes. * Navigation agent's `velocity_computed` signal is not emitted by `set_velocity`, but at the end of that frame if `set_velocity` is called. * Simplify link in navigation agent's `avoidance_enabled` description. * Unify `navigation_layers` description across `NavigationAgent{2,3}D`. * Unify `is_normalized()` description across `Vector2`, `Vector3`, and `Vector4` (cherry picked from commit ff97c481d367a8c4e72b6548095ce33c98e4ef33)
2023-03-27 11:29:19 +00:00
Adjusts text width to fit to specified width, returns new text width.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_get_ascent" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_get_carets" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Dictionary" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="position" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns shapes of the carets corresponding to the character offset [param position] in the text. Returned caret shape is 1 pixel wide rectangle.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
[Text Server] Add support for user defined punctuation list, used for word breaking.
2021-03-06 09:52:16 +00:00
<method name="shaped_text_get_custom_punctuation" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Text Server] Add support for user defined punctuation list, used for word breaking.
2021-03-06 09:52:16 +00:00
<description>
Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="shaped_text_get_descent" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_get_direction" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="TextServer.Direction" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns direction of the text.
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="shaped_text_get_dominant_direction_in_range" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="TextServer.Direction" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="start" type="int" />
<param index="2" name="end" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns dominant direction of in the range of text.
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="shaped_text_get_ellipsis_glyph_count" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<description>
Returns number of glyphs in the ellipsis.
</description>
</method>
<method name="shaped_text_get_ellipsis_glyphs" qualifiers="const">
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<return type="Dictionary[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<description>
Returns array of the glyphs in the ellipsis.
</description>
</method>
<method name="shaped_text_get_ellipsis_pos" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<description>
Returns position of the ellipsis.
</description>
</method>
<method name="shaped_text_get_glyph_count" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<description>
Returns number of glyphs in the buffer.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="shaped_text_get_glyphs" qualifiers="const">
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<return type="Dictionary[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
Returns an array of glyphs in the visual order.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Add methods to get position from column and line in TextEdit
2021-11-18 15:55:43 +00:00
<method name="shaped_text_get_grapheme_bounds" qualifiers="const">
<return type="Vector2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="pos" type="int" />
Add methods to get position from column and line in TextEdit
2021-11-18 15:55:43 +00:00
<description>
Returns composite character's bounds as offsets from the start of the line.
</description>
</method>
[TextServer] Improvements for line breaking, "Fill" alignment, overrun, and interaction between these modes. Fix "Fill" alignment processing wrong side of the text if overrun trim was applied. Improve "Fill" alignment to avoid adding excessive subsequent spaces or elongations. Add font detection to the overrun, to correctly add ellipsis (was using last glyph font, which doesn't necessary have dot character). Improve line breaking to avoid adding excessive subsequent soft break points for languages without word separator. Port missing overrun/justification code to the Fallback text server. Fix inferred text direction detection by controls. Add tests for "Fill" alignment and line breaking glyph flags.
2022-01-10 15:24:03 +00:00
<method name="shaped_text_get_inferred_direction" qualifiers="const">
<return type="int" enum="TextServer.Direction" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[TextServer] Improvements for line breaking, "Fill" alignment, overrun, and interaction between these modes. Fix "Fill" alignment processing wrong side of the text if overrun trim was applied. Improve "Fill" alignment to avoid adding excessive subsequent spaces or elongations. Add font detection to the overrun, to correctly add ellipsis (was using last glyph font, which doesn't necessary have dot character). Improve line breaking to avoid adding excessive subsequent soft break points for languages without word separator. Port missing overrun/justification code to the Fallback text server. Fix inferred text direction detection by controls. Add tests for "Fill" alignment and line breaking glyph flags.
2022-01-10 15:24:03 +00:00
<description>
Returns direction of the text, inferred by the BiDi algorithm.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="shaped_text_get_line_breaks" qualifiers="const">
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<return type="PackedInt32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="width" type="float" />
<param index="2" name="start" type="int" default="0" />
<param index="3" name="break_flags" type="int" enum="TextServer.LineBreakFlag" default="3" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Breaks text to the lines and returns character ranges for each line.
</description>
</method>
<method name="shaped_text_get_line_breaks_adv" qualifiers="const">
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<return type="PackedInt32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="width" type="PackedFloat32Array" />
<param index="2" name="start" type="int" default="0" />
<param index="3" name="once" type="bool" default="true" />
<param index="4" name="break_flags" type="int" enum="TextServer.LineBreakFlag" default="3" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Breaks text to the lines and columns. Returns character ranges for each segment.
</description>
</method>
<method name="shaped_text_get_object_rect" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="key" type="Variant" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns bounding rectangle of the inline object.
</description>
</method>
<method name="shaped_text_get_objects" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns array of inline objects.
</description>
</method>
<method name="shaped_text_get_orientation" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="TextServer.Orientation" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns text orientation.
</description>
</method>
<method name="shaped_text_get_parent" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
Returns the parent buffer from which the substring originates.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_get_preserve_control" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns [code]true[/code] if text buffer is configured to display control characters.
</description>
</method>
<method name="shaped_text_get_preserve_invalid" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] If set to [code]false[/code], nothing is displayed in place of invalid characters.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_get_range" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns substring buffer character range in the parent buffer.
</description>
</method>
<method name="shaped_text_get_selection" qualifiers="const">
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<return type="PackedVector2Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="start" type="int" />
<param index="2" name="end" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns selection rectangles for the specified character range.
</description>
</method>
<method name="shaped_text_get_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns size of the text.
</description>
</method>
Refactor Font configuration and import UI, and Font resources.
2022-05-09 09:47:10 +00:00
<method name="shaped_text_get_spacing" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="spacing" type="int" enum="TextServer.SpacingType" />
Refactor Font configuration and import UI, and Font resources.
2022-05-09 09:47:10 +00:00
<description>
Returns extra spacing added between glyphs or lines in pixels.
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="shaped_text_get_trim_pos" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<description>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
Returns the position of the overrun trim.
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="shaped_text_get_underline_position" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns pixel offset of the underline below the baseline.
</description>
</method>
<method name="shaped_text_get_underline_thickness" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns thickness of the underline.
</description>
</method>
<method name="shaped_text_get_width" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns width (for horizontal layout) or height (for vertical) of the text.
</description>
</method>
<method name="shaped_text_get_word_breaks" qualifiers="const">
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<return type="PackedInt32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="grapheme_flags" type="int" enum="TextServer.GraphemeFlag" default="264" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Breaks text into words and returns array of character ranges. Use [param grapheme_flags] to set what characters are used for breaking (see [enum GraphemeFlag]).
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_hit_test_grapheme" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="coords" type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found.
</description>
</method>
<method name="shaped_text_hit_test_position" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="coords" type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
</description>
</method>
<method name="shaped_text_is_ready" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns [code]true[/code] if buffer is successfully shaped.
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="shaped_text_next_grapheme_pos" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="pos" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns composite character end position closest to the [param pos].
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
<method name="shaped_text_overrun_trim_to_width">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="width" type="float" default="0" />
<param index="2" name="overrun_trim_flags" type="int" enum="TextServer.TextOverrunFlag" default="0" />
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
<description>
Trims text if it exceeds the given width.
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="shaped_text_prev_grapheme_pos" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="pos" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns composite character start position closest to the [param pos].
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_resize_object">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<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" default="5" />
[RTL/TextServer] Add baseline inline alignment mode for objects and RTL tables.
2022-12-08 20:01:07 +00:00
<param index="4" name="baseline" type="float" default="0.0" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Sets new size and alignment of embedded object.
</description>
</method>
<method name="shaped_text_set_bidi_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="override" type="Array" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<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>
[Text Server] Add support for user defined punctuation list, used for word breaking.
2021-03-06 09:52:16 +00:00
<method name="shaped_text_set_custom_punctuation">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="punct" type="String" />
[Text Server] Add support for user defined punctuation list, used for word breaking.
2021-03-06 09:52:16 +00:00
<description>
Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="shaped_text_set_direction">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="direction" type="int" enum="TextServer.Direction" default="0" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Style: Misc docs and comment style and language fixes - Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-01 14:29:38 +00:00
Sets desired text direction. If set to [constant DIRECTION_AUTO], direction will be detected based on the buffer contents and current locale.
[TextServer] Implement locale and context sensitive case conversion functions.
2022-01-17 08:54:45 +00:00
[b]Note:[/b] Direction is ignored if server does not support [constant FEATURE_BIDI_LAYOUT] feature (supported by [TextServerAdvanced]).
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_set_orientation">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="orientation" type="int" enum="TextServer.Orientation" default="0" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Sets desired text orientation.
[TextServer] Implement locale and context sensitive case conversion functions.
2022-01-17 08:54:45 +00:00
[b]Note:[/b] Orientation is ignored if server does not support [constant FEATURE_VERTICAL_LAYOUT] feature (supported by [TextServerAdvanced]).
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_set_preserve_control">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="enabled" type="bool" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
If set to [code]true[/code] text buffer will display control characters.
</description>
</method>
<method name="shaped_text_set_preserve_invalid">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="enabled" type="bool" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
</description>
</method>
Refactor Font configuration and import UI, and Font resources.
2022-05-09 09:47:10 +00:00
<method name="shaped_text_set_spacing">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="spacing" type="int" enum="TextServer.SpacingType" />
<param index="2" name="value" type="int" />
Refactor Font configuration and import UI, and Font resources.
2022-05-09 09:47:10 +00:00
<description>
Sets extra spacing added between glyphs or lines in pixels.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="shaped_text_shape">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="shaped_text_sort_logical">
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<return type="Dictionary[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<description>
Returns text glyphs in the logical order.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="shaped_text_substr" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="start" type="int" />
<param index="2" name="length" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns text buffer for the substring of the text in the [param shaped] text buffer (including inline objects).
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="shaped_text_tab_align">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shaped" type="RID" />
<param index="1" name="tab_stops" type="PackedFloat32Array" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Aligns shaped text to the given tab-stops.
</description>
</method>
[TextServer] Add ICU Unicode security and spoofing detection.
2021-11-12 08:12:37 +00:00
<method name="spoof_check" qualifiers="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="string" type="String" />
[TextServer] Add ICU Unicode security and spoofing detection.
2021-11-12 08:12:37 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if [param string] is likely to be an attempt at confusing the reader.
[TextServer] Add ICU Unicode security and spoofing detection.
2021-11-12 08:12:37 +00:00
[b]Note:[/b] Always returns [code]false[/code] if the server does not support the [constant FEATURE_UNICODE_SECURITY] feature.
</description>
</method>
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
<method name="string_get_word_breaks" qualifiers="const">
<return type="PackedInt32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="string" type="String" />
<param index="1" name="language" type="String" default="&quot;&quot;" />
Fix String::word_wrap() for long words - Changes `TextServer.string_get_word_breaks()` - Returns pairs of boundary start and end offsets - Accepts `chars_per_line` to return line breaks - Removes `String::word_wrap()` Co-authored-by: bruvzg <7645683+bruvzg@users.noreply.github.com>
2022-08-18 08:20:20 +00:00
<param index="2" name="chars_per_line" type="int" default="0" />
<description>
Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even.
When [param chars_per_line] is greater than zero, line break boundaries are returned instead.
[codeblock]
var ts = TextServerManager.get_primary_interface()
print(ts.string_get_word_breaks("Godot Engine")) # Prints [0, 5, 6, 12]
print(ts.string_get_word_breaks("Godot Engine", "en", 5)) # Prints [0, 5, 6, 11, 11, 12]
[/codeblock]
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
</description>
</method>
[TextServer] Implement locale and context sensitive case conversion functions.
2022-01-17 08:54:45 +00:00
<method name="string_to_lower" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="string" type="String" />
<param index="1" name="language" type="String" default="&quot;&quot;" />
[TextServer] Implement locale and context sensitive case conversion functions.
2022-01-17 08:54:45 +00:00
<description>
Returns the string converted to lowercase.
[b]Note:[/b] Casing is locale dependent and context sensitive if server support [constant FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION] feature (supported by [TextServerAdvanced]).
[b]Note:[/b] The result may be longer or shorter than the original.
</description>
</method>
<method name="string_to_upper" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="string" type="String" />
<param index="1" name="language" type="String" default="&quot;&quot;" />
[TextServer] Implement locale and context sensitive case conversion functions.
2022-01-17 08:54:45 +00:00
<description>
Returns the string converted to uppercase.
[b]Note:[/b] Casing is locale dependent and context sensitive if server support [constant FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION] feature (supported by [TextServerAdvanced]).
[b]Note:[/b] The result may be longer or shorter than the original.
</description>
</method>
Implement TextServer `strip_diacritics` function.
2021-10-12 18:36:08 +00:00
<method name="strip_diacritics" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="string" type="String" />
Implement TextServer `strip_diacritics` function.
2021-10-12 18:36:08 +00:00
<description>
Strips diacritics from the string.
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
[b]Note:[/b] The result may be longer or shorter than the original.
Implement TextServer `strip_diacritics` function.
2021-10-12 18:36:08 +00:00
</description>
</method>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<method name="tag_to_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tag" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Converts OpenType tag to readable feature, variation, script or language name.
</description>
</method>
</methods>
<constants>
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
<constant name="FONT_ANTIALIASING_NONE" value="0" enum="FontAntialiasing">
Font glyphs are rasterized as 1-bit bitmaps.
</constant>
<constant name="FONT_ANTIALIASING_GRAY" value="1" enum="FontAntialiasing">
Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
</constant>
<constant name="FONT_ANTIALIASING_LCD" value="2" enum="FontAntialiasing">
Font glyphs are rasterized for LCD screens.
Hide Antialiasing import option on DynamicFonts with MSDF enabled Antialiasing cannot be adjusted on fonts rendered with MSDF. Internally, Godot always uses grayscale antialiasing for those fonts. This also tweaks property hints for consistency, and renames uses of "sub-pixel" to the more commonly used "subpixel".
2022-11-03 17:37:21 +00:00
LCD subpixel layout is determined by the value of [code]gui/theme/lcd_subpixel_layout[/code] project settings.
LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
</constant>
<constant name="FONT_LCD_SUBPIXEL_LAYOUT_NONE" value="0" enum="FontLCDSubpixelLayout">
Hide Antialiasing import option on DynamicFonts with MSDF enabled Antialiasing cannot be adjusted on fonts rendered with MSDF. Internally, Godot always uses grayscale antialiasing for those fonts. This also tweaks property hints for consistency, and renames uses of "sub-pixel" to the more commonly used "subpixel".
2022-11-03 17:37:21 +00:00
Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
</constant>
<constant name="FONT_LCD_SUBPIXEL_LAYOUT_HRGB" value="1" enum="FontLCDSubpixelLayout">
Hide Antialiasing import option on DynamicFonts with MSDF enabled Antialiasing cannot be adjusted on fonts rendered with MSDF. Internally, Godot always uses grayscale antialiasing for those fonts. This also tweaks property hints for consistency, and renames uses of "sub-pixel" to the more commonly used "subpixel".
2022-11-03 17:37:21 +00:00
Horizontal RGB subpixel layout.
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
</constant>
<constant name="FONT_LCD_SUBPIXEL_LAYOUT_HBGR" value="2" enum="FontLCDSubpixelLayout">
Hide Antialiasing import option on DynamicFonts with MSDF enabled Antialiasing cannot be adjusted on fonts rendered with MSDF. Internally, Godot always uses grayscale antialiasing for those fonts. This also tweaks property hints for consistency, and renames uses of "sub-pixel" to the more commonly used "subpixel".
2022-11-03 17:37:21 +00:00
Horizontal BGR subpixel layout.
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
</constant>
<constant name="FONT_LCD_SUBPIXEL_LAYOUT_VRGB" value="3" enum="FontLCDSubpixelLayout">
Hide Antialiasing import option on DynamicFonts with MSDF enabled Antialiasing cannot be adjusted on fonts rendered with MSDF. Internally, Godot always uses grayscale antialiasing for those fonts. This also tweaks property hints for consistency, and renames uses of "sub-pixel" to the more commonly used "subpixel".
2022-11-03 17:37:21 +00:00
Vertical RGB subpixel layout.
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
</constant>
<constant name="FONT_LCD_SUBPIXEL_LAYOUT_VBGR" value="4" enum="FontLCDSubpixelLayout">
Hide Antialiasing import option on DynamicFonts with MSDF enabled Antialiasing cannot be adjusted on fonts rendered with MSDF. Internally, Godot always uses grayscale antialiasing for those fonts. This also tweaks property hints for consistency, and renames uses of "sub-pixel" to the more commonly used "subpixel".
2022-11-03 17:37:21 +00:00
Vertical BGR subpixel layout.
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
</constant>
[GDExtension] Use function names with underscore for TextServer extension, add macros to generate wrappers for module functions.
2022-09-27 08:23:34 +00:00
<constant name="FONT_LCD_SUBPIXEL_LAYOUT_MAX" value="5" enum="FontLCDSubpixelLayout">
</constant>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<constant name="DIRECTION_AUTO" value="0" enum="Direction">
Text direction is determined based on contents and current locale.
</constant>
<constant name="DIRECTION_LTR" value="1" enum="Direction">
Text is written from left to right.
</constant>
<constant name="DIRECTION_RTL" value="2" enum="Direction">
Text is written from right to left.
</constant>
Implement BiDi override mode for GDScript source.
2023-01-18 07:33:35 +00:00
<constant name="DIRECTION_INHERITED" value="3" enum="Direction">
Text writing direction is the same as base string writing direction. Used for BiDi override only.
</constant>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<constant name="ORIENTATION_HORIZONTAL" value="0" enum="Orientation">
Text is written horizontally.
</constant>
<constant name="ORIENTATION_VERTICAL" value="1" enum="Orientation">
Left to right text is written vertically from top to bottom.
Right to left text is written vertically from bottom to top.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="JUSTIFICATION_NONE" value="0" enum="JustificationFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Do not justify text.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="JUSTIFICATION_KASHIDA" value="1" enum="JustificationFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Justify text by adding and removing kashidas.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="JUSTIFICATION_WORD_BOUND" value="2" enum="JustificationFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Justify text by changing width of the spaces between the words.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="JUSTIFICATION_TRIM_EDGE_SPACES" value="4" enum="JustificationFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Remove trailing and leading spaces from the justified text.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="JUSTIFICATION_AFTER_LAST_TAB" value="8" enum="JustificationFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Only apply justification to the part of the text after the last tab.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="JUSTIFICATION_CONSTRAIN_ELLIPSIS" value="16" enum="JustificationFlag" is_bitfield="true">
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Apply justification to the trimmed line with ellipsis.
</constant>
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 08:01:45 +00:00
<constant name="AUTOWRAP_OFF" value="0" enum="AutowrapMode">
Autowrap is disabled.
</constant>
<constant name="AUTOWRAP_ARBITRARY" value="1" enum="AutowrapMode">
Wraps the text inside the node's bounding rectangle by allowing to break lines at arbitrary positions, which is useful when very limited space is available.
</constant>
<constant name="AUTOWRAP_WORD" value="2" enum="AutowrapMode">
Wraps the text inside the node's bounding rectangle by soft-breaking between words.
</constant>
<constant name="AUTOWRAP_WORD_SMART" value="3" enum="AutowrapMode">
Behaves similarly to [constant AUTOWRAP_WORD], but force-breaks a word if that single word does not fit in one line.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="BREAK_NONE" value="0" enum="LineBreakFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Do not break the line.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="BREAK_MANDATORY" value="1" enum="LineBreakFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Break the line at the line mandatory break characters (e.g. [code]"\n"[/code]).
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="BREAK_WORD_BOUND" value="2" enum="LineBreakFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Break the line between the words.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="BREAK_GRAPHEME_BOUND" value="4" enum="LineBreakFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Break the line between any unconnected graphemes.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="BREAK_ADAPTIVE" value="8" enum="LineBreakFlag" is_bitfield="true">
[TextServer] Add support for trimming edge spaces on line break.
2022-08-30 08:56:17 +00:00
Should be used only in conjunction with [constant BREAK_WORD_BOUND], break the line between any unconnected graphemes, if it's impossible to break it between the words.
</constant>
<constant name="BREAK_TRIM_EDGE_SPACES" value="16" enum="LineBreakFlag" is_bitfield="true">
Remove edge spaces from the broken line segments.
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
</constant>
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 08:01:45 +00:00
<constant name="VC_CHARS_BEFORE_SHAPING" value="0" enum="VisibleCharactersBehavior">
Trims text before the shaping. e.g, increasing [member Label.visible_characters] or [member RichTextLabel.visible_characters] value is visually identical to typing the text.
</constant>
<constant name="VC_CHARS_AFTER_SHAPING" value="1" enum="VisibleCharactersBehavior">
Displays glyphs that are mapped to the first [member Label.visible_characters] or [member RichTextLabel.visible_characters] characters from the beginning of the text.
</constant>
<constant name="VC_GLYPHS_AUTO" value="2" enum="VisibleCharactersBehavior">
Rename Label & RichTextLabel.`percent_visible` to `visible_ratio` Also updates the documentation of both `visible_characters` and `visible_ratio` to, better describe what they do and improve consistency between the two Classes.
2022-08-20 18:06:13 +00:00
Displays [member Label.visible_ratio] or [member RichTextLabel.visible_ratio] glyphs, starting from the left or from the right, depending on [member Control.layout_direction] value.
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 08:01:45 +00:00
</constant>
<constant name="VC_GLYPHS_LTR" value="3" enum="VisibleCharactersBehavior">
Rename Label & RichTextLabel.`percent_visible` to `visible_ratio` Also updates the documentation of both `visible_characters` and `visible_ratio` to, better describe what they do and improve consistency between the two Classes.
2022-08-20 18:06:13 +00:00
Displays [member Label.visible_ratio] or [member RichTextLabel.visible_ratio] glyphs, starting from the left.
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 08:01:45 +00:00
</constant>
<constant name="VC_GLYPHS_RTL" value="4" enum="VisibleCharactersBehavior">
Rename Label & RichTextLabel.`percent_visible` to `visible_ratio` Also updates the documentation of both `visible_characters` and `visible_ratio` to, better describe what they do and improve consistency between the two Classes.
2022-08-20 18:06:13 +00:00
Displays [member Label.visible_ratio] or [member RichTextLabel.visible_ratio] glyphs, starting from the right.
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 08:01:45 +00:00
</constant>
<constant name="OVERRUN_NO_TRIMMING" value="0" enum="OverrunBehavior">
No text trimming is performed.
</constant>
<constant name="OVERRUN_TRIM_CHAR" value="1" enum="OverrunBehavior">
Trims the text per character.
</constant>
<constant name="OVERRUN_TRIM_WORD" value="2" enum="OverrunBehavior">
Trims the text per word.
</constant>
<constant name="OVERRUN_TRIM_ELLIPSIS" value="3" enum="OverrunBehavior">
Trims the text per character and adds an ellipsis to indicate that parts are hidden.
</constant>
<constant name="OVERRUN_TRIM_WORD_ELLIPSIS" value="4" enum="OverrunBehavior">
Trims the text per word and adds an ellipsis to indicate that parts are hidden.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="OVERRUN_NO_TRIM" value="0" enum="TextOverrunFlag" is_bitfield="true">
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
No trimming is performed.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="OVERRUN_TRIM" value="1" enum="TextOverrunFlag" is_bitfield="true">
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
Trims the text when it exceeds the given width.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="OVERRUN_TRIM_WORD_ONLY" value="2" enum="TextOverrunFlag" is_bitfield="true">
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
Trims the text per word instead of per grapheme.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="OVERRUN_ADD_ELLIPSIS" value="4" enum="TextOverrunFlag" is_bitfield="true">
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
Determines whether an ellipsis should be added at the end of the text.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="OVERRUN_ENFORCE_ELLIPSIS" value="8" enum="TextOverrunFlag" is_bitfield="true">
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 14:43:55 +00:00
Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="OVERRUN_JUSTIFICATION_AWARE" value="16" enum="TextOverrunFlag" is_bitfield="true">
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_VALID" value="1" enum="GraphemeFlag" is_bitfield="true">
Fix various typos Found via ` codespell -q 3 -S ./thirdparty,*.po,./DONORS.md -L ackward,ang,ans,ba,beng,cas,childs,childrens,dof,doubleclick,expct,fave,findn,gird,hist,inout,leapyear,lod,nd,numer,ois,ony,paket,seeked,sinc,switchs,te,uint,varn` Update editor/import/resource_importer_layered_texture.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update doc/classes/TileSetScenesCollectionSource.xml Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/graph_edit.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/resources/animation.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Update scene/gui/rich_text_label.cpp Co-authored-by: Raul Santos <raulsntos@gmail.com> Revert previously committed change
2022-01-02 06:03:58 +00:00
Grapheme is supported by the font, and can be drawn.
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_RTL" value="2" enum="GraphemeFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Grapheme is part of right-to-left or bottom-to-top run.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_VIRTUAL" value="4" enum="GraphemeFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Grapheme is not part of source text, it was added by justification process.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_SPACE" value="8" enum="GraphemeFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Grapheme is whitespace.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_BREAK_HARD" value="16" enum="GraphemeFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Grapheme is mandatory break point (e.g. [code]"\n"[/code]).
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_BREAK_SOFT" value="32" enum="GraphemeFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Grapheme is optional break point (e.g. space).
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_TAB" value="64" enum="GraphemeFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Grapheme is the tabulation character.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_ELONGATION" value="128" enum="GraphemeFlag" is_bitfield="true">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Grapheme is kashida.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_PUNCTUATION" value="256" enum="GraphemeFlag" is_bitfield="true">
Add word breaks on punctuation characters.
2020-12-14 08:30:32 +00:00
Grapheme is punctuation character.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_UNDERSCORE" value="512" enum="GraphemeFlag" is_bitfield="true">
Add flag to connected grapheme. Apply RTL displacement FX only to the whole connected grapheme. Pass more glyph info to the custom RTL FX.
2021-09-21 09:27:06 +00:00
Grapheme is underscore character.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="GRAPHEME_IS_CONNECTED" value="1024" enum="GraphemeFlag" is_bitfield="true">
Add flag to connected grapheme. Apply RTL displacement FX only to the whole connected grapheme. Pass more glyph info to the custom RTL FX.
2021-09-21 09:27:06 +00:00
Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
</constant>
HarfBuzz: Update to version 5.1.0, use new FLAG_SAFE_TO_INSERT_TATWEEL flag to improve justification.
2022-08-04 05:16:56 +00:00
<constant name="GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL" value="2048" enum="GraphemeFlag" is_bitfield="true">
It is safe to insert a U+0640 before this grapheme for elongation.
</constant>
[TextServer] Use dedicated flag for object replacement characters. (cherry picked from commit d904516e553426dae1fa40566e3fe67f6213e769)
2023-04-12 07:08:51 +00:00
<constant name="GRAPHEME_IS_EMBEDDED_OBJECT" value="4096" enum="GraphemeFlag" is_bitfield="true">
Grapheme is an object replacement character for the embedded object.
</constant>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<constant name="HINTING_NONE" value="0" enum="Hinting">
Disables font hinting (smoother but less crisp).
</constant>
<constant name="HINTING_LIGHT" value="1" enum="Hinting">
Use the light font hinting mode.
</constant>
<constant name="HINTING_NORMAL" value="2" enum="Hinting">
Use the default font hinting mode (crisper but less smooth).
Do not use horizontal hinting for the editor monospace font.
2022-09-14 08:05:09 +00:00
[b]Note:[/b] This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</constant>
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
<constant name="SUBPIXEL_POSITIONING_DISABLED" value="0" enum="SubpixelPositioning">
Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
</constant>
<constant name="SUBPIXEL_POSITIONING_AUTO" value="1" enum="SubpixelPositioning">
Glyph horizontal position is rounded based on font size.
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
- To one quarter of the pixel size if font size is smaller or equal to [constant SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE].
- To one half of the pixel size if font size is smaller or equal to [constant SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE].
Add sub-pixel glyph positioning support.
2022-01-10 08:13:22 +00:00
- To the whole pixel size for larger fonts.
</constant>
<constant name="SUBPIXEL_POSITIONING_ONE_HALF" value="2" enum="SubpixelPositioning">
Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
</constant>
<constant name="SUBPIXEL_POSITIONING_ONE_QUARTER" value="3" enum="SubpixelPositioning">
Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
</constant>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
<constant name="SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE" value="20" enum="SubpixelPositioning">
Improve the `make_rst.py` parser for BBCode tags
2022-08-09 20:53:29 +00:00
Maximum font size which will use one half of the pixel subpixel positioning in [constant SUBPIXEL_POSITIONING_AUTO] mode.
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
</constant>
<constant name="SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE" value="16" enum="SubpixelPositioning">
Improve the `make_rst.py` parser for BBCode tags
2022-08-09 20:53:29 +00:00
Maximum font size which will use one quarter of the pixel subpixel positioning in [constant SUBPIXEL_POSITIONING_AUTO] mode.
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
</constant>
<constant name="FEATURE_SIMPLE_LAYOUT" value="1" enum="Feature">
TextServer supports simple text layouts.
</constant>
<constant name="FEATURE_BIDI_LAYOUT" value="2" enum="Feature">
TextServer supports bidirectional text layouts.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</constant>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
<constant name="FEATURE_VERTICAL_LAYOUT" value="4" enum="Feature">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
TextServer supports vertical layouts.
</constant>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
<constant name="FEATURE_SHAPING" value="8" enum="Feature">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
TextServer supports complex text shaping.
</constant>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
<constant name="FEATURE_KASHIDA_JUSTIFICATION" value="16" enum="Feature">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
TextServer supports justification using kashidas.
</constant>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
<constant name="FEATURE_BREAK_ITERATORS" value="32" enum="Feature">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
TextServer supports complex line/word breaking rules (e.g. dictionary based).
</constant>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
<constant name="FEATURE_FONT_BITMAP" value="64" enum="Feature">
TextServer supports loading bitmap fonts.
</constant>
<constant name="FEATURE_FONT_DYNAMIC" value="128" enum="Feature">
TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
</constant>
<constant name="FEATURE_FONT_MSDF" value="256" enum="Feature">
TextServer supports multichannel signed distance field dynamic font rendering.
</constant>
<constant name="FEATURE_FONT_SYSTEM" value="512" enum="Feature">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
TextServer supports loading system fonts.
</constant>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
<constant name="FEATURE_FONT_VARIABLE" value="1024" enum="Feature">
[Complex Text Layouts] Add variable fonts support.
2020-10-22 16:40:18 +00:00
TextServer supports variable fonts.
</constant>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
<constant name="FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION" value="2048" enum="Feature">
[TextServer] Implement locale and context sensitive case conversion functions.
2022-01-17 08:54:45 +00:00
TextServer supports locale dependent and context sensitive case conversion.
</constant>
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
<constant name="FEATURE_USE_SUPPORT_DATA" value="4096" enum="Feature">
[TextServer] Implement ICU/UAX 31 based `is_valid_identifier` function.
2021-10-18 12:07:11 +00:00
TextServer require external data file for some features, see [method load_support_data].
</constant>
<constant name="FEATURE_UNICODE_IDENTIFIERS" value="8192" enum="Feature">
TextServer supports UAX #31 identifier validation, see [method is_valid_identifier].
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</constant>
[TextServer] Add ICU Unicode security and spoofing detection.
2021-11-12 08:12:37 +00:00
<constant name="FEATURE_UNICODE_SECURITY" value="16384" enum="Feature">
TextServer supports [url=https://unicode.org/reports/tr36/]Unicode Technical Report #36[/url] and [url=https://unicode.org/reports/tr39/]Unicode Technical Standard #39[/url] based spoof detection features.
</constant>
[Complex Text Layouts] Provide access to glyph contour points.
2020-12-10 15:30:25 +00:00
<constant name="CONTOUR_CURVE_TAG_ON" value="1" enum="ContourPointTag">
Contour point is on the curve.
</constant>
<constant name="CONTOUR_CURVE_TAG_OFF_CONIC" value="0" enum="ContourPointTag">
Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bézier arc.
</constant>
<constant name="CONTOUR_CURVE_TAG_OFF_CUBIC" value="2" enum="ContourPointTag">
Contour point isn't on the curve, but serves as a control point for a cubic Bézier arc.
</constant>
Makes FontData importable resource. Adds multi-channel SDF font texture generation and rendering support. Adds per-font oversampling support. Adds FontData import plugins (for dynamic fonts, BMFonts and monospaced image fonts), font texture cache pre-generation and loading. Adds BMFont binary format and outline support.
2020-12-27 13:30:33 +00:00
<constant name="SPACING_GLYPH" value="0" enum="SpacingType">
Spacing for each glyph.
</constant>
<constant name="SPACING_SPACE" value="1" enum="SpacingType">
Spacing for the space character.
</constant>
<constant name="SPACING_TOP" value="2" enum="SpacingType">
Spacing at the top of the line.
</constant>
<constant name="SPACING_BOTTOM" value="3" enum="SpacingType">
Spacing at the bottom of the line.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="SPACING_MAX" value="4" enum="SpacingType">
</constant>
<constant name="FONT_BOLD" value="1" enum="FontStyle" is_bitfield="true">
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
Font is bold.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="FONT_ITALIC" value="2" enum="FontStyle" is_bitfield="true">
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
Font is italic or oblique.
</constant>
Use BitField hint for the TextServer enums. Add missing parts for BitField support to the GDextension API.
2022-07-11 09:40:31 +00:00
<constant name="FONT_FIXED_WIDTH" value="4" enum="FontStyle" is_bitfield="true">
Add functions for getting name and font style from dynamic and bitmap fonts. Add font selection toolbar editor plugin.
2021-10-26 06:40:11 +00:00
Font have fixed-width characters.
</constant>
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<constant name="STRUCTURED_TEXT_DEFAULT" value="0" enum="StructuredTextParser">
Implement BiDi override mode for GDScript source.
2023-01-18 07:33:35 +00:00
Use default Unicode BiDi algorithm.
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
</constant>
<constant name="STRUCTURED_TEXT_URI" value="1" enum="StructuredTextParser">
BiDi override for URI.
</constant>
<constant name="STRUCTURED_TEXT_FILE" value="2" enum="StructuredTextParser">
BiDi override for file path.
</constant>
<constant name="STRUCTURED_TEXT_EMAIL" value="3" enum="StructuredTextParser">
BiDi override for email.
</constant>
<constant name="STRUCTURED_TEXT_LIST" value="4" enum="StructuredTextParser">
BiDi override for lists.
Structured text options: list separator [code]String[/code].
</constant>
Implement BiDi override mode for GDScript source.
2023-01-18 07:33:35 +00:00
<constant name="STRUCTURED_TEXT_GDSCRIPT" value="5" enum="StructuredTextParser">
BiDi override for GDScript.
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
</constant>
<constant name="STRUCTURED_TEXT_CUSTOM" value="6" enum="StructuredTextParser">
User defined structured text BiDi override function.
</constant>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</constants>
</class>