Inheritance #

SystemFont #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

A font loaded from a system font. Falls back to a default theme font if not implemented on the host OS.

SystemFont loads a font from a system font with the first matching name from font_names.

It will attempt to match font style, but it's not guaranteed.

The returned font might be part of a font collection or be a variable font with OpenType "weight", "width" and/or "italic" features set.

You can create FontVariation of the system font for precise control over its features.

Note: This class is implemented on iOS, Linux, macOS and Windows, on other platforms it will fallback to default theme font.

Members #

var allow_system_fallback: bool = true#

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

var antialiasing = FONT_ANTIALIASING_GRAY#

Font anti-aliasing mode.

var disable_embedded_bitmaps: bool = true#

If set to true, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).

var font_italic: bool = false#

If set to true, italic or oblique font is preferred.

var font_names: PackedStringArray = PackedStringArray()#

Array of font family names to search, first matching font found is used.

var font_stretch: int = 100#

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

var font_weight: int = 400#

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

var force_autohinter: bool = false#

If set to true, auto-hinting is supported and preferred over font built-in hinting.

var generate_mipmaps: bool = false#

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

var hinting = HINTING_LIGHT#

Font hinting mode.

var keep_rounding_remainders: bool = true#

If set to true, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.

var msdf_pixel_range: int = 16#

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.

var msdf_size: int = 48#

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.

var multichannel_signed_distance_field: bool = false#

If set to true, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.

var oversampling: float = 0.0#

Font oversampling factor, if set to 0.0 global oversampling factor is used instead.

var subpixel_positioning = SUBPIXEL_POSITIONING_AUTO#

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

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #