Section 3: library functions
FcConfigHome – return the current home directory. Synopsis#include <fontconfig/fontconfig.h> FcChar8 * FcConfigHome (void); DescriptionReturn the current user’s home directory, if it is available, and if using it is enabled, and NULL otherwise. See also FcConfigEnableHome).
FcConfigGetSysRoot – Obtain the system root directory Synopsis#include <fontconfig/fontconfig.h> const FcChar8 * FcConfigGetSysRoot (const FcConfig *config); DescriptionObtrains the system root directory in ‘config’ if available. Sinceversion 2.10.92
FcConfigGetRescanInterval – Get config rescan interval Synopsis#include <fontconfig/fontconfig.h> int FcConfigGetRescanInterval (FcConfig *config); DescriptionReturns the interval between automatic checks of the configuration (in seconds) specified in config. The configuration is checked during a call to FcFontList when this interval has passed since the last check. An interval setting of zero disables automatic checks. If config is…
FcConfigGetFonts – Get config font set Synopsis#include <fontconfig/fontconfig.h> FcFontSet * FcConfigGetFonts (FcConfig *config, FcSetName set); DescriptionReturns one of the two sets of fonts from the configuration as specified by set. This font set is owned by the library and must not be modified or freed. If config is NULL, the current configuration is used.
FcConfigGetFontDirs – Get font directories Synopsis#include <fontconfig/fontconfig.h> FcStrList * FcConfigGetFontDirs (FcConfig *config); DescriptionReturns the list of font directories in config. This includes the configured font directories along with any directories below those in the filesystem. If config is NULL, the current configuration is used.
FcConfigGetCurrent – Return current configuration Synopsis#include <fontconfig/fontconfig.h> FcConfig * FcConfigGetCurrent (void); DescriptionReturns the current default configuration.
FcConfigGetConfigFiles – Get config files Synopsis#include <fontconfig/fontconfig.h> FcStrList * FcConfigGetConfigFiles (FcConfig *config); DescriptionReturns the list of known configuration files used to generate config. If config is NULL, the current configuration is used.
FcConfigGetConfigDirs – Get config directories Synopsis#include <fontconfig/fontconfig.h> FcStrList * FcConfigGetConfigDirs (FcConfig *config); DescriptionReturns the list of font directories specified in the configuration files for config. Does not include any subdirectories. If config is NULL, the current configuration is used.
FcConfigGetCacheDirs – return the list of directories searched for cache files Synopsis#include <fontconfig/fontconfig.h> FcStrList * FcConfigGetCacheDirs (const FcConfig *config); DescriptionFcConfigGetCacheDirs returns a string list containing all of the directories that fontconfig will search when attempting to load a cache file for a font directory. If config is NULL, the current configuration is used.
FcConfigGetCache – DEPRECATED used to return per-user cache filename Synopsis#include <fontconfig/fontconfig.h> FcChar8 * FcConfigGetCache (FcConfig *config); DescriptionWith fontconfig no longer using per-user cache files, this function now simply returns NULL to indicate that no per-user file exists.
FcConfigGetBlanks – Get config blanks Synopsis#include <fontconfig/fontconfig.h> FcBlanks * FcConfigGetBlanks (FcConfig *config); DescriptionFcBlanks is deprecated. This function always returns NULL.
FcConfigFilename – Find a config file Synopsis#include <fontconfig/fontconfig.h> FcChar8 * FcConfigFilename (const FcChar8 *name); DescriptionGiven the specified external entity name, return the associated filename. This provides applications a way to convert various configuration file references into filename form. A null or empty name indicates that the default configuration file should be used; which file this…
FcConfigFileInfoIterNext – Set the iterator to point to the next list Synopsis#include <fontconfig/fontconfig.h> FcBool FcConfigFileInfoIterNext (FcConfig *config, FcConfigFileInfoIter *iter); DescriptionSet ‘iter’ to point to the next node in the config file information list. If there is no next node, FcFalse is returned. Sinceversion 2.12.91
FcConfigFileInfoIterInit – Initialize the iterator Synopsis#include <fontconfig/fontconfig.h> void FcConfigFileInfoIterInit (FcConfig *config, FcConfigFileInfoIter *iter); DescriptionInitialize ‘iter’ with the first iterator in the config file information list. Sinceversion 2.12.91
FcConfigFileInfoIterGet – Obtain the configuration file information Synopsis#include <fontconfig/fontconfig.h> FcBool FcConfigFileInfoIterGet (FcConfig *config, FcConfigFileInfoIter *iter, FcChar8 **name, FcChar8 **description, FcBool *enabled); DescriptionObtain the filename, the description and the flag whether it is enabled or not for ‘iter’ where points to current configuration file information. If the iterator is invalid, FcFalse is returned. Sinceversion 2.12.91
FcConfigEnableHome – controls use of the home directory. Synopsis#include <fontconfig/fontconfig.h> FcBool FcConfigEnableHome (FcBool enable); DescriptionIf enable is FcTrue, then Fontconfig will use various files which are specified relative to the user’s home directory (using the ~ notation in the configuration). When enable is FcFalse, then all use of the home directory in these contexts will…
FcConfigDestroy – Destroy a configuration Synopsis#include <fontconfig/fontconfig.h> void FcConfigDestroy (FcConfig *config); DescriptionDecrements the config reference count. If all references are gone, destroys the configuration and any data associated with it. Note that calling this function with the return from FcConfigGetCurrent will cause a new configuration to be created for use as current configuration.
FcConfigCreate – Create a configuration Synopsis#include <fontconfig/fontconfig.h> FcConfig * FcConfigCreate (void); DescriptionCreates an empty configuration.
FcConfigBuildFonts – Build font database Synopsis#include <fontconfig/fontconfig.h> FcBool FcConfigBuildFonts (FcConfig *config); DescriptionBuilds the set of available fonts for the given configuration. Note that any changes to the configuration after this call have indeterminate effects. Returns FcFalse if this operation runs out of memory. If config is NULL, the current configuration is used.
FcConfigAppFontClear – Remove all app fonts from font database Synopsis#include <fontconfig/fontconfig.h> void FcConfigAppFontClear (FcConfig *config); DescriptionClears the set of application-specific fonts. If config is NULL, the current configuration is used.