summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorbruvzg <7645683+bruvzg@users.noreply.github.com>2020-09-03 14:22:16 +0300
committerbruvzg <7645683+bruvzg@users.noreply.github.com>2020-11-26 14:25:48 +0200
commit99666de00fb30cb86473257776504ca70b4469c3 (patch)
tree6ad5723c1a429e82b8b4b12cc10f2bec3102cac3 /doc/classes
parent07d14f5bb8e8a2cb3b2137d1ef4fb6c3b46c0873 (diff)
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface.
Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/BitmapFont.xml112
-rw-r--r--doc/classes/DynamicFontData.xml36
-rw-r--r--doc/classes/Font.xml128
-rw-r--r--doc/classes/Label.xml2
4 files changed, 1 insertions, 277 deletions
diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml
deleted file mode 100644
index 87cffdaca0..0000000000
--- a/doc/classes/BitmapFont.xml
+++ /dev/null
@@ -1,112 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="BitmapFont" inherits="Font" version="4.0">
- <brief_description>
- Renders text using fonts under the [url=https://www.angelcode.com/products/bmfont/]BMFont[/url] format.
- Handles files with the [code].fnt[/code] extension.
- </brief_description>
- <description>
- Renders text using [code]*.fnt[/code] fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see [DynamicFont].
- </description>
- <tutorials>
- </tutorials>
- <methods>
- <method name="add_char">
- <return type="void">
- </return>
- <argument index="0" name="character" type="int">
- </argument>
- <argument index="1" name="texture" type="int">
- </argument>
- <argument index="2" name="rect" type="Rect2">
- </argument>
- <argument index="3" name="align" type="Vector2" default="Vector2( 0, 0 )">
- </argument>
- <argument index="4" name="advance" type="float" default="-1">
- </argument>
- <description>
- Adds a character to the font, where [code]character[/code] is the Unicode value, [code]texture[/code] is the texture index, [code]rect[/code] is the region in the texture (in pixels!), [code]align[/code] is the (optional) alignment for the character and [code]advance[/code] is the (optional) advance.
- </description>
- </method>
- <method name="add_kerning_pair">
- <return type="void">
- </return>
- <argument index="0" name="char_a" type="int">
- </argument>
- <argument index="1" name="char_b" type="int">
- </argument>
- <argument index="2" name="kerning" type="int">
- </argument>
- <description>
- Adds a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
- </description>
- </method>
- <method name="add_texture">
- <return type="void">
- </return>
- <argument index="0" name="texture" type="Texture2D">
- </argument>
- <description>
- Adds a texture to the [BitmapFont].
- </description>
- </method>
- <method name="clear">
- <return type="void">
- </return>
- <description>
- Clears all the font data and settings.
- </description>
- </method>
- <method name="create_from_fnt">
- <return type="int" enum="Error">
- </return>
- <argument index="0" name="path" type="String">
- </argument>
- <description>
- Creates a BitmapFont from the [code]*.fnt[/code] file at [code]path[/code].
- </description>
- </method>
- <method name="get_kerning_pair" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="char_a" type="int">
- </argument>
- <argument index="1" name="char_b" type="int">
- </argument>
- <description>
- Returns a kerning pair as a difference.
- </description>
- </method>
- <method name="get_texture" qualifiers="const">
- <return type="Texture2D">
- </return>
- <argument index="0" name="idx" type="int">
- </argument>
- <description>
- Returns the font atlas texture at index [code]idx[/code].
- </description>
- </method>
- <method name="get_texture_count" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the number of textures in the BitmapFont atlas.
- </description>
- </method>
- </methods>
- <members>
- <member name="ascent" type="float" setter="set_ascent" getter="get_ascent" default="0.0">
- Ascent (number of pixels above the baseline).
- </member>
- <member name="distance_field" type="bool" setter="set_distance_field_hint" getter="is_distance_field_hint" default="false">
- If [code]true[/code], distance field hint is enabled.
- </member>
- <member name="fallback" type="BitmapFont" setter="set_fallback" getter="get_fallback">
- The fallback font.
- </member>
- <member name="height" type="float" setter="set_height" getter="get_height" default="1.0">
- Total font height (ascent plus descent) in pixels.
- </member>
- </members>
- <constants>
- </constants>
-</class>
diff --git a/doc/classes/DynamicFontData.xml b/doc/classes/DynamicFontData.xml
deleted file mode 100644
index 45585f17e0..0000000000
--- a/doc/classes/DynamicFontData.xml
+++ /dev/null
@@ -1,36 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="DynamicFontData" inherits="Resource" version="4.0">
- <brief_description>
- Used with [DynamicFont] to describe the location of a font file.
- </brief_description>
- <description>
- Used with [DynamicFont] to describe the location of a vector font file for dynamic rendering at runtime.
- </description>
- <tutorials>
- <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
- </tutorials>
- <methods>
- </methods>
- <members>
- <member name="antialiased" type="bool" setter="set_antialiased" getter="is_antialiased" default="true">
- If [code]true[/code], the font is rendered with anti-aliasing. This property applies both to the main font and its outline (if it has one).
- </member>
- <member name="font_path" type="String" setter="set_font_path" getter="get_font_path" default="&quot;&quot;">
- The path to the vector font file.
- </member>
- <member name="hinting" type="int" setter="set_hinting" getter="get_hinting" enum="DynamicFontData.Hinting" default="2">
- The font hinting mode used by FreeType. See [enum Hinting] for options.
- </member>
- </members>
- <constants>
- <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).
- </constant>
- </constants>
-</class>
diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml
deleted file mode 100644
index f49fbf0d2a..0000000000
--- a/doc/classes/Font.xml
+++ /dev/null
@@ -1,128 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="Font" inherits="Resource" version="4.0">
- <brief_description>
- Internationalized font and text drawing support.
- </brief_description>
- <description>
- Font contains a Unicode-compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts.
- [b]Note:[/b] If a DynamicFont doesn't contain a character used in a string, the character in question will be replaced with codepoint [code]0xfffd[/code] if it's available in the DynamicFont. If this replacement character isn't available in the DynamicFont, the character will be hidden without displaying any replacement character in the string.
- [b]Note:[/b] If a BitmapFont doesn't contain a character used in a string, the character in question will be hidden without displaying any replacement character in the string.
- </description>
- <tutorials>
- </tutorials>
- <methods>
- <method name="draw" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="canvas_item" type="RID">
- </argument>
- <argument index="1" name="position" type="Vector2">
- </argument>
- <argument index="2" name="string" type="String">
- </argument>
- <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
- </argument>
- <argument index="4" name="clip_w" type="int" default="-1">
- </argument>
- <argument index="5" name="outline_modulate" type="Color" default="Color( 1, 1, 1, 1 )">
- </argument>
- <description>
- Draw [code]string[/code] into a canvas item using the font at a given position, with [code]modulate[/code] color, and optionally clipping the width. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis.
- See also [method CanvasItem.draw_string].
- </description>
- </method>
- <method name="draw_char" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="canvas_item" type="RID">
- </argument>
- <argument index="1" name="position" type="Vector2">
- </argument>
- <argument index="2" name="char" type="int">
- </argument>
- <argument index="3" name="next" type="int" default="-1">
- </argument>
- <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
- </argument>
- <argument index="5" name="outline" type="bool" default="false">
- </argument>
- <description>
- Draw character [code]char[/code] into a canvas item using the font at a given position, with [code]modulate[/code] color, and optionally kerning if [code]next[/code] is passed. clipping the width. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.
- </description>
- </method>
- <method name="get_ascent" qualifiers="const">
- <return type="float">
- </return>
- <description>
- Returns the font ascent (number of pixels above the baseline).
- </description>
- </method>
- <method name="get_char_size" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="char" type="int">
- </argument>
- <argument index="1" name="next" type="int" default="0">
- </argument>
- <description>
- Returns the size of a character, optionally taking kerning into account if the next character is provided.
- </description>
- </method>
- <method name="get_descent" qualifiers="const">
- <return type="float">
- </return>
- <description>
- Returns the font descent (number of pixels below the baseline).
- </description>
- </method>
- <method name="get_height" qualifiers="const">
- <return type="float">
- </return>
- <description>
- Returns the total font height (ascent plus descent) in pixels.
- </description>
- </method>
- <method name="get_string_size" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="string" type="String">
- </argument>
- <description>
- Returns the size of a string, taking kerning and advance into account.
- </description>
- </method>
- <method name="get_wordwrap_string_size" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="string" type="String">
- </argument>
- <argument index="1" name="width" type="float">
- </argument>
- <description>
- Returns the size that the string would have with word wrapping enabled with a fixed [code]width[/code].
- </description>
- </method>
- <method name="has_outline" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the font has an outline.
- </description>
- </method>
- <method name="is_distance_field_hint" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- </description>
- </method>
- <method name="update_changes">
- <return type="void">
- </return>
- <description>
- After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.
- </description>
- </method>
- </methods>
- <constants>
- </constants>
-</class>
diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml
index 570d7f075b..01719ecbfd 100644
--- a/doc/classes/Label.xml
+++ b/doc/classes/Label.xml
@@ -111,7 +111,7 @@
[Color] of the text's shadow effect.
</theme_item>
<theme_item name="font_outline_modulate" type="Color" default="Color( 1, 1, 1, 1 )">
- The tint of [Font]'s outline. See [member DynamicFont.outline_color].
+ The tint of [Font]'s outline.
</theme_item>
<theme_item name="line_spacing" type="int" default="3">
Vertical space between lines in multiline [Label].