HarfBuzz text shaping engine
Go to file
Behdad Esfahbod afd9a58bd7 [vector] Save a couple hb_iter() invocations 2022-11-18 16:47:32 -07:00
.ci Revert "[ci] Mark automatic releases as draft" 2022-10-08 19:33:38 +02:00
.circleci [subset] Add amalgam harfbuzz-subset.cc 2022-07-19 17:15:35 -06:00
.github [CI] Remove coverage testing from macos-ci 2022-11-14 14:35:55 -07:00
docs [doc] Hide another experimental symbol 2022-10-19 22:04:57 +02:00
m4 Revert "Remove autotools build support" 2020-08-11 23:51:59 +04:30
perf [perf] Add fa-words.txt and use in shape benchmark 2022-11-16 16:35:00 -07:00
src [vector] Save a couple hb_iter() invocations 2022-11-18 16:47:32 -07:00
subprojects [meson] Remove ttf-parser wrap 2022-06-29 00:42:40 +02:00
test [subset] add an experimental API that can override name strings for specified name_id 2022-11-08 14:10:25 -07:00
util [util] Move variable closer to use 2022-11-13 17:06:58 -07:00
.clang-format Add an initial .clang-format config 2019-01-09 16:01:11 +03:30
.codecov.yml [ci] Disable patch-level codecov failures 2021-06-04 14:51:49 -06:00
.editorconfig [meson] Minor, replace tabs with spaces 2020-03-24 19:06:09 +00:00
AUTHORS Update AUTHORS / COPYING 2019-04-21 12:26:07 -04:00
BUILD.md [BUILD] Minor reword (and reformat) 2022-08-16 13:21:02 -06:00
CMakeLists.txt [cmake] Generate pkg-config .pc files 2022-09-06 18:28:43 +05:30
CONFIG.md [CONFIG.md] Grammar 2022-06-21 13:39:16 -06:00
COPYING Update COPYING 2021-06-05 13:44:51 -06:00
Makefile.am [meson] Remove ttf-parser wrap 2022-06-29 00:42:40 +02:00
NEWS 5.3.1 2022-10-19 22:06:46 +02:00
README [README] Test adding as a symlink 2022-06-04 06:05:23 -06:00
README.md [README.md] minor 2022-06-04 06:01:52 -06:00
README.mingw.md [mingw32] Update instructions 2022-07-14 11:03:04 -06:00
README.python.md [docs] Update README.python.md with meson 2020-08-03 18:41:49 +04:30
RELEASING.md Fix various typos 2022-01-16 05:39:03 -08:00
TESTING.md Update test/fuzzing/README 2022-08-03 11:31:34 -06:00
THANKS [THANKS] Add Ivan Kuckir <https://photopea.com/> 2019-04-24 15:08:27 -07:00
autogen.sh Revert "Remove autotools build support" 2020-08-11 23:51:59 +04:30
configure.ac 5.3.1 2022-10-19 22:06:46 +02:00
git.mk [git.mk] Update 2022-01-13 11:01:39 -07:00
harfbuzz.doap [doap] Update 2022-06-21 13:19:08 -06:00
meson.build meson: fix regression in detecting freetype2/icu-uc when explicitly disabled 2022-11-08 18:32:41 -07:00
meson_options.txt [meson] Add graphite2 option and deprecate graphite 2021-10-23 10:59:02 -07:00
mingw-configure.sh [mingw2] Turn optimization flag on 2022-06-27 19:45:58 -06:00
replace-enum-strings.cmake Revert "Remove cmake build files" 2020-08-12 01:00:33 +04:30

README.md

Linux CI Status CircleCI Build Status OSS-Fuzz Status Coverity Scan Build Status Codacy Badge Codecov Code Coverage Packaging status

HarfBuzz

HarfBuzz is a text shaping engine. It primarily supports OpenType, but also Apple Advanced Typography. HarfBuzz is used in Android, Chrome, ChromeOS, Firefox, GNOME, GTK+, KDE, LibreOffice, OpenJDK, PlayStation, Qt, XeTeX, and other places.

For bug reports, mailing list, and other information please visit:

http://harfbuzz.org/

For license information, see COPYING.

Documentation

For user manual as well as API documentation, check: https://harfbuzz.github.io

Download

For tarball releases of HarfBuzz, look here. At the same place you will also find Win32/Win64 binary bundles that include libharfbuzz DLL, hb-view.exe, hb-shape.exe, and all dependencies.

The canonical source tree is available on github.

The API that comes with hb.h will not change incompatibly. Other, peripheral, headers are more likely to go through minor modifications, but again, we do our best to never change API in an incompatible way. We will never break the ABI.

If you are not sure whether Pango or HarfBuzz is right for you, read Pango vs HarfBuzz.

Development

For build information, see BUILD.md.

For custom configurations, see CONFIG.md.

For testing and profiling, see TESTING.md.

To get a better idea of where HarfBuzz stands in the text rendering stack you may want to read State of Text Rendering, though, that document is many years old. Here are a few presentation slides about HarfBuzz at the Internationalization and Unicode Conference over the years:

Both development and user support discussion around HarfBuzz happens on the github.

To report bugs or submit patches please use github issues and pull-requests.

For a comparison of old vs new HarfBuzz memory consumption see this.

Name

HarfBuzz (حرف‌باز) is my Persian translation of “OpenType”, transliterated using the Latin script. It sports a second meaning, but that aint translatable.

Background: Originally there was this font format called TrueType. People and companies started calling their type engines all things ending in Type: FreeType, CoolType, ClearType, etc. And then came OpenType, which is the successor of TrueType. So, for my OpenType implementation, I decided to stick with the concept but use the Persian translation. Which is fitting given that Persian is written in the Arabic script, and OpenType is an extension of TrueType that adds support for complex script rendering, and HarfBuzz is an implementation of OpenType complex text shaping.

Packaging status of HarfBuzz

Packaging status