BitmapFont

Inherits: Font < Resource < Reference < Object

使用BMFont格式的字体来渲染文本。

处理扩展名为.fnt的文件。

描述

使用 *.fnt 包含纹理图库的字体来渲染文本。支持距离字段。关于直接使用 TTF 等矢量字体文件,请参阅 DynamicFont

属性

float

ascent

0.0

bool

distance_field

false

BitmapFont

fallback

float

height

1.0

方法

void

add_char ( int character, int texture, Rect2 rect, Vector2 align=Vector2( 0, 0 ), float advance=-1 )

void

add_kerning_pair ( int char_a, int char_b, int kerning )

void

add_texture ( Texture texture )

void

clear ( )

Error

create_from_fnt ( String path )

int

get_kerning_pair ( int char_a, int char_b ) const

Texture

get_texture ( int idx ) const

int

get_texture_count ( ) const

属性说明

Default

0.0

Setter

set_ascent(value)

Getter

get_ascent()

上升(基线以上的像素数)。


  • bool distance_field

Default

false

Setter

set_distance_field_hint(value)

Getter

is_distance_field_hint()

如果true,则启用距离字段提示。


Setter

set_fallback(value)

Getter

get_fallback()

备用字体。


Default

1.0

Setter

set_height(value)

Getter

get_height()

字体总高度(上升加下降),单位为像素。

方法说明

添加一个字符到字体中,其中character是Unicode值,texture是纹理索引,rect是纹理中的区域(以像素为单位!),align是字符的对齐方式(可选),advance是前进方式(可选)。


  • void add_kerning_pair ( int char_a, int char_b, int kerning )

BitmapFont 中为字偶添加差值。字偶(距)是一种特殊情况,当前字体的前进量由下一个字符决定。


  • void add_texture ( Texture texture )

BitmapFont添加一个纹理。


  • void clear ( )

清除所有字体数据和设置。


*.fnt 文件的 path 处创建一个 BitmapFont。


  • int get_kerning_pair ( int char_a, int char_b ) const

返回字偶的差值。


返回位于索引idx处的字体Atlas纹理。


  • int get_texture_count ( ) const

返回BitmapFont图谱中纹理的数量。