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.  This scans
 106 several encoding tables to build as complete a list as possible.
 107 If 'blanks' is not 0, the glyphs in the font are examined and any blank glyphs
 108 not in 'blanks' are not placed in the returned FcCharSet.
 109             </para>
 110         </refsect1>
 111     </refentry>
 112 <!--
 113    fontconfig/doc/func.sgml
 114
 115    Copyright © 2003 Keith Packard
 116
 117    Permission to use, copy, modify, distribute, and sell this software and its
 118    documentation for any purpose is hereby granted without fee, provided that
 119    the above copyright notice appear in all copies and that both that
 120    copyright notice and this permission notice appear in supporting
 121    documentation, and that the name of the author(s) not be used in
 122    advertising or publicity pertaining to distribution of the software without
 123    specific, written prior permission.  The authors make no
 124    representations about the suitability of this software for any purpose.  It
 125    is provided "as is" without express or implied warranty.
 126
 127    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 128    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 129    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 130    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 131    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 132    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 133    PERFORMANCE OF THIS SOFTWARE.
 134  -->
 135     <refentry id="FcFreeTypeCharSetAndSpacing">
 136         <refmeta>
 137             <refentrytitle>FcFreeTypeCharSetAndSpacing</refentrytitle>
 138             <manvolnum>3</manvolnum>
 139             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 140         </refmeta>
 141         <refnamediv>
 142             <refname>FcFreeTypeCharSetAndSpacing</refname>
 143             <refpurpose>compute Unicode coverage and spacing type</refpurpose>
 144         </refnamediv>
 145         <refsynopsisdiv>
 146         <funcsynopsis>
 147         <funcsynopsisinfo>
 148 #include &lt;fontconfig.h&gt;
 149 #include &lt;fcfreetype.h&gt;
 150         </funcsynopsisinfo>
 151         <funcprototype>
 152             <funcdef>FcCharSet * <function>FcFreeTypeCharSetAndSpacing</function></funcdef>
 153                 <paramdef>FT_Face <parameter>face</parameter></paramdef>
 154                 <paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
 155                 <paramdef>int *<parameter>spacing</parameter></paramdef>
 156         </funcprototype>
 157         </funcsynopsis>
 158         </refsynopsisdiv>
 159         <refsect1><title>Description</title>
 160             <para>
 161 Scans a FreeType face and returns the set of encoded Unicode chars.
 162 This scans
 163 several encoding tables to build as complete a list as possible.
 164 If 'blanks' is not 0, the glyphs in the font are examined and any blank glyphs
 165 not in 'blanks' are not placed in the returned FcCharSet.
 166 <parameter>spacing</parameter> receives the computed spacing type of the
 167 font, one of FC_MONO for a font where all glyphs have the same width,
 168 FC_DUAL, where the font has glyphs in precisely two widths, one twice as
 169 wide as the other, or FC_PROPORTIONAL where the font has glyphs of many
 170 widths.
 171             </para>
 172         </refsect1>
 173     </refentry>
 174 <!--
 175    fontconfig/doc/func.sgml
 176
 177    Copyright © 2003 Keith Packard
 178
 179    Permission to use, copy, modify, distribute, and sell this software and its
 180    documentation for any purpose is hereby granted without fee, provided that
 181    the above copyright notice appear in all copies and that both that
 182    copyright notice and this permission notice appear in supporting
 183    documentation, and that the name of the author(s) not be used in
 184    advertising or publicity pertaining to distribution of the software without
 185    specific, written prior permission.  The authors make no
 186    representations about the suitability of this software for any purpose.  It
 187    is provided "as is" without express or implied warranty.
 188
 189    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 190    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 191    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 192    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 193    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 194    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 195    PERFORMANCE OF THIS SOFTWARE.
 196  -->
 197     <refentry id="FcFreeTypeQuery">
 198         <refmeta>
 199             <refentrytitle>FcFreeTypeQuery</refentrytitle>
 200             <manvolnum>3</manvolnum>
 201             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 202         </refmeta>
 203         <refnamediv>
 204             <refname>FcFreeTypeQuery</refname>
 205             <refpurpose>compute pattern from font file (and index)</refpurpose>
 206         </refnamediv>
 207         <refsynopsisdiv>
 208         <funcsynopsis>
 209         <funcsynopsisinfo>
 210 #include &lt;fontconfig.h&gt;
 211 #include &lt;fcfreetype.h&gt;
 212         </funcsynopsisinfo>
 213         <funcprototype>
 214             <funcdef>FcPattern * <function>FcFreeTypeQuery</function></funcdef>
 215                 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
 216                 <paramdef>int <parameter>id</parameter></paramdef>
 217                 <paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
 218                 <paramdef>int *<parameter>count</parameter></paramdef>
 219         </funcprototype>
 220         </funcsynopsis>
 221         </refsynopsisdiv>
 222         <refsect1><title>Description</title>
 223             <para>
 224 Constructs a pattern representing the 'id'th font in 'file'.  The number
 225 of fonts in 'file' is returned in 'count'.
 226             </para>
 227         </refsect1>
 228     </refentry>
 229 <!--
 230    fontconfig/doc/func.sgml
 231
 232    Copyright © 2003 Keith Packard
 233
 234    Permission to use, copy, modify, distribute, and sell this software and its
 235    documentation for any purpose is hereby granted without fee, provided that
 236    the above copyright notice appear in all copies and that both that
 237    copyright notice and this permission notice appear in supporting
 238    documentation, and that the name of the author(s) not be used in
 239    advertising or publicity pertaining to distribution of the software without
 240    specific, written prior permission.  The authors make no
 241    representations about the suitability of this software for any purpose.  It
 242    is provided "as is" without express or implied warranty.
 243
 244    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 245    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 246    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 247    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 248    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 249    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 250    PERFORMANCE OF THIS SOFTWARE.
 251  -->
 252     <refentry id="FcFreeTypeQueryFace">
 253         <refmeta>
 254             <refentrytitle>FcFreeTypeQueryFace</refentrytitle>
 255             <manvolnum>3</manvolnum>
 256             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 257         </refmeta>
 258         <refnamediv>
 259             <refname>FcFreeTypeQueryFace</refname>
 260             <refpurpose>compute pattern from FT_Face</refpurpose>
 261         </refnamediv>
 262         <refsynopsisdiv>
 263         <funcsynopsis>
 264         <funcsynopsisinfo>
 265 #include &lt;fontconfig.h&gt;
 266 #include &lt;fcfreetype.h&gt;
 267         </funcsynopsisinfo>
 268         <funcprototype>
 269             <funcdef>FcPattern * <function>FcFreeTypeQueryFace</function></funcdef>
 270                 <paramdef>const FT_Face <parameter>face</parameter></paramdef>
 271                 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
 272                 <paramdef>int <parameter>id</parameter></paramdef>
 273                 <paramdef>FcBlanks *<parameter>blanks</parameter></paramdef>
 274         </funcprototype>
 275         </funcsynopsis>
 276         </refsynopsisdiv>
 277         <refsect1><title>Description</title>
 278             <para>
 279 Constructs a pattern representing 'face'. 'file' and 'id' are used solely as
 280 data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY).
 281             </para>
 282         </refsect1>
 283     </refentry>