Skip to content

Commit d782a51

Browse files
committed
Document disabling ligatures and/or kerning in Using fonts
This also mentions the `connected` parameter available in the `tornado`, `wave`, `shake` built-in RichTextEffects.
1 parent 37fe448 commit d782a51

File tree

3 files changed

+27
-7
lines changed

3 files changed

+27
-7
lines changed

tutorials/ui/bbcode_in_richtextlabel.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -711,33 +711,45 @@ Wave
711711
.. image:: img/bbcode_in_richtextlabel_effect_wave.webp
712712

713713
Wave makes the text go up and down. Its tag format is
714-
``[wave amp=50.0 freq=5.0]{text}[/wave]``.
714+
``[wave amp=50.0 freq=5.0 connected=1]{text}[/wave]``.
715715

716716
``amp`` controls how high and low the effect goes, and ``freq`` controls how
717717
fast the text goes up and down. A ``freq`` value of ``0`` will result in no
718-
visible waves, and negative ``freq`` values won't display any waves either.
718+
visible waves, and negative ``freq`` values won't display any waves either. If
719+
``connected`` is ``1`` (default), glyphs with ligatures will be moved together.
720+
If ``connected`` is ``0``, each glyph is moved individually even if they are
721+
joined by ligatures. This can work around certain rendering issues with font
722+
ligatures.
719723

720724
Tornado
721725
~~~~~~~
722726

723727
.. image:: img/bbcode_in_richtextlabel_effect_tornado.webp
724728

725729
Tornao makes the text move around in a circle. Its tag format is
726-
``[tornado radius=10.0 freq=1.0]{text}[/tornado]``.
730+
``[tornado radius=10.0 freq=1.0 connected=1]{text}[/tornado]``.
727731

728732
``radius`` is the radius of the circle that controls the offset, ``freq`` is how
729733
fast the text moves in a circle. A ``freq`` value of ``0`` will pause the
730-
animation, while negative ``freq`` will play the animation backwards.
734+
animation, while negative ``freq`` will play the animation backwards. If
735+
``connected`` is ``1`` (default), glyphs with ligatures will be moved together.
736+
If ``connected`` is ``0``, each glyph is moved individually even if they are
737+
joined by ligatures. This can work around certain rendering issues with font
738+
ligatures.
731739

732740
Shake
733741
~~~~~
734742

735743
.. image:: img/bbcode_in_richtextlabel_effect_shake.webp
736744

737-
Shake makes the text shake. Its tag format is ``[shake rate=20.0 level=5]{text}[/shake]``.
745+
Shake makes the text shake. Its tag format is
746+
``[shake rate=20.0 level=5 connected=1]{text}[/shake]``.
738747

739-
``rate`` controls how fast the text shakes, ``level`` controls how far the text is
740-
offset from the origin.
748+
``rate`` controls how fast the text shakes, ``level`` controls how far the text
749+
is offset from the origin. If ``connected`` is ``1`` (default), glyphs with
750+
ligatures will be moved together. If ``connected`` is ``0``, each glyph is moved
751+
individually even if they are joined by ligatures. This can work around certain
752+
rendering issues with font ligatures.
741753

742754
Fade
743755
~~~~

tutorials/ui/gui_using_fonts.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -629,6 +629,14 @@ For example, here's the `Inter <https://rsms.me/inter/>`__ font without the
629629

630630
OpenType feature comparison (Inter)
631631

632+
You can disable ligatures and/or kerning for a specific font by adding OpenType
633+
features, then unchecking them in the inspector:
634+
635+
.. figure:: img/using_fonts_font_variation_disable_ligatures.webp
636+
:align: center
637+
638+
Disabling ligatures and kerning for a font
639+
632640
.. _doc_using_fonts_system_fonts:
633641

634642
System fonts
16.5 KB
Loading

0 commit comments

Comments
 (0)