class-description NEWS COMMUNITY STORE LABS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE LABS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectRefCountedResource Font
Abstract base class for fonts and font variations.

Abstract base class for different font types. It has methods for drawing text and font character introspection.

 Font[] fallbacks<>():Font[]

Array of fallback Fonts to use as a substitute if a glyph is not found in this current Font.

If this array is empty in a FontVariation, the FontVariation.base_font's fallbacks are used instead.

 float draw_char<>( RID canvas_item=, canvas_item:RID=, Vector2 pos=, pos:Vector2=, int char=, char:int=, int font_size=, font_size:int=, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, ):float

Draw a single Unicode character char into a canvas item using the font, at a given position, with modulate color. pos specifies the baseline, not the top. To draw from the top, ascent must be added to the Y axis.

Note: Do not use this function to draw strings character by character, use draw_string or TextLine instead.

 float draw_char_outline<>( RID canvas_item=, canvas_item:RID=, Vector2 pos=, pos:Vector2=, int char=, char:int=, int font_size=, font_size:int=, int=, int:=, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, ):float

Draw a single Unicode character char outline into a canvas item using the font, at a given position, with modulate color and size outline size. pos specifies the baseline, not the top. To draw from the top, ascent must be added to the Y axis.

Note: Do not use this function to draw strings character by character, use draw_string or TextLine instead.

 void draw_multiline_string<>( RID canvas_item=, canvas_item:RID=, Vector2 pos=, pos:Vector2=, String text=, text:String=, HorizontalAlignment alignment=0, alignment:HorizontalAlignment=0, float=, float:=, int font_size=16, font_size:int=16, int=, int:=, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, BitField=, BitField:=, BitField=, BitField:=, Direction direction=0, direction:Direction=0, Orientation orientation=0, orientation:Orientation=0, ):void

Breaks text into lines using rules specified by brk_flags and draws it into a canvas item using the font, at a given position, with modulate color, optionally clipping the width and aligning horizontally. pos specifies the baseline of the first line, not the top. To draw from the top, ascent must be added to the Y axis.

See also CanvasItem.draw_multiline_string.

 void draw_multiline_string_outline<>( RID canvas_item=, canvas_item:RID=, Vector2 pos=, pos:Vector2=, String text=, text:String=, HorizontalAlignment alignment=0, alignment:HorizontalAlignment=0, float=, float:=, int font_size=16, font_size:int=16, int=, int:=, int size=1, size:int=1, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, BitField=, BitField:=, BitField=, BitField:=, Direction direction=0, direction:Direction=0, Orientation orientation=0, orientation:Orientation=0, ):void

Breaks text to the lines using rules specified by brk_flags and draws text outline into a canvas item using the font, at a given position, with modulate color and size outline size, optionally clipping the width and aligning horizontally. pos specifies the baseline of the first line, not the top. To draw from the top, ascent must be added to the Y axis.

See also CanvasItem.draw_multiline_string_outline.

 void draw_string<>( RID canvas_item=, canvas_item:RID=, Vector2 pos=, pos:Vector2=, String text=, text:String=, HorizontalAlignment alignment=0, alignment:HorizontalAlignment=0, float=, float:=, int font_size=16, font_size:int=16, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, BitField=, BitField:=, Direction direction=0, direction:Direction=0, Orientation orientation=0, orientation:Orientation=0, ):void

Draw text into a canvas item using the font, at a given position, with modulate color, optionally clipping the width and aligning horizontally. pos specifies the baseline, not the top. To draw from the top, ascent must be added to the Y axis.

See also CanvasItem.draw_string.

 void draw_string_outline<>( RID canvas_item=, canvas_item:RID=, Vector2 pos=, pos:Vector2=, String text=, text:String=, HorizontalAlignment alignment=0, alignment:HorizontalAlignment=0, float=, float:=, int font_size=16, font_size:int=16, int size=1, size:int=1, Color=, Color:=, 1=, 1:=, 1=, 1:=, 1 )=, ):1=, BitField=, BitField:=, Direction direction=0, direction:Direction=0, Orientation orientation=0, orientation:Orientation=0, ):void

Draw text outline into a canvas item using the font, at a given position, with modulate color and size outline size, optionally clipping the width and aligning horizontally. pos specifies the baseline, not the top. To draw from the top, ascent must be added to the Y axis.

See also CanvasItem.draw_string_outline.

 RID find_variation<>( Dictionary variation_coordinates=, variation_coordinates:Dictionary=, int face_index=0, face_index:int=0, float strength=0.0, strength:float=0.0, Transform2D=, Transform2D:=, 0=, 0:=, 0=, 0:=, 1=, 1:=, 0=, 0:=, 0 )=, ):0=, int spacing_top=0, spacing_top:int=0, int spacing_bottom=0, spacing_bottom:int=0, int spacing_space=0, spacing_space:int=0, int spacing_glyph=0, spacing_glyph:int=0, float baseline_offset=0.0, baseline_offset:float=0.0, ):RID

Returns TextServer RID of the font cache for specific variation.

 float get_ascent<>( int font_size=16, font_size:int=16, ):float

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

Note: Real ascent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the ascent of empty line).

 Vector2 get_char_size<>( int char=, char:int=, int font_size=, font_size:int=, ):Vector2

Returns the size of a character, optionally taking kerning into account if the next character is provided.

Note: Do not use this function to calculate width of the string character by character, use get_string_size or TextLine instead. The height returned is the font height (see also get_height) and has no relation to the glyph height.

 float get_descent<>( int font_size=16, font_size:int=16, ):float

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

Note: Real descent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the descent of empty line).

 int get_face_count<>():int

Returns number of faces in the TrueType / OpenType collection.

 String get_font_name<>():String

Returns font family name.

 int get_font_stretch<>():int

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

 BitField get_font_style<>():BitField

Returns font style flags, see FontStyle.

 String get_font_style_name<>():String

Returns font style name.

 int get_font_weight<>():int

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

 float get_height<>( int font_size=16, font_size:int=16, ):float

Returns the total average font height (ascent plus descent) in pixels.

Note: Real height of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the height of empty line).

 Vector2 get_multiline_string_size<>( String text=, text:String=, HorizontalAlignment alignment=0, alignment:HorizontalAlignment=0, float=, float:=, int font_size=16, font_size:int=16, int=, int:=, BitField=, BitField:=, BitField=, BitField:=, Direction direction=0, direction:Direction=0, Orientation orientation=0, orientation:Orientation=0, ):Vector2

Returns the size of a bounding box of a string broken into the lines, taking kerning and advance into account.

See also draw_multiline_string.

 Dictionary get_opentype_features<>():Dictionary

Returns a set of OpenType feature tags. More info: OpenType feature tags.

 Dictionary get_ot_name_strings<>():Dictionary

Returns Dictionary with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).

 RID[] get_rids<>():RID[]

Returns Array of valid Font RIDs, which can be passed to the TextServer methods.

 int get_spacing<>( SpacingType spacing=, spacing:SpacingType=, ):int

Returns the spacing for the given type (see SpacingType).

 Vector2 get_string_size<>( String text=, text:String=, HorizontalAlignment alignment=0, alignment:HorizontalAlignment=0, float=, float:=, int font_size=16, font_size:int=16, BitField=, BitField:=, Direction direction=0, direction:Direction=0, Orientation orientation=0, orientation:Orientation=0, ):Vector2

Returns the size of a bounding box of a single-line string, taking kerning, advance and subpixel positioning into account. See also get_multiline_string_size and draw_string.

For example, to get the string size as displayed by a single-line Label, use:

var string_size = $Label.get_theme_font("font").get_string_size($Label.text, HORIZONTAL_ALIGNMENT_LEFT, -1, $Label.get_theme_font_size("font_size"))

Note: Since kerning, advance and subpixel positioning are taken into account by get_string_size, using separate get_string_size calls on substrings of a string then adding the results together will return a different result compared to using a single get_string_size call on the full string.

Note: Real height of the string is context-dependent and can be significantly different from the value returned by get_height.

 String get_supported_chars<>():String

Returns a string containing all the characters available in the font.

If a given character is included in more than one font data source, it appears only once in the returned string.

 Dictionary get_supported_feature_list<>():Dictionary

Returns list of OpenType features supported by font.

 Dictionary get_supported_variation_list<>():Dictionary

Returns list of supported variation coordinates, each coordinate is returned as tag: Vector3i(min_value,max_value,default_value).

Font variations allow for continuous change of glyph characteristics along some given design axis, such as weight, width or slant.

To print available variation axes of a variable font:

var fv = FontVariation.new() fv.set_base_font = load("res://RobotoFlex.ttf") var variation_list = fv.get_supported_variation_list() for tag in variation_list: var name = TextServerManager.get_primary_interface().tag_to_name(tag) var values = variation_list[tag] print("variation axis: %s (%d)\n\tmin, max, default: %s" % [name, tag, values])

Note: To set and get variation coordinates of a FontVariation, use FontVariation.variation_opentype.

 float get_underline_position<>( int font_size=16, font_size:int=16, ):float

Returns average pixel offset of the underline below the baseline.

Note: Real underline position of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate.

 float get_underline_thickness<>( int font_size=16, font_size:int=16, ):float

Returns average thickness of the underline.

Note: Real underline thickness of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate.

 bool has_char<>( int char=, char:int=, ):bool

Returns true if a Unicode char is available in the font.

 bool is_language_supported<>( String language=, language:String=, ):bool

Returns true, if font supports given language (ISO 639 code).

 bool is_script_supported<>( String script=, script:String=, ):bool

Returns true, if font supports given script (ISO 15924 code).

 void set_cache_capacity<>( int single_line=, single_line:int=, int multi_line=, multi_line:int=, ):void

Sets LRU cache capacity for draw_* methods.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...