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