FontFile

Inherits: Font < Resource < RefCounted < Object

There is currently no description for this class. Please help us by contributing one!

Properties

bool	allow_system_fallback	`true`
FontAntialiasing	antialiasing	`1`
PackedByteArray	data	`PackedByteArray()`
bool	disable_embedded_bitmaps	`true`
int	fixed_size	`0`
FixedSizeScaleMode	fixed_size_scale_mode	`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
float	get_extra_baseline_offset ( 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_baseline_offset ( int cache_index, float baseline_offset )
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 ( )

There is currently no description for this property. Please help us by contributing one!

FontAntialiasing antialiasing = 1

void set_antialiasing ( FontAntialiasing value )
FontAntialiasing get_antialiasing ( )

There is currently no description for this property. Please help us by contributing one!

PackedByteArray data = PackedByteArray()

void set_data ( PackedByteArray value )
PackedByteArray get_data ( )

There is currently no description for this property. Please help us by contributing one!

bool disable_embedded_bitmaps = true

void set_disable_embedded_bitmaps ( bool value )
bool get_disable_embedded_bitmaps ( )

There is currently no description for this property. Please help us by contributing one!

int fixed_size = 0

void set_fixed_size ( int value )
int get_fixed_size ( )

There is currently no description for this property. Please help us by contributing one!

FixedSizeScaleMode fixed_size_scale_mode = 0

void set_fixed_size_scale_mode ( FixedSizeScaleMode value )
FixedSizeScaleMode get_fixed_size_scale_mode ( )

There is currently no description for this property. Please help us by contributing one!

String font_name = ""

void set_font_name ( String value )
String get_font_name ( )

There is currently no description for this property. Please help us by contributing one!

int font_stretch = 100

void set_font_stretch ( int value )
int get_font_stretch ( )

There is currently no description for this property. Please help us by contributing one!

BitField<FontStyle> font_style = 0

void set_font_style ( BitField<FontStyle> value )
BitField<FontStyle> get_font_style ( )

There is currently no description for this property. Please help us by contributing one!

int font_weight = 400

void set_font_weight ( int value )
int get_font_weight ( )

There is currently no description for this property. Please help us by contributing one!

bool force_autohinter = false

void set_force_autohinter ( bool value )
bool is_force_autohinter ( )

There is currently no description for this property. Please help us by contributing one!

bool generate_mipmaps = false

void set_generate_mipmaps ( bool value )
bool get_generate_mipmaps ( )

There is currently no description for this property. Please help us by contributing one!

Hinting hinting = 1

void set_hinting ( Hinting value )
Hinting get_hinting ( )

There is currently no description for this property. Please help us by contributing one!

int msdf_pixel_range = 16

void set_msdf_pixel_range ( int value )
int get_msdf_pixel_range ( )

There is currently no description for this property. Please help us by contributing one!

int msdf_size = 48

void set_msdf_size ( int value )
int get_msdf_size ( )

There is currently no description for this property. Please help us by contributing one!

bool multichannel_signed_distance_field = false

void set_multichannel_signed_distance_field ( bool value )
bool is_multichannel_signed_distance_field ( )

There is currently no description for this property. Please help us by contributing one!

Dictionary opentype_feature_overrides = {}

void set_opentype_feature_overrides ( Dictionary value )
Dictionary get_opentype_feature_overrides ( )

There is currently no description for this property. Please help us by contributing one!

float oversampling = 0.0

void set_oversampling ( float value )
float get_oversampling ( )

There is currently no description for this property. Please help us by contributing one!

String style_name = ""

void set_font_style_name ( String value )
String get_font_style_name ( )

There is currently no description for this property. Please help us by contributing one!

SubpixelPositioning subpixel_positioning = 1

void set_subpixel_positioning ( SubpixelPositioning value )
SubpixelPositioning get_subpixel_positioning ( )

There is currently no description for this property. Please help us by contributing one!