From c040e8f93a31861c533a56e5430879b43e05f597 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 15 Jul 2020 10:13:47 +0200 Subject: [PATCH] Document missing character behavior when drawing text with fonts See #40405. (cherry picked from commit 7735d8d0ce89d305ef5b45037220c7b240dec8f0) --- doc/classes/DynamicFont.xml | 2 +- doc/classes/Font.xml | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index 1a5d757bfc7..b67f0319b34 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -4,7 +4,7 @@ DynamicFont renders vector font files at runtime. - DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths. DynamicFont also supports defining one or more fallbacks fonts, which will be used when displaying a character not supported by the main font. + DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths. DynamicFont also supports defining one or more fallback fonts, which will be used when displaying a character not supported by the main font. DynamicFont uses the [url=https://www.freetype.org/]FreeType[/url] library for rasterization. [codeblock] var dynamic_font = DynamicFont.new() diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index 297834cef0d..a3a2a09a4a7 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -5,6 +5,8 @@ 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.