Struct Font
Internationalized font and text drawing support.
struct Font
;
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.
Methods
| Name | Description |
|---|---|
draw
|
Draw 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.
|
drawChar
|
Draw character 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.
|
getAscent
|
Returns the font ascent (number of pixels above the baseline). |
getDescent
|
Returns the font descent (number of pixels below the baseline). |
getHeight
|
Returns the total font height (ascent plus descent) in pixels. |
getStringSize
|
Returns the size of a string, taking kerning and advance into account. |
getWordwrapStringSize
|
|
hasOutline
|
Returns true if the font has an outline.
|
isDistanceFieldHint
|
|
updateChanges
|
After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it. |