asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/DynamicFont.xml

129 lines
6.3 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Update classref headers with 3.4 version
2021-04-26 13:14:51 +02:00
<class name="DynamicFont" inherits="Font" version="3.4">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
DynamicFont renders vector font files at runtime.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</brief_description>
<description>
Document missing character behavior when drawing text with fonts See #40405. (cherry picked from commit 7735d8d0ce89d305ef5b45037220c7b240dec8f0)
2020-07-15 10:13:47 +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. DynamicFont also supports defining one or more fallback fonts, which will be used when displaying a character not supported by the main font.
Improve the DynamicFont class documentation
2019-12-03 09:55:20 +01:00
DynamicFont uses the [url=https://www.freetype.org/]FreeType[/url] library for rasterization.
Add example of loading a font from .ttf file As this is a multi-step process it would be nice to have this documented.
2019-04-06 12:06:08 +02:00
[codeblock]
var dynamic_font = DynamicFont.new()
dynamic_font.font_data = load("res://BarlowCondensed-Bold.ttf")
dynamic_font.size = 64
$"Label".set("custom_fonts/font", dynamic_font)
[/codeblock]
Document the lack of kerning support in DynamicFont (cherry picked from commit e506479fcefa24eac55b9e83c8fa71e257d869ad)
2020-08-07 15:03:35 +02:00
[b]Note:[/b] DynamicFont doesn't support features such as kerning, right-to-left typesetting, ligatures, text shaping, variable fonts and optional font features yet. If you wish to "bake" an optional font feature into a TTF font file, you can use [url=https://fontforge.org/]FontForge[/url] to do so. In FontForge, use [b]File &gt; Generate Fonts[/b], click [b]Options[/b], choose the desired features then generate the font.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
Link to demos from within the class reference (cherry picked from commit 439be614f4706705331669a58ce03f14c34ca52f)
2020-10-01 10:34:47 +02:00
<link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</tutorials>
<methods>
<method name="add_fallback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="data" type="DynamicFontData" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
Adds a fallback font.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Add DynamicFont::get_available_chars()
2020-07-18 14:53:37 +02:00
<method name="get_available_chars" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="String" />
Add DynamicFont::get_available_chars()
2020-07-18 14:53:37 +02:00
<description>
Returns a string containing all the characters available in the main and all the fallback fonts.
If a given character is included in more than one font, it appears only once in the returned string.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="get_fallback" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="DynamicFontData" />
<argument index="0" name="idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
Returns the fallback font at index [code]idx[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="get_fallback_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
Returns the number of fallback fonts.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<method name="get_spacing" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="type" type="int" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
Improve the DynamicFont class documentation
2019-12-03 09:55:20 +01:00
Returns the spacing for the given [code]type[/code] (see [enum SpacingType]).
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="remove_fallback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
Removes the fallback font at index [code]idx[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="set_fallback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="idx" type="int" />
<argument index="1" name="data" type="DynamicFontData" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
Sets the fallback font at index [code]idx[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<method name="set_spacing">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="type" type="int" />
<argument index="1" name="value" type="int" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
Improve the DynamicFont class documentation
2019-12-03 09:55:20 +01:00
Sets the spacing for [code]type[/code] (see [enum SpacingType]) to [code]value[/code] in pixels (not relative to the font size).
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="extra_spacing_bottom" type="int" setter="set_spacing" getter="get_spacing" default="0">
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
Extra spacing at the bottom in pixels.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="extra_spacing_char" type="int" setter="set_spacing" getter="get_spacing" default="0">
Doc clarity/detail for extra spacing properties Re: Space spacing being in addition to character spacing see: * <https://github.com/godotengine/godot/blob/d7b85fbaa1fc438effe406c9d7f973749eb4e527/scene/resources/dynamic_font.cpp#L858-L859> Re: Value being able to be negative see example here: * <https://github.com/godotengine/godot/issues/38630> But also note that nodes other than `Label` may not currently render extra space spacing correctly. (cherry picked from commit 2ef89e0b4358ff384a7262c422314cafbff48098)
2020-05-12 03:28:12 +02:00
Extra spacing for each character in pixels.
This can be a negative number to make the distance between characters smaller.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="extra_spacing_space" type="int" setter="set_spacing" getter="get_spacing" default="0">
Doc clarity/detail for extra spacing properties Re: Space spacing being in addition to character spacing see: * <https://github.com/godotengine/godot/blob/d7b85fbaa1fc438effe406c9d7f973749eb4e527/scene/resources/dynamic_font.cpp#L858-L859> Re: Value being able to be negative see example here: * <https://github.com/godotengine/godot/issues/38630> But also note that nodes other than `Label` may not currently render extra space spacing correctly. (cherry picked from commit 2ef89e0b4358ff384a7262c422314cafbff48098)
2020-05-12 03:28:12 +02:00
Extra spacing for the space character (in addition to [member extra_spacing_char]) in pixels.
This can be a negative number to make the distance between words smaller.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="extra_spacing_top" type="int" setter="set_spacing" getter="get_spacing" default="0">
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
Extra spacing at the top in pixels.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="font_data" type="DynamicFontData" setter="set_font_data" getter="get_font_data">
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
The font data.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="outline_color" type="Color" setter="set_outline_color" getter="get_outline_color" default="Color( 1, 1, 1, 1 )">
Improve the DynamicFont class documentation
2019-12-03 09:55:20 +01:00
The font outline's color.
[b]Note:[/b] It's recommended to leave this at the default value so that you can adjust it in individual controls. For example, if the outline is made black here, it won't be possible to change its color using a Label's font outline modulate theme item.
Sync classref with current source
2018-05-12 09:38:00 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="outline_size" type="int" setter="set_outline_size" getter="get_outline_size" default="0">
Improve the DynamicFont class documentation
2019-12-03 09:55:20 +01:00
The font outline's thickness in pixels (not relative to the font size).
Sync classref with current source
2018-05-12 09:38:00 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="size" type="int" setter="set_size" getter="get_size" default="16">
Improve the DynamicFont class documentation
2019-12-03 09:55:20 +01:00
The font size in pixels.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="use_filter" type="bool" setter="set_use_filter" getter="get_use_filter" default="false">
Improve the DynamicFont class documentation
2019-12-03 09:55:20 +01:00
If [code]true[/code], filtering is used. This makes the font blurry instead of pixelated when scaling it if font oversampling is disabled or ineffective. It's recommended to enable this when using the font in a control whose size changes over time, unless a pixel art aesthetic is desired.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="use_mipmaps" type="bool" setter="set_use_mipmaps" getter="get_use_mipmaps" default="false">
Improve the DynamicFont class documentation
2019-12-03 09:55:20 +01:00
If [code]true[/code], mipmapping is used. This improves the font's appearance when downscaling it if font oversampling is disabled or ineffective.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SPACING_TOP" value="0" enum="SpacingType">
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
Spacing at the top.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SPACING_BOTTOM" value="1" enum="SpacingType">
[DOCS] DynamicFont
2017-10-11 00:08:59 +02:00
Spacing at the bottom.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SPACING_CHAR" value="2" enum="SpacingType">
Doc clarity/detail for extra spacing properties Re: Space spacing being in addition to character spacing see: * <https://github.com/godotengine/godot/blob/d7b85fbaa1fc438effe406c9d7f973749eb4e527/scene/resources/dynamic_font.cpp#L858-L859> Re: Value being able to be negative see example here: * <https://github.com/godotengine/godot/issues/38630> But also note that nodes other than `Label` may not currently render extra space spacing correctly. (cherry picked from commit 2ef89e0b4358ff384a7262c422314cafbff48098)
2020-05-12 03:28:12 +02:00
Spacing for each character.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SPACING_SPACE" value="3" enum="SpacingType">
Doc clarity/detail for extra spacing properties Re: Space spacing being in addition to character spacing see: * <https://github.com/godotengine/godot/blob/d7b85fbaa1fc438effe406c9d7f973749eb4e527/scene/resources/dynamic_font.cpp#L858-L859> Re: Value being able to be negative see example here: * <https://github.com/godotengine/godot/issues/38630> But also note that nodes other than `Label` may not currently render extra space spacing correctly. (cherry picked from commit 2ef89e0b4358ff384a7262c422314cafbff48098)
2020-05-12 03:28:12 +02:00
Spacing for the space character.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constant>
</constants>
</class>
Reference in a new issue Copy permalink