Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

FontFile

Inherits: Font < Resource < RefCounted < Object

Holds font source data and prerendered glyph cache, imported from a dynamic or a bitmap font.

描述

FontFile contains a set of glyphs to represent Unicode characters imported from a font file, as well as a cache of rasterized glyphs, and a set of fallback Fonts to use.

Use FontVariation to access specific OpenType variation of the font, create simulated bold / slanted version, and draw lines of text.

For more complex text processing, use FontVariation in conjunction with TextLine or TextParagraph.

Supported font formats:

  • Dynamic font importer: TrueType (.ttf), TrueType collection (.ttc), OpenType (.otf), OpenType collection (.otc), WOFF (.woff), WOFF2 (.woff2), Type 1 (.pfb, .pfm).

  • Bitmap font importer: AngelCode BMFont (.fnt, .font), text and binary (version 3) format variants.

  • Monospace image font importer: All supported image formats.

Note: A character is a symbol that represents an item (letter, digit etc.) in an abstract way.

Note: A glyph is a bitmap or a shape used to draw one or more characters in a context-dependent manner. Glyph indices are bound to the specific font data source.

Note: If none of the font data sources contain glyphs for a character used in a string, the character in question will be replaced with a box displaying its hexadecimal code.

var f = load("res://BarlowCondensed-Bold.ttf")
$Label.add_theme_font_override("font", f)
$Label.add_theme_font_size_override("font_size", 64)

属性

bool

allow_system_fallback

true

FontAntialiasing

antialiasing

1

PackedByteArray

data

PackedByteArray()

int

fixed_size

0

String

font_name

""

int

font_stretch

100

BitField<FontStyle>

font_style

0

int

font_weight

400

bool

force_autohinter

false

bool

generate_mipmaps

false

Hinting

hinting

1

int

msdf_pixel_range

16

int

msdf_size

48

bool

multichannel_signed_distance_field

false

Dictionary

opentype_feature_overrides

{}

float

oversampling

0.0

String

style_name

""

SubpixelPositioning

subpixel_positioning

1

Methods

void

clear_cache ( )

void

clear_glyphs ( int cache_index, Vector2i size )

void

clear_kerning_map ( int cache_index, int size )

void

clear_size_cache ( int cache_index )

void

clear_textures ( int cache_index, Vector2i size )

float

get_cache_ascent ( int cache_index, int size ) const

int

get_cache_count ( ) const

float

get_cache_descent ( int cache_index, int size ) const

float

get_cache_scale ( int cache_index, int size ) const

float

get_cache_underline_position ( int cache_index, int size ) const

float

get_cache_underline_thickness ( int cache_index, int size ) const

int

get_char_from_glyph_index ( int size, int glyph_index ) const

float

get_embolden ( int cache_index ) const

int

get_extra_spacing ( int cache_index, SpacingType spacing ) const

int

get_face_index ( int cache_index ) const

Vector2

get_glyph_advance ( int cache_index, int size, int glyph ) const

int

get_glyph_index ( int size, int char, int variation_selector ) const

PackedInt32Array

get_glyph_list ( int cache_index, Vector2i size ) const

Vector2

get_glyph_offset ( int cache_index, Vector2i size, int glyph ) const

Vector2

get_glyph_size ( int cache_index, Vector2i size, int glyph ) const

int

get_glyph_texture_idx ( int cache_index, Vector2i size, int glyph ) const

Rect2

get_glyph_uv_rect ( int cache_index, Vector2i size, int glyph ) const

Vector2

get_kerning ( int cache_index, int size, Vector2i glyph_pair ) const

Vector2i[]

get_kerning_list ( int cache_index, int size ) const

bool

get_language_support_override ( String language ) const

PackedStringArray

get_language_support_overrides ( ) const

bool

get_script_support_override ( String script ) const

PackedStringArray

get_script_support_overrides ( ) const

Vector2i[]

get_size_cache_list ( int cache_index ) const

int

get_texture_count ( int cache_index, Vector2i size ) const

Image

get_texture_image ( int cache_index, Vector2i size, int texture_index ) const

PackedInt32Array

get_texture_offsets ( int cache_index, Vector2i size, int texture_index ) const

Transform2D

get_transform ( int cache_index ) const

Dictionary

get_variation_coordinates ( int cache_index ) const

Error

load_bitmap_font ( String path )

Error

load_dynamic_font ( String path )

void

remove_cache ( int cache_index )

void

remove_glyph ( int cache_index, Vector2i size, int glyph )

void

remove_kerning ( int cache_index, int size, Vector2i glyph_pair )

void

remove_language_support_override ( String language )

void

remove_script_support_override ( String script )

void

remove_size_cache ( int cache_index, Vector2i size )

void

remove_texture ( int cache_index, Vector2i size, int texture_index )

void

render_glyph ( int cache_index, Vector2i size, int index )

void

render_range ( int cache_index, Vector2i size, int start, int end )

void

set_cache_ascent ( int cache_index, int size, float ascent )

void

set_cache_descent ( int cache_index, int size, float descent )

void

set_cache_scale ( int cache_index, int size, float scale )

void

set_cache_underline_position ( int cache_index, int size, float underline_position )

void

set_cache_underline_thickness ( int cache_index, int size, float underline_thickness )

void

set_embolden ( int cache_index, float strength )

void

set_extra_spacing ( int cache_index, SpacingType spacing, int value )

void

set_face_index ( int cache_index, int face_index )

void

set_glyph_advance ( int cache_index, int size, int glyph, Vector2 advance )

void

set_glyph_offset ( int cache_index, Vector2i size, int glyph, Vector2 offset )

void

set_glyph_size ( int cache_index, Vector2i size, int glyph, Vector2 gl_size )

void

set_glyph_texture_idx ( int cache_index, Vector2i size, int glyph, int texture_idx )

void

set_glyph_uv_rect ( int cache_index, Vector2i size, int glyph, Rect2 uv_rect )

void

set_kerning ( int cache_index, int size, Vector2i glyph_pair, Vector2 kerning )

void

set_language_support_override ( String language, bool supported )

void

set_script_support_override ( String script, bool supported )

void

set_texture_image ( int cache_index, Vector2i size, int texture_index, Image image )

void

set_texture_offsets ( int cache_index, Vector2i size, int texture_index, PackedInt32Array offset )

void

set_transform ( int cache_index, Transform2D transform )

void

set_variation_coordinates ( int cache_index, Dictionary variation_coordinates )

Property Descriptions

bool allow_system_fallback = true

  • void set_allow_system_fallback ( bool value )

  • bool is_allow_system_fallback ( )

If set to true, system fonts can be automatically used as fallbacks.

FontAntialiasing antialiasing = 1

Font anti-aliasing mode.

PackedByteArray data = PackedByteArray()

Contents of the dynamic font source file.

int fixed_size = 0

  • void set_fixed_size ( int value )

  • int get_fixed_size ( )

Font size, used only for the bitmap fonts.

String font_name = ""

  • void set_font_name ( String value )

  • String get_font_name ( )

Font family name.

int font_stretch = 100

  • void set_font_stretch ( int value )

  • int get_font_stretch ( )

Font stretch amount, compared to a normal width. A percentage value between 50% and 200%.

BitField<FontStyle> font_style = 0

  • void set_font_style ( BitField<FontStyle> value )

  • BitField<FontStyle> get_font_style ( )

Font style flags, see FontStyle.

int font_weight = 400

  • void set_font_weight ( int value )

  • int get_font_weight ( )

Weight (boldness) of the font. A value in the 100...999 range, normal font weight is 400, bold font weight is 700.

bool force_autohinter = false

  • void set_force_autohinter ( bool value )

  • bool is_force_autohinter ( )

If set to true, auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only (MSDF fonts don't support hinting).

bool generate_mipmaps = false

  • void set_generate_mipmaps ( bool value )

  • bool get_generate_mipmaps ( )

If set to true, generate mipmaps for the font textures.

Hinting hinting = 1

Font hinting mode. Used by dynamic fonts only.

int msdf_pixel_range = 16

  • void set_msdf_pixel_range ( int value )

  • int get_msdf_pixel_range ( )

The width of the range around the shape between the minimum and maximum representable signed distance. If using font outlines, msdf_pixel_range must be set to at least twice the size of the largest font outline. The default msdf_pixel_range value of 16 allows outline sizes up to 8 to look correct.

int msdf_size = 48

  • void set_msdf_size ( int value )

  • int get_msdf_size ( )

Source font size used to generate MSDF textures. Higher values allow for more precision, but are slower to render and require more memory. Only increase this value if you notice a visible lack of precision in glyph rendering.

bool multichannel_signed_distance_field = false

  • void set_multichannel_signed_distance_field ( bool value )

  • bool is_multichannel_signed_distance_field ( )

If set to true, glyphs of all sizes are rendered using single multichannel signed distance field (MSDF) generated from the dynamic font vector data. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for Controls that are scaled down (or for Label3Ds viewed from a long distance). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes.

Note: If using font outlines, msdf_pixel_range must be set to at least twice the size of the largest font outline.

Note: MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts.

Dictionary opentype_feature_overrides = {}

  • void set_opentype_feature_overrides ( Dictionary value )

  • Dictionary get_opentype_feature_overrides ( )

Font OpenType feature set override.

float oversampling = 0.0

  • void set_oversampling ( float value )

  • float get_oversampling ( )

Font oversampling factor. If set to 0.0, the global oversampling factor is used instead. Used by dynamic fonts only (MSDF fonts ignore oversampling).

String style_name = ""

  • void set_font_style_name ( String value )

  • String get_font_style_name ( )

Font style name.

SubpixelPositioning subpixel_positioning = 1

Font glyph subpixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of higher memory usage and lower font rasterization speed. Use TextServer.SUBPIXEL_POSITIONING_AUTO to automatically enable it based on the font size.

Method Descriptions

void clear_cache ( )

Removes all font cache entries.

void clear_glyphs ( int cache_index, Vector2i size )

Removes all rendered glyphs information from the cache entry.

Note: This function will not remove textures associated with the glyphs, use remove_texture to remove them manually.

void clear_kerning_map ( int cache_index, int size )

Removes all kerning overrides.

void clear_size_cache ( int cache_index )

Removes all font sizes from the cache entry

void clear_textures ( int cache_index, Vector2i size )

Removes all textures from font cache entry.

Note: This function will not remove glyphs associated with the texture, use remove_glyph to remove them manually.

float get_cache_ascent ( int cache_index, int size ) const

Returns the font ascent (number of pixels above the baseline).

int get_cache_count ( ) const

Returns number of the font cache entries.

float get_cache_descent ( int cache_index, int size ) const

Returns the font descent (number of pixels below the baseline).

float get_cache_scale ( int cache_index, int size ) const

Returns scaling factor of the color bitmap font.

float get_cache_underline_position ( int cache_index, int size ) const

Returns pixel offset of the underline below the baseline.

float get_cache_underline_thickness ( int cache_index, int size ) const

Returns thickness of the underline in pixels.

int get_char_from_glyph_index ( int size, int glyph_index ) const

Returns character code associated with glyph_index, or 0 if glyph_index is invalid. See get_glyph_index.

float get_embolden ( int cache_index ) const

Returns embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.

int get_extra_spacing ( int cache_index, SpacingType spacing ) const

Returns spacing for spacing (see SpacingType) in pixels (not relative to the font size).

int get_face_index ( int cache_index ) const

Returns an active face index in the TrueType / OpenType collection.

Vector2 get_glyph_advance ( int cache_index, int size, int glyph ) const

Returns glyph advance (offset of the next glyph).

Note: Advance for glyphs outlines is the same as the base glyph advance and is not saved.

int get_glyph_index ( int size, int char, int variation_selector ) const

Returns the glyph index of a char, optionally modified by the variation_selector.

PackedInt32Array get_glyph_list ( int cache_index, Vector2i size ) const

Returns list of rendered glyphs in the cache entry.

Vector2 get_glyph_offset ( int cache_index, Vector2i size, int glyph ) const

Returns glyph offset from the baseline.

Vector2 get_glyph_size ( int cache_index, Vector2i size, int glyph ) const

Returns glyph size.

int get_glyph_texture_idx ( int cache_index, Vector2i size, int glyph ) const

Returns index of the cache texture containing the glyph.

Rect2 get_glyph_uv_rect ( int cache_index, Vector2i size, int glyph ) const

Returns rectangle in the cache texture containing the glyph.

Vector2 get_kerning ( int cache_index, int size, Vector2i glyph_pair ) const

Returns kerning for the pair of glyphs.

Vector2i[] get_kerning_list ( int cache_index, int size ) const

Returns list of the kerning overrides.

bool get_language_support_override ( String language ) const

Returns true if support override is enabled for the language.

PackedStringArray get_language_support_overrides ( ) const

Returns list of language support overrides.

bool get_script_support_override ( String script ) const

Returns true if support override is enabled for the script.

PackedStringArray get_script_support_overrides ( ) const

Returns list of script support overrides.

Vector2i[] get_size_cache_list ( int cache_index ) const

Returns list of the font sizes in the cache. Each size is Vector2i with font size and outline size.

int get_texture_count ( int cache_index, Vector2i size ) const

Returns number of textures used by font cache entry.

Image get_texture_image ( int cache_index, Vector2i size, int texture_index ) const

Returns a copy of the font cache texture image.

PackedInt32Array get_texture_offsets ( int cache_index, Vector2i size, int texture_index ) const

Returns a copy of the array containing glyph packing data.

Transform2D get_transform ( int cache_index ) const

Returns 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.

Dictionary get_variation_coordinates ( int cache_index ) const

Returns variation coordinates for the specified font cache entry. See Font.get_supported_variation_list for more info.

Error load_bitmap_font ( String path )

Loads an AngelCode BMFont (.fnt, .font) bitmap font from file path.

Warning: This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the user:// directory.

Error load_dynamic_font ( String path )

Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 (.pfb, .pfm) dynamic font from file path.

Warning: This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the user:// directory.

void remove_cache ( int cache_index )

Removes specified font cache entry.

void remove_glyph ( int cache_index, Vector2i size, int glyph )

Removes specified rendered glyph information from the cache entry.

Note: This function will not remove textures associated with the glyphs, use remove_texture to remove them manually.

void remove_kerning ( int cache_index, int size, Vector2i glyph_pair )

Removes kerning override for the pair of glyphs.

void remove_language_support_override ( String language )

Remove language support override.

void remove_script_support_override ( String script )

Removes script support override.

void remove_size_cache ( int cache_index, Vector2i size )

Removes specified font size from the cache entry.

void remove_texture ( int cache_index, Vector2i size, int texture_index )

Removes specified texture from the cache entry.

Note: This function will not remove glyphs associated with the texture. Remove them manually using remove_glyph.

void render_glyph ( int cache_index, Vector2i size, int index )

Renders specified glyph to the font cache texture.

void render_range ( int cache_index, Vector2i size, int start, int end )

Renders the range of characters to the font cache texture.

void set_cache_ascent ( int cache_index, int size, float ascent )

Sets the font ascent (number of pixels above the baseline).

void set_cache_descent ( int cache_index, int size, float descent )

Sets the font descent (number of pixels below the baseline).

void set_cache_scale ( int cache_index, int size, float scale )

Sets scaling factor of the color bitmap font.

void set_cache_underline_position ( int cache_index, int size, float underline_position )

Sets pixel offset of the underline below the baseline.

void set_cache_underline_thickness ( int cache_index, int size, float underline_thickness )

Sets thickness of the underline in pixels.

void set_embolden ( int cache_index, float strength )

Sets embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.

void set_extra_spacing ( int cache_index, SpacingType spacing, int value )

Sets the spacing for spacing (see SpacingType) to value in pixels (not relative to the font size).

void set_face_index ( int cache_index, int face_index )

Sets an active face index in the TrueType / OpenType collection.

void set_glyph_advance ( int cache_index, int size, int glyph, Vector2 advance )

Sets glyph advance (offset of the next glyph).

Note: Advance for glyphs outlines is the same as the base glyph advance and is not saved.

void set_glyph_offset ( int cache_index, Vector2i size, int glyph, Vector2 offset )

Sets glyph offset from the baseline.

void set_glyph_size ( int cache_index, Vector2i size, int glyph, Vector2 gl_size )

Sets glyph size.

void set_glyph_texture_idx ( int cache_index, Vector2i size, int glyph, int texture_idx )

Sets index of the cache texture containing the glyph.

void set_glyph_uv_rect ( int cache_index, Vector2i size, int glyph, Rect2 uv_rect )

Sets rectangle in the cache texture containing the glyph.

void set_kerning ( int cache_index, int size, Vector2i glyph_pair, Vector2 kerning )

Sets kerning for the pair of glyphs.

void set_language_support_override ( String language, bool supported )

Adds override for Font.is_language_supported.

void set_script_support_override ( String script, bool supported )

Adds override for Font.is_script_supported.

void set_texture_image ( int cache_index, Vector2i size, int texture_index, Image image )

Sets font cache texture image.

void set_texture_offsets ( int cache_index, Vector2i size, int texture_index, PackedInt32Array offset )

Sets array containing glyph packing data.

void set_transform ( int cache_index, Transform2D transform )

Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.

void set_variation_coordinates ( int cache_index, Dictionary variation_coordinates )

Sets variation coordinates for the specified font cache entry. See Font.get_supported_variation_list for more info.