kitty/docs
Kovid Goyal cb7cf51d87
Glyph protocol: render registered glyphs
Cells containing a codepoint from the registration block that had a
registered glyph when they were printed are rendered with that glyph,
into the area the character occupies: its cell, the cells given to it
by the text sizing protocol, or two cells when it is followed by a space
and the width of its viewBox when fit to the cell height is more than
one cell.

The glyph is bound to the text when it is printed, by storing a
reference to it in the text cache entry of the cell. Changing or
clearing a registration affects only text printed afterwards, so
programs using the same codepoints do not change each other's output
and registering never requires re-rendering lines. Bound entries are
kept in a separate map so that other text is not slowed down. Glyphs
are interned by a seeded hash of their content.

Glyphs that use only the foreground color are alpha masks and glyphs
that use only fixed colors are colored sprites. Glyphs that mix them are
a colored sprite followed in the sprite map by a sprite with the weight
of the foreground color, which the cell shader combines with the
foreground color, so that selection, cursor and other foreground color
changes apply to them exactly.

Sprites of a glyph are freed when the glyph is, which happens only when
no cell uses it, and are reused. Each window can keep alive a limited
number and size of glyphs, beyond which registration fails with
no_space, so a program that keeps registering and printing new glyphs
cannot exhaust memory or sprites for other windows.
2026-11-19 19:57:38 +05:30
..
_static Cleanup previous PR 2026-10-09 20:41:46 +05:30
_templates Switch to GA2 2022-06-30 17:00:14 +05:30
kittens Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
screenshots Add explicit edge resizing for Splits and preserve resize sessions 2026-10-09 19:54:02 +08:00
actions.rst Cleanup previous PR 2026-03-23 08:54:57 +05:30
basic.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
binary.rst Add nightly version to version string for nightly builds. Fixes #10751 2026-10-27 10:43:51 +05:30
build.rst Read variable font data from WOFF and WOFF2 files in font selection 2026-11-19 19:57:36 +05:30
changelog.rst ... 2026-11-19 19:57:36 +05:30
clipboard.rst clipboard protocol: Specify handling of invalid base64 data 2026-08-25 10:12:25 +05:30
color-stack.rst Color control protocol: Respond to unknown field names safely using base64 encoding 2026-09-01 21:20:04 +05:30
conf.py docs: Have the :commit: role fall back to linking the given id when there is no git history 2026-11-18 09:40:29 +05:30
conf.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
custom-shaders.rst Replace sync_to_monitor and repaint_delay with render_interval 2026-11-19 19:57:36 +05:30
deccara.rst Docs: Improve the documentations 2022-04-30 17:07:36 +08:00
desktop-notifications.rst Handle ConEmu OSC 9;9 cwd reporting and ignore other ConEmu OSC 9 sub-commands 2026-11-13 19:44:02 +05:30
dnd-protocol.rst Add a line to the spec to clarify that MIME types from first move only can be relied upon 2026-10-30 18:20:53 +05:30
extract-rst-targets.py autoformat 2026-08-05 05:32:56 +05:30
faq.rst Switch from sphinx-inline-tabs to sphinx-design 2026-08-09 14:31:33 +05:30
file-transfer-protocol.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
glossary.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
graphics-protocol.rst docs: add kmp-terminal and SSH Client for Android to graphics protocol 2026-10-29 20:58:38 +00:00
index.rst Switch from sphinx-inline-tabs to sphinx-design 2026-08-09 14:31:33 +05:30
installer.sh Also use diskutil in a couple more scripts 2026-09-24 09:32:05 +05:30
integrations.rst Add show-your-work to integrations 2026-10-11 14:09:07 +05:00
intro_vid.rst Cleanup previous PR 2026-10-09 20:41:46 +05:30
invocation.rst A new theme for the kitty website 2021-07-18 13:29:33 +05:30
keyboard-protocol.rst Add T1K to the list of terminals implementing the keyboard protocol 2026-11-10 09:53:59 +02:00
kittens_intro.rst Docs for the dnd kitten 2026-05-06 08:12:00 +05:30
launch.rst Fix #10858 2026-11-14 08:16:53 +05:30
layouts.rst Allow resizing docks 2026-11-13 19:44:03 +05:30
Makefile Fix #10577 2026-10-01 17:23:37 +05:30
mapping.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
marks.rst Docs: Improve the documentations 2022-04-30 17:07:36 +08:00
misc-protocol.rst Glyph protocol: render registered glyphs 2026-11-19 19:57:38 +05:30
multiple-cursors-protocol.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
notifications.py autoformat 2026-08-05 05:32:56 +05:30
open_actions.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
overview.rst Allow selecting text drawn in the tab bar outside the tabs 2026-11-15 09:32:37 +05:30
performance.rst Speed up processing of text that scrolls the screen 2026-11-19 19:57:37 +05:30
pipe.rst A new theme for the kitty website 2021-07-18 13:29:33 +05:30
pointer-shapes.rst ... 2025-01-06 21:57:31 +05:30
press-mentions.rst Add some video reviews to press mentions 2022-02-26 09:54:16 +05:30
protocol-extensions.rst More dnd protocol docs 2026-03-21 08:41:46 +05:30
quake-screenshots.rst Fix #9127 2025-10-20 08:16:48 +05:30
quickstart.rst Fix repology link in quickstart doc 2025-01-10 17:02:52 +08:00
rc_protocol.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
remote-control.rst Further harden remote control password processing 2026-11-03 17:36:01 +05:30
requirements.txt Switch from sphinx-inline-tabs to sphinx-design 2026-08-09 14:31:33 +05:30
sessions.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
shell-integration.rst Cleanup previous PR 2026-10-18 21:33:34 +05:30
support.html Make paypal button appearance match the rest 2021-09-03 09:24:55 +05:30
support.rst Docs: Use underscores in kitten document filenames 2021-12-10 17:30:51 +08:00
text-sizing-protocol.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00
underlines.rst Docs: Improve the documentations 2022-04-30 17:07:36 +08:00
unscroll.rst Docs: Improve the documentations 2022-04-30 17:07:36 +08:00
wide-gamut-colors.rst Docs: Correct protocol references, examples and generated help 2026-10-28 13:24:43 +08:00