2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 13:40:43 +01:00
<class name= "DynamicFont" inherits= "Font" category= "Core" version= "3.1" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-10-11 00:08:59 +02:00
DynamicFont renders vector font files at runtime.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-10-21 12:33:50 +02:00
DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_fallback" >
<return type= "void" >
</return>
<argument index= "0" name= "data" type= "DynamicFontData" >
</argument>
<description >
2017-10-11 00:08:59 +02:00
Adds a fallback font.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_fallback" qualifiers= "const" >
<return type= "DynamicFontData" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2017-10-11 00:08:59 +02:00
Returns the fallback font at index [code]idx[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_fallback_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2017-10-11 00:08:59 +02:00
Returns the number of fallback fonts.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "remove_fallback" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2017-10-11 00:08:59 +02:00
Removes the fallback font at index [code]idx[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_fallback" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<argument index= "1" name= "data" type= "DynamicFontData" >
</argument>
<description >
2017-10-11 00:08:59 +02:00
Sets the fallback font at index [code]idx[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "extra_spacing_bottom" type= "int" setter= "set_spacing" getter= "get_spacing" >
2017-10-11 00:08:59 +02:00
Extra spacing at the bottom in pixels.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "extra_spacing_char" type= "int" setter= "set_spacing" getter= "get_spacing" >
2017-10-11 00:08:59 +02:00
Extra character spacing in pixels.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "extra_spacing_space" type= "int" setter= "set_spacing" getter= "get_spacing" >
2017-10-11 00:08:59 +02:00
Extra space spacing in pixels.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "extra_spacing_top" type= "int" setter= "set_spacing" getter= "get_spacing" >
2017-10-11 00:08:59 +02:00
Extra spacing at the top in pixels.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "font_data" type= "DynamicFontData" setter= "set_font_data" getter= "get_font_data" >
2017-10-11 00:08:59 +02:00
The font data.
2017-09-12 22:42:36 +02:00
</member>
2018-05-12 09:38:00 +02:00
<member name= "outline_color" type= "Color" setter= "set_outline_color" getter= "get_outline_color" >
</member>
<member name= "outline_size" type= "int" setter= "set_outline_size" getter= "get_outline_size" >
</member>
2017-09-13 08:49:40 +02:00
<member name= "size" type= "int" setter= "set_size" getter= "get_size" >
2017-10-11 00:08:59 +02:00
The font size.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "use_filter" type= "bool" setter= "set_use_filter" getter= "get_use_filter" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], filtering is used.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "use_mipmaps" type= "bool" setter= "set_use_mipmaps" getter= "get_use_mipmaps" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], mipmapping is used.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "SPACING_TOP" value= "0" enum= "SpacingType" >
2017-10-11 00:08:59 +02:00
Spacing at the top.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "SPACING_BOTTOM" value= "1" enum= "SpacingType" >
2017-10-11 00:08:59 +02:00
Spacing at the bottom.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "SPACING_CHAR" value= "2" enum= "SpacingType" >
2017-10-11 00:08:59 +02:00
Character spacing.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "SPACING_SPACE" value= "3" enum= "SpacingType" >
2017-10-11 00:08:59 +02:00
Space spacing.
2017-09-12 22:42:36 +02:00
</constant>
</constants>
</class>