godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/DynamicFontData.xml

40 lines
1.9 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 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 22:01:02 +00:00
<class name="DynamicFontData" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
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 20:42:36 +00:00
<brief_description>
[DOCS] DynamicFontData
2017-10-10 22:15:20 +00:00
Used with [DynamicFont] to describe the location of a font file.
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 20:42:36 +00:00
</brief_description>
<description>
[DOCS] DynamicFontData
2017-10-10 22:15:20 +00:00
Used with [DynamicFont] to describe the location of a vector font file for dynamic rendering 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 20:42:36 +00:00
</description>
<tutorials>
Link to demos from within the class reference (cherry picked from commit 439be614f4706705331669a58ce03f14c34ca52f)
2020-10-01 08:34:47 +00: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 20:42:36 +00:00
</tutorials>
<methods>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="antialiased" type="bool" setter="set_antialiased" getter="is_antialiased" default="true">
Disable antialiasing on the DynamicFont outline as well when requested This partially addresses https://github.com/godotengine/godot-proposals/issues/943. (cherry picked from commit 2919fc73174a3c751405ce46ceed3ef71ea62966)
2020-05-28 20:26:16 +00:00
If [code]true[/code], the font is rendered with anti-aliasing. This property applies both to the main font and its outline (if it has one).
Add a property to control DynamicFont anti-aliasing - Editor font anti-aliasing can now be disabled in the Editor Settings. - DynamicFonts used in projects can now have their anti-aliasing disabled in their DynamicFontData child. Changes will be visible upon reloading the scene in the editor.
2018-11-10 21:07:32 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="font_path" type="String" setter="set_font_path" getter="get_font_path" default="&quot;&quot;">
[DOCS] DynamicFontData
2017-10-10 22:15:20 +00:00
The path to the vector font file.
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 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="hinting" type="int" setter="set_hinting" getter="get_hinting" enum="DynamicFontData.Hinting" default="2">
[DOCS] Class reference typos and fixes.
2020-01-02 01:08:19 +00:00
The font hinting mode used by FreeType. See [enum Hinting] for options.
Add documentation for the DynamicFont hinting property
2018-03-01 21:23:18 +00:00
</member>
Add DynamicFontData oversampling override property.
2021-12-08 09:19:31 +00:00
<member name="override_oversampling" type="float" setter="set_override_oversampling" getter="get_override_oversampling" default="0.0">
If set to a value greater than [code]0.0[/code], it will override default font oversampling, ignoring [member SceneTree.use_font_oversampling] value and viewport stretch mode.
</member>
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 20:42:36 +00:00
</members>
<constants>
Add documentation for the DynamicFont hinting property
2018-03-01 21:23:18 +00:00
<constant name="HINTING_NONE" value="0" enum="Hinting">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Disables font hinting (smoother but less crisp).
Add documentation for the DynamicFont hinting property
2018-03-01 21:23:18 +00:00
</constant>
<constant name="HINTING_LIGHT" value="1" enum="Hinting">
Use the light font hinting mode.
</constant>
<constant name="HINTING_NORMAL" value="2" enum="Hinting">
Use the default font hinting mode (crisper but less smooth).
</constant>
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 20:42:36 +00:00
</constants>
</class>