HarfBuzz text shaping engine
Go to file
Behdad Esfahbod 0c3d8c0d0f [README] Test adding as a symlink
Autoconf requires README
2022-06-04 06:05:23 -06:00
.ci [meson] Update cairo subproject 2022-02-13 13:21:14 -06:00
.circleci [ci] Fix fedora-valgrind job 2022-05-24 03:50:59 +02:00
.github/workflows Update Coverity settings 2022-04-22 02:22:29 +02:00
docs [doc] Expand a little bit on Uniscribe compatibility 2022-06-04 12:46:37 +01:00
m4 Revert "Remove autotools build support" 2020-08-11 23:51:59 +04:30
perf [benchmark-set] Another Pause/Resume 2022-05-30 05:54:20 -06:00
src Remove remaining mention to complex shapers in the code 2022-06-04 05:42:58 -06:00
subprojects Upgrade google benchmark dep to latest version to fix build failure. 2022-04-21 11:16:12 -06:00
test [name] Implement approximate language matching 2022-06-03 13:00:33 +01:00
util [util] Accept | as delimiter in Unicode parsing 2022-05-31 04:09:59 -06: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 fix build requirements for fedora/centos in buiding document 2022-05-13 13:10:11 -06:00
CMakeLists.txt CMakeLists.txt: also match 'AppleClang' compiler to not link with libc++ 2022-04-06 14:20:59 +02:00
CONFIG.md [CONFIG] Add HB_CONFIG_OVERRIDE_H to simplify config overrides 2021-12-03 11:49:55 -07:00
COPYING Update COPYING 2021-06-05 13:44:51 -06:00
Makefile.am Try to fix distcheck 2022-04-29 16:19:10 -06:00
NEWS 4.3.0 2022-05-20 21:07:25 +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 [mingw] Reinstate win32 cross-compiling with autotools instructions 2021-01-24 12:28:04 -07: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 [TESTING.md] Update profiling instructions. 2022-06-04 06:01:17 -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 [configure] Another try at fixing distcheck 2022-05-30 05:09:53 -06:00
git.mk [git.mk] Update 2022-01-13 11:01:39 -07:00
harfbuzz.doap Move all references of old url to the new address (#622) 2017-11-20 14:49:22 -05:00
meson.build 4.3.0 2022-05-20 21:07:25 +02:00
meson_options.txt [meson] Add graphite2 option and deprecate graphite 2021-10-23 10:59:02 -07:00
mingw-configure.sh [mingw] Reinstate win32 cross-compiling with autotools instructions 2021-01-24 12:28:04 -07: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