aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-09-03 15:37:44 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-09-03 15:37:44 +0000
commitb71016c25dc18a2c098a87439046873c6c9ddb30 (patch)
treed26b848748013856dc29f9551ef5c6b2bcbdc30e /doc
parentMerge branch 'refresh-margins-on-background-palette-change' into master (diff)
render: optionally enable heuristics that deal with private usage area chars
Try to detect double-width *glyphs* for single-width *characters*, and allow them to overflow into the next cell. This is only done for single-width chars with a glyph width that is at least 1.5 cells wide, but at most 3 cells. The feature is gated by the new ‘tweak.allow-overflowing-double-width-glyphs’, and is disabled by default. Closes #116
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 9f8c6cbb..87a81a4e 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -440,6 +440,23 @@ foot.
When reporting bugs, please mention if, and to what, you have changed
any of these options.
+*allow-overflowing-double-width-glyphs*
+
+ When enabled, double width glyphs with a character width of 1 are
+ allowed to overflow into the neighbouring cell.
+
+ One use case for this is fonts "icon" characters in the Unicode
+ private usage area, e.g. Nerd Fonts, or Powerline Fonts. Without
+ this option, such glyphs will appear "cut off".
+
+ Another use case are legacy emoji characters like *WHITE FROWNING
+ FACE*.
+
+ Note: this feature uses _heuristics_ to determine *which* glyphs
+ should be allowed to overflow.
+
+ Default: _false_.
+
*render-timer*
Enables a frame rendering timer, that prints the time it takes to
render each frame, in microseconds, either on-screen, to stderr,