FreetypeFont

class FreetypeFont

Bases: Namable

This is a common base class for both DynamicTextFont and PNMTextMaker. Both of these are utility classes that use the FreeType library to generate glyphs from fonts; this class abstracts out that common wrapper around FreeType.

Inheritance diagram

enum WindingOrder

enumerator WO_default = 0

enumerator WO_left = 1

enumerator WO_right = 2

enumerator WO_invalid = 3

int get_font_pixel_size(void) const

This is used to report whether the requested pixel size is being only approximated by a fixed-pixel-size font. This returns 0 in the normal case, in which a scalable font is used, or the fixed-pixel-size font has exactly the requested pixel size.

If this returns non-zero, it is the pixel size of the font that we are using to approximate our desired size.

PN_stdfloat get_line_height(void) const

Returns the number of units high each line of text is.

bool get_native_antialias(void) const

Returns whether Freetype’s built-in antialias mode is enabled. See set_native_antialias().

PN_stdfloat get_pixel_size(void) const

Returns the size of the font in pixels, as it appears in the texture.

PN_stdfloat get_pixels_per_unit(void) const

Returns the resolution of the texture map. See set_pixels_per_unit().

PN_stdfloat get_point_size(void) const

Returns the point size of the font.

PN_stdfloat get_points_per_inch(void)

Returns the number of points in one inch. This is a universal typographic convention.

PN_stdfloat get_points_per_unit(void)

Returns the point size of the font that is one Panda unit high. This is an arbitrary Panda convention for text, and is set to 10.0.

PN_stdfloat get_scale_factor(void) const

Returns the antialiasing scale factor. See set_scale_factor().

PN_stdfloat get_space_advance(void) const

Returns the number of units wide a space is.

WindingOrder get_winding_order(void) const

Returns the winding order set via set_winding_order().

void set_native_antialias(bool native_antialias)

Sets whether the Freetype library’s built-in antialias mode is enabled. There are two unrelated ways to achieve antialiasing: with Freetype’s native antialias mode, and with the use of a scale_factor greater than one. By default, both modes are enabled.

At low resolutions, some fonts may do better with one mode or the other. In general, Freetype’s native antialiasing will produce less blurry results, but may introduce more artifacts.

bool set_pixel_size(PN_stdfloat pixel_size)

Computes the appropriate pixels_per_unit value to set the size of the font in the texture to the indicated number of pixels. This is just another way to specify pixels_per_unit().

bool set_pixels_per_unit(PN_stdfloat pixels_per_unit)

Set the resolution of the texture map, and hence the clarity of the resulting font. This sets the number of pixels in the texture map that are used for each onscreen unit.

Setting this number larger results in an easier to read font, but at the cost of more texture memory.

This should only be called before any characters have been requested out of the font, or immediately after calling clear().

bool set_point_size(PN_stdfloat point_size)

Sets the point size of the font. This controls the apparent size of the font onscreen. By convention, a 10 point font is about 1 screen unit high.

This should only be called before any characters have been requested out of the font, or immediately after calling clear().

bool set_scale_factor(PN_stdfloat scale_factor)

Sets the factor by which the font is rendered larger by the FreeType library before being filtered down to its actual size in the texture as specified by set_pixels_per_unit(). This may be set to a number larger than 1.0 to improve the font’s antialiasing (since FreeType doesn’t really do a swell job of antialiasing by itself). There is some performance implication for setting this different than 1.0.

This should only be called before any characters have been requested out of the font, or immediately after calling clear().

void set_winding_order(FreetypeFont::WindingOrder winding_order)

Specifies an explicitly winding order on this particular font. This is only necessary if the render_mode is RM_polygon or RM_solid, and only if FreeType appears to guess wrong on this font. Normally, you should leave this at WO_default.