walkero
/
harfbuzz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Usermanual, minor: flesh out invisible-glyph discussion in buffers chapter.

This commit is contained in:
Nathan Willis 2019-05-11 20:56:02 +01:00
parent 68749e996a
commit 78fcb14db9
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/usermanual-buffers-language-script-and-direction.xml
View File

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