Section 3: library functions
FcFreeTypeQueryAll – compute all patterns from font file (and index) Synopsis#include <fontconfig.h> #include <fcfreetype.h> unsigned int FcFreeTypeQueryAll (const FcChar8 *file, int id, FcBlanks *blanks, int *count, FcFontSet *set); DescriptionConstructs 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…
FcFreeTypeQuery – compute pattern from font file (and index) Synopsis#include <fontconfig.h> #include <fcfreetype.h> FcPattern * FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count); DescriptionConstructs a pattern representing the ‘id’th face in ‘file’. The number of faces in ‘file’ is returned in ‘count’. FcBlanks is deprecated, blanks is ignored and accepted only for compatibility…
FcFreeTypeCharSetAndSpacing – compute Unicode coverage and spacing type Synopsis#include <fontconfig.h> #include <fcfreetype.h> FcCharSet * FcFreeTypeCharSetAndSpacing (FT_Face face, FcBlanks *blanks, int *spacing); DescriptionScans a FreeType face and returns the set of encoded Unicode chars. FcBlanks is deprecated, blanks is ignored and accepted only for compatibility with older code. spacing receives the computed spacing type of the…
FcFreeTypeCharSet – compute Unicode coverage Synopsis#include <fontconfig.h> #include <fcfreetype.h> FcCharSet * FcFreeTypeCharSet (FT_Face face, FcBlanks *blanks); DescriptionScans a FreeType face and returns the set of encoded Unicode chars. FcBlanks is deprecated, blanks is ignored and accepted only for compatibility with older code.
FcFreeTypeCharIndex – map Unicode to glyph id Synopsis#include <fontconfig.h> #include <fcfreetype.h> FT_UInt FcFreeTypeCharIndex (FT_Face face, FcChar32 ucs4); DescriptionMaps 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…
FcFontSort – Return list of matching fonts Synopsis#include <fontconfig/fontconfig.h> FcFontSet * FcFontSort (FcConfig *config, FcPattern *p, FcBool trim, FcCharSet **csp, FcResult *result); DescriptionReturns the list of fonts sorted by closeness to p. If trim is FcTrue, elements in the list which don’t include Unicode coverage not provided by earlier elements in the list are elided….
FcFontSetSortDestroy – DEPRECATED destroy a font set Synopsis#include <fontconfig/fontconfig.h> FcFontSetSortDestroy (FcFontSet *set); DescriptionThis function is DEPRECATED. FcFontSetSortDestroy destroys set by calling FcFontSetDestroy. Applications should use FcFontSetDestroy directly instead.
FcFontSetSort – Add to a font set Synopsis#include <fontconfig/fontconfig.h> FcFontSetSort (FcConfig *config, FcFontSet **sets, intnsets, FcPattern *pattern, FcBool trim, FcCharSet **csp, FcResult *result); DescriptionReturns the list of fonts from sets sorted by closeness to pattern. If trim is FcTrue, elements in the list which don’t include Unicode coverage not provided by earlier elements in the…
FcFontSetPrint – Print a set of patterns to stdout Synopsis#include <fontconfig/fontconfig.h> void FcFontSetPrint (FcFontSet *set); DescriptionThis function is useful for diagnosing font related issues, printing the complete contents of every pattern in set. The format of the output is designed to be of help to users and developers, and may change at any time.
FcFontSetMatch – Return the best font from a set of font sets Synopsis#include <fontconfig/fontconfig.h> FcPattern * FcFontSetMatch (FcConfig *config, FcFontSet **sets, intnsets, FcPattern *pattern, FcResult *result); DescriptionFinds the font in sets most closely matching pattern and returns the result of FcFontRenderPrepare for that font and the provided pattern. This function should be called only after…
FcFontSetList – List fonts from a set of font sets Synopsis#include <fontconfig/fontconfig.h> FcFontSet * FcFontSetList (FcConfig *config, FcFontSet **sets, intnsets, FcPattern *pattern, FcObjectSet *object_set); DescriptionSelects fonts matching pattern from sets, creates patterns from those fonts containing only the objects in object_set and returns the set of unique such patterns. If config is NULL, the default…
FcFontSetDestroy – Destroy a font set Synopsis#include <fontconfig/fontconfig.h> void FcFontSetDestroy (FcFontSet *s); DescriptionDestroys a font set. Note that this destroys any referenced patterns as well.
FcFontSetCreate – Create a font set Synopsis#include <fontconfig/fontconfig.h> FcFontSet * FcFontSetCreate (void); DescriptionCreates an empty font set.
FcFontSetAdd – Add to a font set Synopsis#include <fontconfig/fontconfig.h> FcBool FcFontSetAdd (FcFontSet *s, FcPattern *font); DescriptionAdds a pattern to a font set. Note that the pattern is not copied before being inserted into the set. Returns FcFalse if the pattern cannot be inserted into the set (due to allocation failure). Otherwise returns FcTrue.
FcFontRenderPrepare – Prepare pattern for loading font file Synopsis#include <fontconfig/fontconfig.h> FcPattern * FcFontRenderPrepare (FcConfig *config, FcPattern *pat, FcPattern *font); DescriptionCreates a new pattern consisting of elements of font not appearing in pat, elements of pat not appearing in font and the best matching value from pat for elements appearing in both. The result is passed…
FcFontMatch – Return best font Synopsis#include <fontconfig/fontconfig.h> FcPattern * FcFontMatch (FcConfig *config, FcPattern *p, FcResult *result); DescriptionFinds the font in sets most closely matching pattern and returns the result of FcFontRenderPrepare for that font and the provided pattern. This function should be called only after FcConfigSubstitute and FcDefaultSubstitute have been called for p; otherwise the…
FcFontList – List fonts Synopsis#include <fontconfig/fontconfig.h> FcFontSet * FcFontList (FcConfig *config, FcPattern *p, FcObjectSet *os); DescriptionSelects fonts matching p, creates patterns from those fonts containing only the objects in os and returns the set of unique such patterns. If config is NULL, the default configuration is checked to be up to date, and used.
FcFini – finalize fontconfig library Synopsis#include <fontconfig/fontconfig.h> void FcFini (void); DescriptionFrees all data structures allocated by previous calls to fontconfig functions. Fontconfig returns to an uninitialized state, requiring a new call to one of the FcInit functions before any other fontconfig function may be called.
FcFileScan – scan a font file Synopsis#include <fontconfig/fontconfig.h> FcBool FcFileScan (FcFontSet *set, FcStrSet *dirs, FcFileCache *cache, FcBlanks *blanks, const FcChar8 *file, FcBool force); DescriptionScans a single file and adds all fonts found to set. If force is FcTrue, then the file is scanned even if associated information is found in cache. If file is a…
FcFileIsDir – check whether a file is a directory Synopsis#include <fontconfig/fontconfig.h> FcBool FcFileIsDir (const FcChar8 *file); DescriptionReturns FcTrue if file is a directory, otherwise returns FcFalse.