Section 3: library functions
FcFontMatch – Return best font Synopsis #include <fontconfig/fontconfig.h> FcPattern * FcFontMatch (FcConfig *config, FcPattern *p, FcResult *result); Description Finds 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;…
FcFontList – List fonts Synopsis #include <fontconfig/fontconfig.h> FcFontSet * FcFontList (FcConfig *config, FcPattern *p, FcObjectSet *os); Description Selects 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…
FcFini – finalize fontconfig library Synopsis #include <fontconfig/fontconfig.h> void FcFini (void); Description Frees 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); Description Scans 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…
FcFileIsDir – check whether a file is a directory Synopsis #include <fontconfig/fontconfig.h> FcBool FcFileIsDir (const FcChar8 *file); Description Returns FcTrue if file is a directory, otherwise returns FcFalse.
FcDirScan – scan a font directory without caching it Synopsis #include <fontconfig/fontconfig.h> FcBool FcDirScan (FcFontSet *set, FcStrSet *dirs, FcFileCache *cache, FcBlanks *blanks, const FcChar8 *dir, FcBool force); Description If cache is not zero or if force is FcFalse, this function currently returns FcFalse. Otherwise, it scans an entire directory and adds all fonts found to…
FcDirSave – DEPRECATED: formerly used to save a directory cache Synopsis #include <fontconfig/fontconfig.h> FcBool FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir); Description This function now does nothing aside from returning FcFalse. It used to creates the per-directory cache file for dir and populates it with the fonts in set and subdirectories in dirs. All…
FcDirCacheValid – check directory cache Synopsis #include <fontconfig/fontconfig.h> FcBool FcDirCacheValid (const FcChar8 *dir); Description Returns FcTrue if dir has an associated valid cache file, else returns FcFalse
FcDirCacheUnload – unload a cache file Synopsis #include <fontconfig/fontconfig.h> void FcDirCacheUnload (FcCache *cache); Description This function dereferences cache. When no other references to it remain, all memory associated with the cache will be freed.
FcDirCacheUnlink – Remove all caches related to dir Synopsis #include <fontconfig/fontconfig.h> FcBool FcDirCacheUnlink (const FcChar8 *dir, FcConfig *config); Description Scans the cache directories in config, removing any instances of the cache file for dir. Returns FcFalse when some internal error occurs (out of memory, etc). Errors actually unlinking any files are ignored.
FcDirCacheRescan – Re-scan a directory cache Synopsis #include <fontconfig/fontconfig.h> FcCache * FcDirCacheRescan (const FcChar8 *dir, FcConfig *config); Description Re-scan directories only at dir and update the cache. returns NULL if failed. Since version 2.11.1
FcDirCacheRead – read or construct a directory cache Synopsis #include <fontconfig/fontconfig.h> FcCache * FcDirCacheRead (const FcChar8 *dir, FcBool force, FcConfig *config); Description This returns a cache for dir. If force is FcFalse, then an existing, valid cache file will be used. Otherwise, a new cache will be created by scanning the directory and that returned.
FcDirCacheLoadFile – load a cache file Synopsis #include <fontconfig/fontconfig.h> FcCache * FcDirCacheLoadFile (const FcChar8 *cache_file, struct stat *file_stat); Description This function loads a directory cache from cache_file. If file_stat is non-NULL, it will be filled with the results of stat(2) on the cache file.
FcDirCacheLoad – load a directory cache Synopsis #include <fontconfig/fontconfig.h> FcCache * FcDirCacheLoad (const FcChar8 *dir, FcConfig *config, FcChar8 **cache_file); Description Loads the cache related to dir. If no cache file exists, returns NULL. The name of the cache file is returned in cache_file, unless that is NULL. See also FcDirCacheRead.
FcDirCacheDeleteUUID – Delete .uuid file Synopsis #include <fontconfig/fontconfig.h> FcBool FcDirCacheDeleteUUID (const FcChar8 *dir, FcConfig *config); Description This is to delete .uuid file containing an UUID at a font directory of dir. Since version 2.13.1
FcDirCacheCreateUUID – Create .uuid file at a directory Synopsis #include <fontconfig/fontconfig.h> FcBool FcDirCacheCreateUUID (FcChar8 *dir, FcBoolforce, FcConfig *config); Description This is to create .uuid file containing an UUID at a font directory of dir. The UUID will be used to identify the font directory and is used to determine the cache filename if available. Since…
FcDirCacheClean – Clean up a cache directory Synopsis #include <fontconfig/fontconfig.h> FcBool FcDirCacheClean (const FcChar8 *cache_dir, FcBoolverbose); Description This tries to clean up the cache directory of cache_dir. This returns FcTrue if the operation is successfully complete. otherwise FcFalse. Since version 2.9.91
FcDefaultSubstitute – Perform default substitutions in a pattern Synopsis #include <fontconfig/fontconfig.h> void FcDefaultSubstitute (FcPattern *pattern); Description Supplies default values for underspecified font patterns: • Patterns without a specified style or weight are set to Medium • Patterns without a specified style or slant are set to Roman • Patterns without a specified pixel size are…
FcConfigUptoDate – Check timestamps on config files Synopsis #include <fontconfig/fontconfig.h> FcBool FcConfigUptoDate (FcConfig *config); Description Checks all of the files related to config and returns whether any of them has been modified since the configuration was created. If config is NULL, the current configuration is used.
FcConfigSubstituteWithPat – Execute substitutions Synopsis #include <fontconfig/fontconfig.h> FcBool FcConfigSubstituteWithPat (FcConfig *config, FcPattern *p, FcPattern *p_pat, FcMatchKind kind); Description Performs the sequence of pattern modification operations, if kind is FcMatchPattern, then those tagged as pattern operations are applied, else if kind is FcMatchFont, those tagged as font operations are applied and p_pat is used for <test>…