Blame doc/fcfreetype.fncs

Packit 352660
/*
Packit 352660
 * fontconfig/doc/fcfreetype.fncs
Packit 352660
 *
Packit 352660
 * Copyright © 2003 Keith Packard
Packit 352660
 *
Packit 352660
 * Permission to use, copy, modify, distribute, and sell this software and its
Packit 352660
 * documentation for any purpose is hereby granted without fee, provided that
Packit 352660
 * the above copyright notice appear in all copies and that both that
Packit 352660
 * copyright notice and this permission notice appear in supporting
Packit 352660
 * documentation, and that the name of the author(s) not be used in
Packit 352660
 * advertising or publicity pertaining to distribution of the software without
Packit 352660
 * specific, written prior permission.  The authors make no
Packit 352660
 * representations about the suitability of this software for any purpose.  It
Packit 352660
 * is provided "as is" without express or implied warranty.
Packit 352660
 *
Packit 352660
 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
Packit 352660
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
Packit 352660
 * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
Packit 352660
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
Packit 352660
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
Packit 352660
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
Packit 352660
 * PERFORMANCE OF THIS SOFTWARE.
Packit 352660
 */
Packit 352660
Packit 352660
@SYNOPSIS@
Packit 352660
#include <fontconfig.h>
Packit 352660
#include <fcfreetype.h>
Packit 352660
@RET@           FT_UInt       
Packit 352660
@FUNC@          FcFreeTypeCharIndex 
Packit 352660
@TYPE1@         FT_Face%			@ARG1@          face      
Packit 352660
@TYPE2@         FcChar32%			@ARG2@          ucs4      
Packit 352660
@PURPOSE@	map Unicode to glyph id
Packit 352660
@DESC@
Packit 352660
Maps a Unicode char to a glyph index.  This function uses information from
Packit 352660
several possible underlying encoding tables to work around broken fonts.
Packit 352660
As a result, this function isn't designed to be used in performance
Packit 352660
sensitive areas; results from this function are intended to be cached by
Packit 352660
higher level functions.
Packit 352660
@@
Packit 352660
Packit 352660
@SYNOPSIS@
Packit 352660
#include <fontconfig.h>
Packit 352660
#include <fcfreetype.h>
Packit 352660
@RET@           FcCharSet *      
Packit 352660
@FUNC@          FcFreeTypeCharSet 
Packit 352660
@TYPE1@         FT_Face%			@ARG1@          face      
Packit 352660
@TYPE2@         FcBlanks *			@ARG2@          blanks
Packit 352660
@PURPOSE@	compute Unicode coverage
Packit 352660
@DESC@
Packit 352660
Scans a FreeType face and returns the set of encoded Unicode chars.
Packit 352660
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
Packit 352660
accepted only for compatibility with older code.
Packit 352660
@@
Packit 352660
Packit 352660
@SYNOPSIS@
Packit 352660
#include <fontconfig.h>
Packit 352660
#include <fcfreetype.h>
Packit 352660
@RET@           FcCharSet *      
Packit 352660
@FUNC@          FcFreeTypeCharSetAndSpacing 
Packit 352660
@TYPE1@         FT_Face%			@ARG1@          face      
Packit 352660
@TYPE2@         FcBlanks *			@ARG2@          blanks
Packit 352660
@TYPE3@		int *				@ARG3@		spacing
Packit 352660
@PURPOSE@	compute Unicode coverage and spacing type
Packit 352660
@DESC@
Packit 352660
Scans a FreeType face and returns the set of encoded Unicode chars.
Packit 352660
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
Packit 352660
accepted only for compatibility with older code.
Packit 352660
<parameter>spacing</parameter> receives the computed spacing type of the
Packit 352660
font, one of FC_MONO for a font where all glyphs have the same width,
Packit 352660
FC_DUAL, where the font has glyphs in precisely two widths, one twice as
Packit 352660
wide as the other, or FC_PROPORTIONAL where the font has glyphs of many
Packit 352660
widths.  
Packit 352660
@@
Packit 352660
Packit 352660
@SYNOPSIS@
Packit 352660
#include <fontconfig.h>
Packit 352660
#include <fcfreetype.h>
Packit 352660
@RET@           FcPattern *      
Packit 352660
@FUNC@          FcFreeTypeQuery 
Packit 352660
@TYPE1@         const FcChar8 *			@ARG1@          file      
Packit 352660
@TYPE2@         int%				@ARG2@          id      
Packit 352660
@TYPE3@         FcBlanks *			@ARG3@          blanks      
Packit 352660
@TYPE4@         int *				@ARG4@          count      
Packit 352660
@PURPOSE@	compute pattern from font file (and index)
Packit 352660
@DESC@
Packit 352660
Constructs a pattern representing the 'id'th face in 'file'.  The number
Packit 352660
of faces in 'file' is returned in 'count'.
Packit 352660
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
Packit 352660
accepted only for compatibility with older code.
Packit 352660
@@
Packit 352660
Packit 352660
unsigned int
Packit 352660
FcFreeTypeQueryAll(const FcChar8	*file,
Packit 352660
		   int			id,
Packit 352660
		   FcBlanks		*blanks,
Packit 352660
		   int			*count,
Packit 352660
		   FcFontSet            *set)
Packit 352660
@SYNOPSIS@
Packit 352660
#include <fontconfig.h>
Packit 352660
#include <fcfreetype.h>
Packit 352660
@RET@           unsigned int
Packit 352660
@FUNC@          FcFreeTypeQueryAll
Packit 352660
@TYPE1@         const FcChar8 *			@ARG1@          file
Packit 352660
@TYPE2@         int%				@ARG2@          id
Packit 352660
@TYPE3@         FcBlanks *			@ARG3@          blanks
Packit 352660
@TYPE4@         int *				@ARG4@          count
Packit 352660
@TYPE5@         FcFontSet *			@ARG5@          set
Packit 352660
@PURPOSE@	compute all patterns from font file (and index)
Packit 352660
@DESC@
Packit 352660
Constructs patterns found in 'file'.
Packit 352660
If id is -1, then all patterns found in 'file' are added to 'set'.
Packit 352660
Otherwise, this function works exactly like FcFreeTypeQuery().
Packit 352660
The number of faces in 'file' is returned in 'count'.
Packit 352660
The number of patterns added to 'set' is returned.
Packit 352660
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
Packit 352660
accepted only for compatibility with older code.
Packit 352660
@SINCE@		2.12.91
Packit 352660
@@
Packit 352660
Packit 352660
@SYNOPSIS@
Packit 352660
#include <fontconfig.h>
Packit 352660
#include <fcfreetype.h>
Packit 352660
@RET@           FcPattern *      
Packit 352660
@FUNC@          FcFreeTypeQueryFace
Packit 352660
@TYPE1@		const FT_Face%			@ARG1@		face
Packit 352660
@TYPE2@         const FcChar8 *			@ARG2@          file
Packit 352660
@TYPE3@         int%				@ARG3@          id
Packit 352660
@TYPE4@         FcBlanks *			@ARG4@          blanks
Packit 352660
@PURPOSE@	compute pattern from FT_Face
Packit 352660
@DESC@
Packit 352660
Constructs a pattern representing 'face'. 'file' and 'id' are used solely as
Packit 352660
data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY).
Packit 352660
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
Packit 352660
accepted only for compatibility with older code.
Packit 352660
@@