diff --git a/docs/usermanual-buffers-language-script-and-direction.xml b/docs/usermanual-buffers-language-script-and-direction.xml index 719b6880f..b66f2709c 100644 --- a/docs/usermanual-buffers-language-script-and-direction.xml +++ b/docs/usermanual-buffers-language-script-and-direction.xml @@ -234,6 +234,10 @@ hb_buffer_set_replacement_codepoint(buf, replacement); + + passing in the replacement Unicode code point as the + replacement parameter. + The invisible glyph is used to replace all output glyphs that are invisible. By default, the standard space character @@ -242,8 +246,13 @@ spaces) with - hb_buffer_set_invisible_glyph(buf, replacement); + hb_buffer_set_invisible_glyph(buf, replacement_glyph); + + Do note that in the replacement_glyph + parameter, you must provide the glyph ID of the replacement you + wish to use, not the Unicode code point. + HarfBuzz supports a few additional flags you might want to set on your buffer under certain circumstances. The @@ -262,8 +271,9 @@ property designates control characters and other non-printing code points, such as joiners and variation selectors. Normally HarfBuzz replaces them in the output buffer with zero-width - space glyphs; setting this flag causes them to be printed, - which can be helpful for troubleshooting. + space glyphs (using the "invisible glyph" property discussed + above); setting this flag causes them to be printed, which can + be helpful for troubleshooting. Conversely, setting the @@ -315,7 +325,8 @@ In addition, you can mark your unicode_funcs as immutable by calling - hb_unicode_funcs_make_immutable (ufuncs). This is especially useful if your code is a + hb_unicode_funcs_make_immutable (ufuncs). + This is especially useful if your code is a library or framework that will have its own client programs. By marking your Unicode function choices as immutable, you prevent your own client programs from changing the