Skip to content

Commit

Permalink
Make FontData importable resource.
Browse files Browse the repository at this point in the history 
Add multi-channel(+ true) SDF font texture generation and rendering support.
Add FontData import plugins (for dynamic fonts, BMFonts and raw image fonts), font texture cache pre-generation and loading.
  • Loading branch information
@bruvzg
bruvzg committed Aug 20, 2021
1 parent 0168699 commit ac7144c
Show file tree
Hide file tree
Showing 129 changed files with 16,655 additions and 6,464 deletions.
5 changes: 5 additions & 0 deletions COPYRIGHT.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,11 @@ Comment: YUV2RGB
Copyright: 2008-2011, Robin Watts
License: BSD-2-clause

Files: ./thirdparty/msdfgen/
Comment: Multi-channel signed distance field generator
Copyright: 2016, Viktor Chlumsky
License: MIT

Files: ./thirdparty/nanosvg/
Comment: NanoSVG
Copyright: 2013-2014, Mikko Mononen
Expand Down
1 change: 1 addition & 0 deletions SConstruct
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ opts.Add(BoolVariable("builtin_certs", "Use the built-in SSL certificates bundle
opts.Add(BoolVariable("builtin_embree", "Use the built-in Embree library", True))
opts.Add(BoolVariable("builtin_enet", "Use the built-in ENet library", True))
opts.Add(BoolVariable("builtin_freetype", "Use the built-in FreeType library", True))
opts.Add(BoolVariable("builtin_msdfgen", "Use the built-in MSDFgen library", True))
opts.Add(BoolVariable("builtin_glslang", "Use the built-in glslang library", True))
opts.Add(BoolVariable("builtin_graphite", "Use the built-in Graphite library", True))
opts.Add(BoolVariable("builtin_harfbuzz", "Use the built-in HarfBuzz library", True))
Expand Down
14 changes: 14 additions & 0 deletions doc/classes/CanvasItem.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,20 @@
Draws a [Mesh] in 2D, using the provided texture. See [MeshInstance2D] for related documentation.
</description>
</method>
<method name="draw_msdf_texture_rect_region">
<return type="void" />
<argument index="0" name="texture" type="Texture2D" />
<argument index="1" name="rect" type="Rect2" />
<argument index="2" name="src_rect" type="Rect2" />
<argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
<argument index="4" name="outline" type="float" default="0.0" />
<argument index="5" name="pixel_range" type="float" default="4.0" />
<description>
Draws a textured rectangle region of the multi-channel signed distance field texture at a given position, optionally modulated by a color.
If [code]outline[/code] is positive, each alpha channel value of pixel in region is set to maximum value of true distance in the [code]outline[/code] radius.
Value of the [code]pixel_range[/code] should the same that was used during distance field texture generation.
</description>
</method>
<method name="draw_multiline">
<return type="void" />
<argument index="0" name="points" type="PackedVector2Array" />
Expand Down
56 changes: 33 additions & 23 deletions doc/classes/Font.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@
Add font data source to the set.
</description>
</method>
<method name="clear_data">
<return type="void" />
<description>
Removes all font data sourcers for the set.
</description>
</method>
<method name="draw_char" qualifiers="const">
<return type="float" />
<argument index="0" name="canvas_item" type="RID" />
Expand Down Expand Up @@ -122,7 +128,7 @@
</method>
<method name="get_ascent" qualifiers="const">
<return type="float" />
<argument index="0" name="size" type="int" default="-1" />
<argument index="0" name="size" type="int" />
<description>
Returns the average font ascent (number of pixels above the baseline).
[b]Note:[/b] 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).
Expand Down Expand Up @@ -151,17 +157,24 @@
Returns the number of font data sources.
</description>
</method>
<method name="get_data_rid" qualifiers="const">
<return type="RID" />
<argument index="0" name="idx" type="int" />
<description>
Returns TextServer RID of the font data resources.
</description>
</method>
<method name="get_descent" qualifiers="const">
<return type="float" />
<argument index="0" name="size" type="int" default="-1" />
<argument index="0" name="size" type="int" />
<description>
Returns the average font descent (number of pixels below the baseline).
[b]Note:[/b] 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).
</description>
</method>
<method name="get_height" qualifiers="const">
<return type="float" />
<argument index="0" name="size" type="int" default="-1" />
<argument index="0" name="size" type="int" />
<description>
Returns the total average font height (ascent plus descent) in pixels.
[b]Note:[/b] 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).
Expand All @@ -180,15 +193,18 @@
</method>
<method name="get_spacing" qualifiers="const">
<return type="int" />
<argument index="0" name="type" type="int" />
<argument index="0" name="spacing" type="int" enum="TextServer.SpacingType" />
<description>
Returns the spacing for the given [code]type[/code] (see [enum SpacingType]).
Returns the spacing for the given [code]type[/code] (see [enum TextServer.SpacingType]).
</description>
</method>
<method name="get_string_size" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="text" type="String" />
<argument index="1" name="size" type="int" default="-1" />
<argument index="2" name="align" type="int" enum="HAlign" default="0" />
<argument index="3" name="width" type="float" default="-1" />
<argument index="4" name="flags" type="int" default="3" />
<description>
Returns the size of a bounding box of a string, taking kerning and advance into account.
[b]Note:[/b] Real height of the string is context-dependent and can be significantly different from the value returned by [method get_height].
Expand All @@ -204,15 +220,15 @@
</method>
<method name="get_underline_position" qualifiers="const">
<return type="float" />
<argument index="0" name="size" type="int" default="-1" />
<argument index="0" name="size" type="int" />
<description>
Return average pixel offset of the underline below the baseline.
[b]Note:[/b] 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.
</description>
</method>
<method name="get_underline_thickness" qualifiers="const">
<return type="float" />
<argument index="0" name="size" type="int" default="-1" />
<argument index="0" name="size" type="int" />
<description>
Return average thickness of the underline.
[b]Note:[/b] 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.
Expand Down Expand Up @@ -242,33 +258,27 @@
</method>
<method name="set_spacing">
<return type="void" />
<argument index="0" name="type" type="int" />
<argument index="0" name="spacing" type="int" enum="TextServer.SpacingType" />
<argument index="1" name="value" type="int" />
<description>
Sets the spacing for [code]type[/code] (see [enum SpacingType]) to [code]value[/code] in pixels (not relative to the font size).
</description>
</method>
<method name="update_changes">
<return type="void" />
<description>
After editing a font (changing data sources, etc.). Call this function to propagate changes to controls that might use it.
Sets the spacing for [code]type[/code] (see [enum TextServer.SpacingType]) to [code]value[/code] in pixels (not relative to the font size).
</description>
</method>
</methods>
<members>
<member name="extra_spacing_bottom" type="int" setter="set_spacing" getter="get_spacing" default="0">
<member name="base_size" type="int" setter="set_base_size" getter="get_base_size" default="16">
Default font size.
</member>
<member name="spacing_bottom" type="int" setter="set_spacing" getter="get_spacing" default="0">
Extra spacing at the bottom of the line in pixels.
</member>
<member name="extra_spacing_top" type="int" setter="set_spacing" getter="get_spacing" default="0">
<member name="spacing_top" type="int" setter="set_spacing" getter="get_spacing" default="0">
Extra spacing at the top of the line in pixels.
</member>
<member name="variation_coordinates" type="Dictionary" setter="set_variation_coordinates" getter="get_variation_coordinates" default="{}">
Default font [url=https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg]variation coordinates[/url].
</member>
</members>
<constants>
<constant name="SPACING_TOP" value="0" enum="SpacingType">
Spacing at the top of the line.
</constant>
<constant name="SPACING_BOTTOM" value="1" enum="SpacingType">
Spacing at the bottom of the line.
</constant>
</constants>
</class>
Loading

0 comments on commit ac7144c

Please sign in to comment.