doc/fcfreetype.fncs

   1 /*
   2  * fontconfig/doc/fcfreetype.fncs
   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
  25 @SYNOPSIS@
  26 #include &lt;fontconfig.h&gt;
  27 #include &lt;fcfreetype.h&gt;
  28 @RET@           FT_UInt
  29 @FUNC@          FcFreeTypeCharIndex
  30 @TYPE1@         FT_Face%                        @ARG1@          face
  31 @TYPE2@         FcChar32%                       @ARG2@          ucs4
  32 @PURPOSE@       map Unicode to glyph id
  33 @DESC@
  34 Maps a Unicode char to a glyph index.  This function uses information from
  35 several possible underlying encoding tables to work around broken fonts.
  36 As a result, this function isn't designed to be used in performance
  37 sensitive areas; results from this function are intended to be cached by
  38 higher level functions.
  39 @@
  40
  41 @SYNOPSIS@
  42 #include &lt;fontconfig.h&gt;
  43 #include &lt;fcfreetype.h&gt;
  44 @RET@           FcCharSet *
  45 @FUNC@          FcFreeTypeCharSet
  46 @TYPE1@         FT_Face%                        @ARG1@          face
  47 @TYPE2@         FcBlanks *                      @ARG2@          blanks
  48 @PURPOSE@       compute Unicode coverage
  49 @DESC@
  50 Scans a FreeType face and returns the set of encoded Unicode chars.  This scans
  51 several encoding tables to build as complete a list as possible.
  52 If 'blanks' is not 0, the glyphs in the font are examined and any blank glyphs
  53 not in 'blanks' are not placed in the returned FcCharSet.
  54 @@
  55
  56 @SYNOPSIS@
  57 #include &lt;fontconfig.h&gt;
  58 #include &lt;fcfreetype.h&gt;
  59 @RET@           FcCharSet *
  60 @FUNC@          FcFreeTypeCharSetAndSpacing
  61 @TYPE1@         FT_Face%                        @ARG1@          face
  62 @TYPE2@         FcBlanks *                      @ARG2@          blanks
  63 @TYPE3@         int *                           @ARG3@          spacing
  64 @PURPOSE@       compute Unicode coverage and spacing type
  65 @DESC@
  66 Scans a FreeType face and returns the set of encoded Unicode chars.
  67 This scans
  68 several encoding tables to build as complete a list as possible.
  69 If 'blanks' is not 0, the glyphs in the font are examined and any blank glyphs
  70 not in 'blanks' are not placed in the returned FcCharSet.
  71 <parameter>spacing</parameter> receives the computed spacing type of the
  72 font, one of FC_MONO for a font where all glyphs have the same width,
  73 FC_DUAL, where the font has glyphs in precisely two widths, one twice as
  74 wide as the other, or FC_PROPORTIONAL where the font has glyphs of many
  75 widths.
  76 @@
  77
  78 @SYNOPSIS@
  79 #include &lt;fontconfig.h&gt;
  80 #include &lt;fcfreetype.h&gt;
  81 @RET@           FcPattern *
  82 @FUNC@          FcFreeTypeQuery
  83 @TYPE1@         const FcChar8 *                 @ARG1@          file
  84 @TYPE2@         int%                            @ARG2@          id
  85 @TYPE3@         FcBlanks *                      @ARG3@          blanks
  86 @TYPE4@         int *                           @ARG4@          count
  87 @PURPOSE@       compute pattern from font file (and index)
  88 @DESC@
  89 Constructs a pattern representing the 'id'th font in 'file'.  The number
  90 of fonts in 'file' is returned in 'count'.
  91 @@
  92
  93 @SYNOPSIS@
  94 #include &lt;fontconfig.h&gt;
  95 #include &lt;fcfreetype.h&gt;
  96 @RET@           FcPattern *
  97 @FUNC@          FcFreeTypeQueryFace
  98 @TYPE1@         const FT_Face%                  @ARG1@          face
  99 @TYPE2@         const FcChar8 *                 @ARG2@          file
 100 @TYPE3@         int%                            @ARG3@          id
 101 @TYPE4@         FcBlanks *                      @ARG4@          blanks
 102 @PURPOSE@       compute pattern from FT_Face
 103 @DESC@
 104 Constructs a pattern representing 'face'. 'file' and 'id' are used solely as
 105 data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY).
 106 @@