doc/fcfreetype.sgml

   1 <!--
   2    fontconfig/doc/func.sgml
   3
   4    Copyright © 2003 Keith Packard
   5
   6    Permission to use, copy, modify, distribute, and sell this software and its
   7    documentation for any purpose is hereby granted without fee, provided that
   8    the above copyright notice appear in all copies and that both that
   9    copyright notice and this permission notice appear in supporting
  10    documentation, and that the name of the author(s) not be used in
  11    advertising or publicity pertaining to distribution of the software without
  12    specific, written prior permission.  The authors make no
  13    representations about the suitability of this software for any purpose.  It
  14    is provided "as is" without express or implied warranty.
  15
  16    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  19    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  20    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  21    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  22    PERFORMANCE OF THIS SOFTWARE.
  23  -->
  24     <refentry id="FcFreeTypeCharIndex">
  25         <refmeta>
  26             <refentrytitle>FcFreeTypeCharIndex</refentrytitle>
  27             <manvolnum>3</manvolnum>
  28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  29         </refmeta>
  30         <refnamediv>
  31             <refname>FcFreeTypeCharIndex</refname>
  32             <refpurpose>map Unicode to glyph id</refpurpose>
  33         </refnamediv>
  34         <refsynopsisdiv>
  35         <funcsynopsis>
  36         <funcsynopsisinfo>
  37 #include &lt;fontconfig.h&gt;
  38 #include &lt;fcfreetype.h&gt;
  39         </funcsynopsisinfo>
  40         <funcprototype>
  41             <funcdef>FT_UInt <function>FcFreeTypeCharIndex</function></funcdef>
  42                 <paramdef>FT_Face <parameter>face</parameter></paramdef>
  43                 <paramdef>FcChar32 <parameter>ucs4</parameter></paramdef>
  44         </funcprototype>
  45         </funcsynopsis>
  46         </refsynopsisdiv>
  47         <refsect1><title>Description</title>
  48             <para>
  49 Maps a Unicode char to a glyph index.  This function uses information from
  50 several possible underlying encoding tables to work around broken fonts.
  51 As a result, this function isn't designed to be used in performance
  52 sensitive areas; results from this function are intended to be cached by
  53 higher level functions.
  54             </para>
  55         </refsect1>
  56     </refentry>
  57 <!--
  58    fontconfig/doc/func.sgml
  59
  60    Copyright © 2003 Keith Packard
  61
  62    Permission to use, copy, modify, distribute, and sell this software and its
  63    documentation for any purpose is hereby granted without fee, provided that
  64    the above copyright notice appear in all copies and that both that
  65    copyright notice and this permission notice appear in supporting
  66    documentation, and that the name of the author(s) not be used in
  67    advertising or publicity pertaining to distribution of the software without
  68    specific, written prior permission.  The authors make no
  69    representations about the suitability of this software for any purpose.  It
  70    is provided "as is" without express or implied warranty.
  71
  72    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  73    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  74    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  75    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  76    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  77    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  78    PERFORMANCE OF THIS SOFTWARE.
  79  -->
  80     <refentry id="FcFreeTypeCharSet">
  81         <refmeta>
  82             <refentrytitle>FcFreeTypeCharSet</refentrytitle>
  83             <manvolnum>3</manvolnum>
  84             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  85         </refmeta>
  86         <refnamediv>
  87             <refname>FcFreeTypeCharSet</refname>
  88             <refpurpose>compute Unicode coverage</refpurpose>
  89         </refnamediv>
  90         <refsynopsisdiv>
  91         <funcsynopsis>
  92         <funcsynopsisinfo>
  93 #include &lt;fontconfig.h&gt;
  94 #include &lt;fcfreetype.h&gt;
  95         </funcsynopsisinfo>
  96         <funcprototype>
  97             <funcdef>FcCharSet * <function>FcFreeTypeCharSet</function></funcdef>
  98                 <paramdef>FT_Face <parameter>face</parameter></paramdef>
  99                 <paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
 100         </funcprototype>
 101         </funcsynopsis>
 102         </refsynopsisdiv>
 103         <refsect1><title>Description</title>
 104             <para>
 105 Scans a FreeType face and returns the set of encoded Unicode chars.
 106 FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
 107 accepted only for compatibility with older code.
 108             </para>
 109         </refsect1>
 110     </refentry>
 111 <!--
 112    fontconfig/doc/func.sgml
 113
 114    Copyright © 2003 Keith Packard
 115
 116    Permission to use, copy, modify, distribute, and sell this software and its
 117    documentation for any purpose is hereby granted without fee, provided that
 118    the above copyright notice appear in all copies and that both that
 119    copyright notice and this permission notice appear in supporting
 120    documentation, and that the name of the author(s) not be used in
 121    advertising or publicity pertaining to distribution of the software without
 122    specific, written prior permission.  The authors make no
 123    representations about the suitability of this software for any purpose.  It
 124    is provided "as is" without express or implied warranty.
 125
 126    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 127    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 128    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 129    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 130    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 131    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 132    PERFORMANCE OF THIS SOFTWARE.
 133  -->
 134     <refentry id="FcFreeTypeCharSetAndSpacing">
 135         <refmeta>
 136             <refentrytitle>FcFreeTypeCharSetAndSpacing</refentrytitle>
 137             <manvolnum>3</manvolnum>
 138             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 139         </refmeta>
 140         <refnamediv>
 141             <refname>FcFreeTypeCharSetAndSpacing</refname>
 142             <refpurpose>compute Unicode coverage and spacing type</refpurpose>
 143         </refnamediv>
 144         <refsynopsisdiv>
 145         <funcsynopsis>
 146         <funcsynopsisinfo>
 147 #include &lt;fontconfig.h&gt;
 148 #include &lt;fcfreetype.h&gt;
 149         </funcsynopsisinfo>
 150         <funcprototype>
 151             <funcdef>FcCharSet * <function>FcFreeTypeCharSetAndSpacing</function></funcdef>
 152                 <paramdef>FT_Face <parameter>face</parameter></paramdef>
 153                 <paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
 154                 <paramdef>int *<parameter>spacing</parameter></paramdef>
 155         </funcprototype>
 156         </funcsynopsis>
 157         </refsynopsisdiv>
 158         <refsect1><title>Description</title>
 159             <para>
 160 Scans a FreeType face and returns the set of encoded Unicode chars.
 161 FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
 162 accepted only for compatibility with older code.
 163 <parameter>spacing</parameter> receives the computed spacing type of the
 164 font, one of FC_MONO for a font where all glyphs have the same width,
 165 FC_DUAL, where the font has glyphs in precisely two widths, one twice as
 166 wide as the other, or FC_PROPORTIONAL where the font has glyphs of many
 167 widths.
 168             </para>
 169         </refsect1>
 170     </refentry>
 171 <!--
 172    fontconfig/doc/func.sgml
 173
 174    Copyright © 2003 Keith Packard
 175
 176    Permission to use, copy, modify, distribute, and sell this software and its
 177    documentation for any purpose is hereby granted without fee, provided that
 178    the above copyright notice appear in all copies and that both that
 179    copyright notice and this permission notice appear in supporting
 180    documentation, and that the name of the author(s) not be used in
 181    advertising or publicity pertaining to distribution of the software without
 182    specific, written prior permission.  The authors make no
 183    representations about the suitability of this software for any purpose.  It
 184    is provided "as is" without express or implied warranty.
 185
 186    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 187    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 188    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 189    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 190    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 191    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 192    PERFORMANCE OF THIS SOFTWARE.
 193  -->
 194     <refentry id="FcFreeTypeQuery">
 195         <refmeta>
 196             <refentrytitle>FcFreeTypeQuery</refentrytitle>
 197             <manvolnum>3</manvolnum>
 198             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 199         </refmeta>
 200         <refnamediv>
 201             <refname>FcFreeTypeQuery</refname>
 202             <refpurpose>compute pattern from font file (and index)</refpurpose>
 203         </refnamediv>
 204         <refsynopsisdiv>
 205         <funcsynopsis>
 206         <funcsynopsisinfo>
 207 #include &lt;fontconfig.h&gt;
 208 #include &lt;fcfreetype.h&gt;
 209         </funcsynopsisinfo>
 210         <funcprototype>
 211             <funcdef>FcPattern * <function>FcFreeTypeQuery</function></funcdef>
 212                 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
 213                 <paramdef>int <parameter>id</parameter></paramdef>
 214                 <paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
 215                 <paramdef>int *<parameter>count</parameter></paramdef>
 216         </funcprototype>
 217         </funcsynopsis>
 218         </refsynopsisdiv>
 219         <refsect1><title>Description</title>
 220             <para>
 221 Constructs a pattern representing the 'id'th face in 'file'.  The number
 222 of faces in 'file' is returned in 'count'.
 223 FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
 224 accepted only for compatibility with older code.
 225             </para>
 226         </refsect1>
 227     </refentry>
 228 <!--
 229    fontconfig/doc/func.sgml
 230
 231    Copyright © 2003 Keith Packard
 232
 233    Permission to use, copy, modify, distribute, and sell this software and its
 234    documentation for any purpose is hereby granted without fee, provided that
 235    the above copyright notice appear in all copies and that both that
 236    copyright notice and this permission notice appear in supporting
 237    documentation, and that the name of the author(s) not be used in
 238    advertising or publicity pertaining to distribution of the software without
 239    specific, written prior permission.  The authors make no
 240    representations about the suitability of this software for any purpose.  It
 241    is provided "as is" without express or implied warranty.
 242
 243    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 244    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 245    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 246    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 247    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 248    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 249    PERFORMANCE OF THIS SOFTWARE.
 250  -->
 251     <refentry id="FcFreeTypeQueryAll">
 252         <refmeta>
 253             <refentrytitle>FcFreeTypeQueryAll</refentrytitle>
 254             <manvolnum>3</manvolnum>
 255             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 256         </refmeta>
 257         <refnamediv>
 258             <refname>FcFreeTypeQueryAll</refname>
 259             <refpurpose>compute all patterns from font file (and index)</refpurpose>
 260         </refnamediv>
 261         <refsynopsisdiv>
 262         <funcsynopsis>
 263         <funcsynopsisinfo>
 264 #include &lt;fontconfig.h&gt;
 265 #include &lt;fcfreetype.h&gt;
 266         </funcsynopsisinfo>
 267         <funcprototype>
 268             <funcdef>unsigned int <function>FcFreeTypeQueryAll</function></funcdef>
 269                 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
 270                 <paramdef>int <parameter>id</parameter></paramdef>
 271                 <paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
 272                 <paramdef>int *<parameter>count</parameter></paramdef>
 273                 <paramdef>FcFontSet *<parameter>set</parameter></paramdef>
 274         </funcprototype>
 275         </funcsynopsis>
 276         </refsynopsisdiv>
 277         <refsect1><title>Description</title>
 278             <para>
 279 Constructs patterns found in 'file'.
 280 If id is -1, then all patterns found in 'file' are added to 'set'.
 281 Otherwise, this function works exactly like FcFreeTypeQuery().
 282 The number of faces in 'file' is returned in 'count'.
 283 The number of patterns added to 'set' is returned.
 284 FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
 285 accepted only for compatibility with older code.
 286             </para>
 287         </refsect1>
 288         <refsect1><title>Since</title>
 289             <para>version 2.12.91</para>
 290         </refsect1>
 291     </refentry>
 292 <!--
 293    fontconfig/doc/func.sgml
 294
 295    Copyright © 2003 Keith Packard
 296
 297    Permission to use, copy, modify, distribute, and sell this software and its
 298    documentation for any purpose is hereby granted without fee, provided that
 299    the above copyright notice appear in all copies and that both that
 300    copyright notice and this permission notice appear in supporting
 301    documentation, and that the name of the author(s) not be used in
 302    advertising or publicity pertaining to distribution of the software without
 303    specific, written prior permission.  The authors make no
 304    representations about the suitability of this software for any purpose.  It
 305    is provided "as is" without express or implied warranty.
 306
 307    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 308    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 309    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 310    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 311    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 312    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 313    PERFORMANCE OF THIS SOFTWARE.
 314  -->
 315     <refentry id="FcFreeTypeQueryFace">
 316         <refmeta>
 317             <refentrytitle>FcFreeTypeQueryFace</refentrytitle>
 318             <manvolnum>3</manvolnum>
 319             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 320         </refmeta>
 321         <refnamediv>
 322             <refname>FcFreeTypeQueryFace</refname>
 323             <refpurpose>compute pattern from FT_Face</refpurpose>
 324         </refnamediv>
 325         <refsynopsisdiv>
 326         <funcsynopsis>
 327         <funcsynopsisinfo>
 328 #include &lt;fontconfig.h&gt;
 329 #include &lt;fcfreetype.h&gt;
 330         </funcsynopsisinfo>
 331         <funcprototype>
 332             <funcdef>FcPattern * <function>FcFreeTypeQueryFace</function></funcdef>
 333                 <paramdef>const FT_Face <parameter>face</parameter></paramdef>
 334                 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
 335                 <paramdef>int <parameter>id</parameter></paramdef>
 336                 <paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
 337         </funcprototype>
 338         </funcsynopsis>
 339         </refsynopsisdiv>
 340         <refsect1><title>Description</title>
 341             <para>
 342 Constructs a pattern representing 'face'. 'file' and 'id' are used solely as
 343 data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY).
 344 FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
 345 accepted only for compatibility with older code.
 346             </para>
 347         </refsect1>
 348     </refentry>