fcfreetype.fncs 5.29 KB
Newer Older
1
/*
Behdad Esfahbod's avatar
Behdad Esfahbod committed
2
 * fontconfig/doc/fcfreetype.fncs
3
 *
4
 * Copyright © 2003 Keith Packard
5 6 7 8 9
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that
 * 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 14 15
 * representations about the suitability of this software for any purpose.  It
 * is provided "as is" without express or implied warranty.
 *
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 20 21 22 23 24 25 26 27 28 29
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

@SYNOPSIS@
#include <fontconfig.h>
#include <fcfreetype.h>
@RET@           FT_UInt       
@FUNC@          FcFreeTypeCharIndex 
30 31
@TYPE1@         FT_Face%			@ARG1@          face      
@TYPE2@         FcChar32%			@ARG2@          ucs4      
32 33 34 35 36 37 38 39 40 41 42 43 44 45
@PURPOSE@	map Unicode to glyph id
@DESC@
Maps a Unicode char to a glyph index.  This function uses information from
several possible underlying encoding tables to work around broken fonts.
As a result, this function isn't designed to be used in performance
sensitive areas; results from this function are intended to be cached by
higher level functions.
@@

@SYNOPSIS@
#include <fontconfig.h>
#include <fcfreetype.h>
@RET@           FcCharSet *      
@FUNC@          FcFreeTypeCharSet 
46
@TYPE1@         FT_Face%			@ARG1@          face      
47
@TYPE2@         FcBlanks *			@ARG2@          blanks
Brad Hards's avatar
Brad Hards committed
48
@PURPOSE@	compute Unicode coverage
49
@DESC@
50 51 52
Scans a FreeType face and returns the set of encoded Unicode chars.
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
53 54 55 56
@@

@SYNOPSIS@
#include &lt;fontconfig.h&gt;
57 58 59 60 61 62
#include &lt;fcfreetype.h&gt;
@RET@           FcCharSet *      
@FUNC@          FcFreeTypeCharSetAndSpacing 
@TYPE1@         FT_Face%			@ARG1@          face      
@TYPE2@         FcBlanks *			@ARG2@          blanks
@TYPE3@		int *				@ARG3@		spacing
Brad Hards's avatar
Brad Hards committed
63
@PURPOSE@	compute Unicode coverage and spacing type
64 65
@DESC@
Scans a FreeType face and returns the set of encoded Unicode chars.
66 67
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
68 69 70 71 72 73 74 75 76
<parameter>spacing</parameter> receives the computed spacing type of the
font, one of FC_MONO for a font where all glyphs have the same width,
FC_DUAL, where the font has glyphs in precisely two widths, one twice as
wide as the other, or FC_PROPORTIONAL where the font has glyphs of many
widths.  
@@

@SYNOPSIS@
#include &lt;fontconfig.h&gt;
77 78 79
#include &lt;fcfreetype.h&gt;
@RET@           FcPattern *      
@FUNC@          FcFreeTypeQuery 
80
@TYPE1@         const FcChar8 *			@ARG1@          file      
81
@TYPE2@         int%				@ARG2@          id      
82 83
@TYPE3@         FcBlanks *			@ARG3@          blanks      
@TYPE4@         int *				@ARG4@          count      
84
@PURPOSE@	compute pattern from font file (and index)
85
@DESC@
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
Constructs a pattern representing the 'id'th face in 'file'.  The number
of faces in 'file' is returned in 'count'.
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
@@

unsigned int
FcFreeTypeQueryAll(const FcChar8	*file,
		   int			id,
		   FcBlanks		*blanks,
		   int			*count,
		   FcFontSet            *set)
@SYNOPSIS@
#include &lt;fontconfig.h&gt;
#include &lt;fcfreetype.h&gt;
@RET@           unsigned int
@FUNC@          FcFreeTypeQueryAll
@TYPE1@         const FcChar8 *			@ARG1@          file
@TYPE2@         int%				@ARG2@          id
@TYPE3@         FcBlanks *			@ARG3@          blanks
@TYPE4@         int *				@ARG4@          count
@TYPE5@         FcFontSet *			@ARG5@          set
@PURPOSE@	compute all patterns from font file (and index)
@DESC@
Constructs patterns found in 'file'.
If id is -1, then all patterns found in 'file' are added to 'set'.
Otherwise, this function works exactly like FcFreeTypeQuery().
The number of faces in 'file' is returned in 'count'.
The number of patterns added to 'set' is returned.
115 116
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
Akira TAGOH's avatar
Akira TAGOH committed
117
@SINCE@		2.12.91
118
@@
119 120 121 122 123 124

@SYNOPSIS@
#include &lt;fontconfig.h&gt;
#include &lt;fcfreetype.h&gt;
@RET@           FcPattern *      
@FUNC@          FcFreeTypeQueryFace
125
@TYPE1@		const FT_Face%			@ARG1@		face
126
@TYPE2@         const FcChar8 *			@ARG2@          file
127
@TYPE3@         int%				@ARG3@          id
128 129 130 131 132
@TYPE4@         FcBlanks *			@ARG4@          blanks
@PURPOSE@	compute pattern from FT_Face
@DESC@
Constructs a pattern representing 'face'. 'file' and 'id' are used solely as
data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY).
133 134
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
135
@@