Internationalized font and text drawing support.
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.
Note: If a DynamicFont doesn't contain a character used in a string, the character in question will be replaced with codepoint
0xfffd 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.
Note: 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.
|void||draw ( RID canvas_item, Vector2 position, String string, Color modulate=Color( 1, 1, 1, 1 ), int clip_w=-1, Color outline_modulate=Color( 1, 1, 1, 1 ) ) const|
|float||draw_char ( RID canvas_item, Vector2 position, int char, int next=-1, Color modulate=Color( 1, 1, 1, 1 ), bool outline=false ) const|
|float||get_ascent ( ) const|
|Vector2||get_char_size ( int char, int next=0 ) const|
|float||get_descent ( ) const|
|float||get_height ( ) const|
|Vector2||get_string_size ( String string ) const|
|Vector2||get_wordwrap_string_size ( String string, float width ) const|
|bool||has_outline ( ) const|
|bool||is_distance_field_hint ( ) const|
|void||update_changes ( )|
string into a canvas item using the font at a given position, with
modulate color, and optionally clipping the width.
position specifies the baseline, not the top. To draw from the top, ascent must be added to the Y axis.
See also CanvasItem.draw_string.
char into a canvas item using the font at a given position, with
modulate color, and optionally kerning if
next is passed. clipping the width.
position specifies the baseline, not the top. To draw from the top, ascent 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.
Returns the font ascent (number of pixels above the baseline).
Returns the size of a character, optionally taking kerning into account if the next character is provided.
Returns the font descent (number of pixels below the baseline).
Returns the total font height (ascent plus descent) in pixels.
Returns the size of a string, taking kerning and advance into account.
Returns the size that the string would have with word wrapping enabled with a fixed
true if the font has an outline.
After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.
© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.