Remove "default font" from ResourceImporterDynamicFont Documentation

The Docs for ResourceImporterDynamicFont's `multichannel_signed_distance_field` option appears to have been copy pasted from the version in ProjectSettings, including mentioning it's the "default font", instead of just "font" as it should in this class.
This commit is contained in:
Lyric Moysey-Rubin 2024-09-11 11:05:27 -07:00 committed by GitHub
parent 14a7e0abb3
commit 0089915c65
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -54,7 +54,7 @@
Source font size used to generate MSDF textures. Higher values allow for more precision, but are slower to render and require more memory. Only increase this value if you notice a visible lack of precision in glyph rendering. Only effective if [member multichannel_signed_distance_field] is [code]true[/code]. Source font size used to generate MSDF textures. Higher values allow for more precision, but are slower to render and require more memory. Only increase this value if you notice a visible lack of precision in glyph rendering. Only effective if [member multichannel_signed_distance_field] is [code]true[/code].
</member> </member>
<member name="multichannel_signed_distance_field" type="bool" setter="" getter="" default="false"> <member name="multichannel_signed_distance_field" type="bool" setter="" getter="" default="false">
If set to [code]true[/code], the default font will use multichannel signed distance field (MSDF) for crisp rendering at any size. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for [Control]s that are scaled down (or for [Label3D]s viewed from a long distance). If set to [code]true[/code], the font will use multichannel signed distance field (MSDF) for crisp rendering at any size. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for [Control]s that are scaled down (or for [Label3D]s viewed from a long distance).
MSDF font rendering can be combined with [member generate_mipmaps] to further improve font rendering quality when scaled down. MSDF font rendering can be combined with [member generate_mipmaps] to further improve font rendering quality when scaled down.
</member> </member>
<member name="opentype_features" type="Dictionary" setter="" getter="" default="{}"> <member name="opentype_features" type="Dictionary" setter="" getter="" default="{}">