Pygame 中加载和表示字体的模块。
字体模块可以在一个新的 Surface 对象上表示 TrueType 字体。它接受所有 UCS-2 字符('u0001' 到 'uFFFF')。此模块为可选择模块,并且依赖于 SDL_ttf。在使用之前,你需要先测试该模块是否可用,而且对其进行初始化。
通过使用现有的 Font 对象,可以完成大多数与字体有关的工作。Pygame.font 模块自身仅可以完成常规的初始化以及通过 pygame.font.Font() 创建 Font 对象。
你可以通过使用 pygame.font.SysFont() 函数从系统内加载字体。另外还有其他几个函数可以帮助你搜索系统的字体。
Pygame 配备了内建的默认字体。通过传递 "None" 为文件名访问此字体。
在 pygame 第一次导入之前,当pygame.font 模块确定环境变量 PYGAME_FREETYPE 时使用基于 pygame.ftfont 的 pygame.freetype 模块。 Pygame.ftfont 是一个pygame.font 可兼容模块,兼容绝大部分,除开其中某个字体模块单元测试:Pygame.ftfont 并没有基于字体模块的 SDL_ttf 的 UCS-2 字符限制,所以对于大于 'uFFFF' 的码点会产生异常。如果 pygame.freetype 是不可使用的,那么 SDL_ttf 字体模块将会被加载用于替代。
初始化字体模块。
init() -> None
在调用 pygame.init() 时,该函数会被自动调用。
该函数用于初始化字体模块。在使用其他任何函数前,该模块必须被初始化。
多次调用该函数是安全的。
还原字体模块。
quit() -> None
手动还原 SDL_ttf 的字体系统。该函数会被 pygame.quit() 自动调用。
即使模块没有被初始化,调用该函数也是安全的。
检查字体模块是否被初始化。
get_init() -> bool
如果该字体模块已经初始化,返回 True,否则返回 False。
获得默认字体的文件名。
get_default_font() -> string
返回系统字体的文件名。
注意,并不是字体文件的完整路径。
这个文件通常与字体模块处于同一文件目录下,但是它也可以在程序附随的独立文档中。
获取所有可使用的字体。
get_fonts() -> list of strings
返回系统可使用的字体列表。
字体名将会被设置成小写、所有的空格和标点符号也会将被删除。
该函数在大多数系统内是有效的,但是一些系统如果没有找到字体库会返回一个空的列表。
在系统中搜索一种特殊的字体。
match_font(name, bold=False, italic=False) -> path
返回字体文件在系统中的完整路径。
如果你要搜索的字体是粗体或者斜体的,则要把 bold 参数和 italic 参数设置成 True,该函数将会尝试去搜索一个正确的字体族。
尝试搜索的 name 参数可以是一个用逗号隔开的列表。如果根据提供的名字没有找到任何东西,则返回 None 。
例子:
print pygame.font.match_font('bitstreamverasans')
# output is: /usr/share/fonts/truetype/ttf-bitstream-vera/Vera.ttf
# (but only if you have Vera on your system)
从系统字体库创建一个 Font 对象。
SysFont(name, size, bold=False, italic=False) -> Font
从系统字体库中加载并返回一个新的字体对象。
该字体将会匹配 bold(加粗)和 italic(斜体)参数的要求。
如果找不到一个合适的系统字体,该函数将会回退并加载默认的 pygame 字体。
尝试搜索的 name 参数可以是一个用逗号隔开的列表。
从一个字体文件创建一个 Font 对象。
Font(filename, size) -> Font
Font(object, size) -> Font
根据提供的文件名或者 python 文件对象加载一个新的字体。字体的高度是以像素为单位。如果文件名是 "None",则加载 Pygame 的默认字体。如果一个字体无法由给定的参数加载,将会产生一个异常。一旦字体已经创建完毕,那么字体的尺寸将不能修改。
字体对象主要被用于在新 Surface 对象中渲染文本。文本可以渲染为仿真的粗体或者斜体特征,但最好是加载的字体本身就带有粗体或者斜体字形。可以用普通字符串或者 Unicode 编码字符来渲染文本。
在一个新 Surface 对象上绘制文本。
render(text, antialias, color, background=None) -> Surface
该函数创建一个新的 Surface 对象,并在上边渲染指定的文本。Pygame 没有提供直接的方式在一个现有的 Surface 对象上绘制文本,取而代之的方法是:使用 Font.render() 函数创建一个渲染了文本的图像(Surface 对象),然后将这个图像绘制到目标 Surface 对象上。
仅支持渲染一行文本:“换行”字符不会被渲染。空字符('x00')被渲染将产生一个 TypeError 错误。Unicode 和 char(字节)字符串都可以被接受。对于 Unicode 字符串,仅 UCS-2 字符范围('u0001' 到 'uFFFF')被认为是有效的。任何编码值更大字符的字符会产生一个 UnicodeError 的错误;对于 char 字符串,默认的是使用 LATIN1 编码。color 参数决定的是文本的颜色(例如:(0, 0, 255) 表示蓝色)。可选参数 background 决定了文本的背景颜色。如果没有传递 background 参数,则对应区域内表示的文本背景将会被设置为透明。
返回的 Surface 对象将保持表示文本所需要的尺寸(与 Font.size() 所返回的尺寸相同)。如果将一个空字符串渲染为文本,将会返回一个空白 Surface 对象,它仅有一个像素点的宽度,但高度与字体高度一样。
由于取决于文本背景的类型和抗锯齿功能的使用,该函数将会返回不同类型的 Surface 对象。出于性能上的考虑,了解何种类型的图像会被使用是很有帮助的:如果抗锯齿功能没有被使用,返回的图像将采用二元调色的 8 位图像。此时如果背景是透明的,只设置一个 colorkey 来实现;抗锯齿图像会被渲染为 24 位 RGB 图像。此时如果背景是透明的,每个像素都将包含一个 alpha 通道。
优化:如果你已知文本最终将绘制在一个纯色的背景上,那么文本是抗锯齿的,你可以通过指定文本的背景色来提高性能(将文本背景色设置目标 Surface 对象的颜色)。使用这个技巧,你只需用一个 colorkey 即可保持透明信息,而不需要设置每个像素的 alpha 通道值(这样效率会低很多)。
如果你尝试渲染 '\n',通常是显示为一个矩形(未知字符)。因此,你需要自己想办法处理换行。
字体渲染并不是线程安全的行为:在任何时候仅有一个线程可以渲染文本。
确定多大的空间用于表示文本。
size(text) -> (width, height)
该函数返回渲染文本所需要的尺寸。这可以被用于在文本显示之前,确定文本的显示位置。当然也有助于实现自动换行和其他布局效果。
注意:大多数字体使用字距调整来调整指定字母间的宽度。例如,"ae" 的宽度并不总是等同于 'a' + 'e' 的宽度。
控制文本是否用下划线渲染。
set_underline(bool) -> None
启用后,所有字体的渲染都会包含下划线。下划线一般是和一个像素点一样细,与字体尺寸无关。
该函数可以与粗体和斜体模式混合使用。
检查文本是否绘制下划线。
get_underline() -> bool
如果字体下划线被启用,返回 True。
pygame.font.Font.set_bold()
启动粗体字渲染。
set_bold(bool) -> None
该函数启用文本的粗体渲染。该函数是通过虚拟拉伸实现加粗,对大多数字体格式来说并不是很好看。如果可能,请加载真粗体格式的字体文件。当渲染的字体为粗体时,该字体将比普通模式下更宽一些。
该函数可以和斜体及下划线模式混合使用。
检查文本是否使用粗体渲染。
get_bold() -> bool
如果字体的粗体渲染模式被启用,返回 True。
启动斜体字渲染。
set_italic(bool) -> None
该函数启用文本的斜体渲染。该函数是通过虚拟倾斜字体实现斜体,对大多数字体格式来说并不是很好看。如果可能,请加载真斜体格式的字体文件。当渲染的字体为斜体时,该字体将比普通模式下更宽一些。
该函数可以和粗体及下划线模式混合使用。
获取字符串参数每个字符的参数。
metrics(text) -> list
返回一个列表,包含每个字符的属性元组。形式如:[(minx, maxx, miny, maxy, advance), (minx, maxx, miny, maxy, advance), ...]
元组内各个元素的含义如下图:
列表内不可识别的字符对应的元组内参数均为 None。
检查文本是否使用斜体渲染。
get_italic() -> bool
如果字体的斜体渲染模式被启用,返回 True。
获取字体文本的行高。
get_linesize() -> int
返回该字体下文本的单行的高度(以像素为单位)。
当需要渲染很多行文本时,推荐使用该返回值作为行间距。
获取字体的高度。
get_height() -> int
返回实际渲染的文本的高度(以像素为单位)。
返回值是字体内每个字符的平均规格。
获取字体顶端到基准线的距离。
get_ascent() -> int
获取字体顶端到基准线的距离(以像素为单位)。
以防大家脑补错方向,补充下图:
获取字体底端到基准线的距离。
get_descent() -> int
获取字体底端到基准线的距离(以像素为单位)。