跳到主要内容

Font

继承

Resource

简要描述

国际化的字体和文字绘图支持。

描述

字体包含一个unicode兼容的字符集,以及以可变宽度、上升、下降和字距绘制它的能力。有关从TTF文件(或其他字体格式)创建字体,请参阅编辑器对字体的支持

方法

返回值类型方法名称
voiddraw(canvas_item: RID, position: Vector2, string: String, modulate: Color = Color( 1, 1, 1, 1 ), clip_w: int = -1, outline_modulate: Color = Color( 1, 1, 1, 1 )) const
floatdraw_char(canvas_item: RID, position: Vector2, char: int, next: int = -1, modulate: Color = Color( 1, 1, 1, 1 ), outline: bool = false) const
floatget_ascent() const
floatget_descent() const
floatget_height() const
Vector2get_string_size(string: String) const
Vector2get_wordwrap_string_size(string: String, width: float) const
boolhas_outline() const
boolis_distance_field_hint() const
voidupdate_changes()

方法说明

  • draw draw(canvas_item: RID, position: Vector2, string: String, modulate: Color = Color( 1, 1, 1, 1 ), clip_w: int = -1, outline_modulate: Color = Color( 1, 1, 1, 1 )) const

在给定位置使用字体将string绘制到画布项目中,并使用modulate颜色,还可以裁剪宽度。 position指定基线,而不是顶部。 要从顶部绘制,必须在[Y]轴上添加 ascent


  • draw_char draw_char(canvas_item: RID, position: Vector2, char: int, next: int = -1, modulate: Color = Color( 1, 1, 1, 1 ), outline: bool = false) const

在给定位置使用字体将char字符绘制到画布项目中,并使用modulate颜色,如果传递了next,则可以选择字距调整。 剪裁宽度。 position指定基线,而不是顶部。 要从顶部绘制,必须在[Y]轴上添加 ascent 。 返回字符使用的宽度,使该功能对于逐个字符绘制字符串很有用。


  • get_ascent get_ascent() const

返回字体的上升(基线以上的像素数)。


  • get_descent get_descent() const

返回字体下降(基线以下的像素数)。


  • get_height get_height() const

返回总字体高度(上升和下降),以像素为单位。


  • get_string_size get_string_size(string: String) const

返回字串的大小,并考虑字距调整和进阶。


  • get_wordwrap_string_size get_wordwrap_string_size(string: String, width: float) const

  • has_outline has_outline() const

如果字体有轮廓,则返回true


  • is_distance_field_hint is_distance_field_hint() const

  • update_changes update_changes()

编辑字体后(更改大小,上升,字符等)。 调用此函数可将更改传播到可能使用它的控件。