Font

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.

@GodotBaseClass

struct Font {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(Font other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static Font _new();

void draw(RID canvas_item, Vector2 position, String string, Color modulate, long clip_w, Color outline_modulate);

double drawChar(RID canvas_item, Vector2 position, long _char, long next, Color modulate, bool outline);

double getAscent();

Vector2 getCharSize(long _char, long next);

double getDescent();

double getHeight();

Vector2 getStringSize(String string);

Vector2 getWordwrapStringSize(String string, double width);

bool hasOutline();

bool isDistanceFieldHint();

void updateChanges();

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

draw void draw(RID canvas_item, Vector2 position, String string, Color modulate, long clip_w, Color outline_modulate): 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. See also CanvasItem.drawString.
drawChar double drawChar(RID canvas_item, Vector2 position, long _char, long next, Color modulate, bool outline): 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 double getAscent(): Returns the font ascent (number of pixels above the baseline).
getCharSize Vector2 getCharSize(long _char, long next): Returns the size of a character, optionally taking kerning into account if the next character is provided. Note that the height returned is the font height (see getHeight) and has no relation to the glyph height.
getDescent double getDescent(): Returns the font descent (number of pixels below the baseline).
getHeight double getHeight(): Returns the total font height (ascent plus descent) in pixels.
getStringSize Vector2 getStringSize(String string): Returns the size of a string, taking kerning and advance into account. Note that the height returned is the font height (see getHeight) and has no relation to the string.
getWordwrapStringSize Vector2 getWordwrapStringSize(String string, double width): Returns the size that the string would have with word wrapping enabled with a fixed width.
hasOutline bool hasOutline(): Returns true if the font has an outline.
isDistanceFieldHint bool isDistanceFieldHint()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(Font other)
opEquals bool opEquals(typeof(null) n)
toHash size_t toHash()
updateChanges void updateChanges(): After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new Font _new(): Construct a new instance of Font. Note: use memnew!Font instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Font

Members

Aliases

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

Font

From mixin baseCasts

From `mixin baseCasts`