aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTimur Celik <mail@timurcelik.de>2021-06-15 09:45:27 +0000
committerTimur Celik <mail@timurcelik.de>2021-07-17 11:22:44 +0000
commit91801ae55da017c2dd0f44c04b8d316a9a2090ef (patch)
tree44765677b23ddafa155bfc640411c420d10fff66 /doc
parentMerge branch 'decsdm' (diff)
render: Allow cells to bleed into their neighbor
This patch adds a `confined` flag to each cell to track if the last rendered glyph bled into it's right neighbor. To keep things simple, bleeding into any other neighbor cell than the immediate right one is not allowed. This should cover most use cases. Before rendering a row we now do a prepass and mark all cells unclean that are affected by a bleeding neighbor. If there are consecutive bleeding cells, the whole group must be re-rendered even if only a single cell has changed. The patch also deprecates both old overflowing glyph options *allow-overflowing-double-width-glyphs* and *pua-double-width* in favor of a single new one named *overflowing-glyphs*.
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd34
1 files changed, 12 insertions, 22 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 6ceaf3b9..8b2f1dc8 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -847,34 +847,24 @@ any of these options.
Default: _lanczos3_.
-*allow-overflowing-double-width-glyphs*
- Boolean. When enabled, double width glyphs with a character width
- of 1 are allowed to overflow into the neighbouring cell.
+*overflowing-glyphs*
+ Boolean. When enabled, glyphs wider than their cell(s) are allowed
+ to render into one additional 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".
+ One use case for this are fonts with wide italic characters that
+ "bend" into the next cell. Without this option, such glyphs will
+ appear "cut off".
- Another use case are legacy emoji characters like *WHITE FROWNING
- FACE*.
+ Another use case are fonts with "icon" characters in the Unicode
+ private usage area, e.g. Nerd Fonts, or Powerline Fonts and legacy
+ emoji characters like *WHITE FROWNING FACE*.
- Note: this feature uses _heuristics_ to determine *which* glyphs
- should be allowed to overflow.
-
- See also: *pua-double-width*
+ Note: might impact performance depending on the font used.
+ Especially small font sizes can cause many overflowing glyphs
+ because of subpixel rendering.
Default: _yes_.
-*pua-double-width*
- Boolean. When enabled, Unicode code points from the private usage
- area (PUA) are always considered to be double width, regardless of
- the actual glyph width.
-
- Ignored if *allow-overflowing-double-width-glyphs* has been
- disabled.
-
- Default: _no_.
-
*render-timer*
Enables a frame rendering timer, that prints the time it takes to
render each frame, in microseconds, either on-screen, to stderr,