Documentation

An FcCharSet is a set of Unicode chars.

The toEnum method restricted to the type Char.

The fromEnum method restricted to the type Char.

An FontSet contains a list of Patterns. Internally fontconfig uses this data structure to hold sets of fonts. Externally, fontconfig returns the results of listing fonts in this format.

An ObjectSet holds a list of pattern property names; it is used to indicate which properties are to be returned in the patterns from FontList.

An Pattern` holds a set of names with associated value lists; each name refers to a property of a font. Patterns are used as inputs to the matching code as well as holding information about specific fonts. Each property can hold one or more values; conventionally all of the same type, although the interface doesn't demand that.

How important is it to match this property of the Pattern.

Matches a numeric range.

Matches an integral range.

Set of strings, as exposed by other FreeType APIs.

Output string lists from FontConfig.

A dynamic type system for Patterns.

StyleSheet wrapper to parse @font-face rules.

System configuration regarding available fonts.

Creates an empty configuration.

Sets the current default configuration to config. Implicitly calls configBuildFonts if necessary.

Returns the current default configuration.

Checks all of the files related to config and returns whether any of them has been modified since the configuration was created.

Return the current user's home directory, if it is available, and if using it is enabled, and NULL otherwise. (See also configEnableHome).

If enable is True, 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 False, then all use of the home directory in these contexts will be disabled. The previous setting of the value is returned.

Returns the list of font directories specified in the configuration files for config. Does not include any subdirectories.

Variant of configBuildFonts operating on the current configuration.

Returns the list of font directories specified in the configuration files for config. Does not include any subdirectories.

Variant of configGetConfigDirs which operates on the current configuration.

Returns the list of font directories in config. This includes the configured font directories along with any directories below those in the filesystem.

Variant of configGetFontDirs which operates on the current config.

Returns the list of known configuration files used to generate config.

Variant of configGetConfigFiles which operates upon current configuration.

Returns a string list containing all of the directories that fontconfig will search when attempting to load a cache file for a font directory.

Variant of configGetCacheDirs which operates upon current configuration.

Whether to operate upon system or application fontlists.

Returns 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. This function isn't MT-safe.

Variant of configGetFonts which operates upon current configuration.

Returns 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.

Variant of configGetRescanInterval which operates upon current configuration.

Clears the set of application-specific fonts.

Variant of configAppFontClear which operates upon current configuration.

Adds an application-specific font to the configuration.

Variant of configAppFontAddFile which operates upon current configuration.

Scans the specified directory for fonts, adding each one found to the application-specific set of fonts.

Variant of configAppFontAddDir which operates upon current configuration.

What purpose does the given pattern serve?

Performs the sequence of pattern modification operations, if kind is MatchPattern, then those tagged as pattern operations are applied, else if kind is MatchFont, those tagged as font operations are applied and p_pat is used for test elements with target=pattern.

Variant of configSubstituteWithPat which operates upon current configuration.

Selects fonts matching p, creates patterns from those fonts containing only the objects in os and returns the set of unique such patterns.

Variant of fontList which operates upon current configuration.

Calls FcConfigSubstituteWithPat without setting p_pat.

Variant configSubstitute which operates upon current configuration.

Finds the font in sets most closely matching pattern and returns the result of fontRenderPrepare for that font and the provided pattern. This function should be called only after configSubstitute and defaultSubstitute have been called for p; otherwise the results will not be correct.

Variant of fontMatch which operates upon current configuration.

Returns the list of fonts sorted by closeness to p. If trim is True, elements in the list which don't include Unicode coverage not provided by earlier elements in the list are elided. The union of Unicode coverage of all of the fonts is returned in snd. This function should be called only after configSubstitute and defaultSubstitute have been called for p; otherwise the results will not be correct.

Variant of fontSort which operates upon current configuration.

Creates 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 to configSubstituteWithPat with kind matchFont and then returned.

Variant of fontRenderPrepare which operates upon current configuration.

Walks the configuration in file and constructs the internal representation in config. Any include files referenced from within file will be loaded and parsed. If complain is False, no warning will be displayed if file does not exist. Error and warning messages will be output to stderr.

Obtains the system root directory in config if available. All files (including file properties in patterns) obtained from this config are relative to this system root directory. This function isn't MT-safe.

Variant of configGetSysRoot which operates upon current configuration.

Walks the configuration in memory and constructs the internal representation in config. Any includes files referenced from within memory will be loaded and dparsed. If complain is False, no warning will be displayed if file does not exist. Error and warning messages will be output to stderr.

Variant of configParseAndLoadFromMemory which operates upon current configuration.

Set sysroot as the system root directory. All file paths used or created with this config (including file properties in patterns) will be considered or made relative to this sysroot. This allows a host to generate caches for targets at build time. This also allows a cache to be re-targeted to a different base directory if configGetSysRoot is used to resolve file paths. When setting this on the current config this causes changing current config.

Variant of configSetSysRoot which operates upon current configuration.

Retrieves a list of all filepaths & descriptions for all fonts in this configuration alongside whether each is enabled. Not thread-safe.

Variant configGetFileInfo which operates upon current configuration.

Selects 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.

Variant of fontSetList operating upon register default Config.

Finds the font in sets most closely matching pattern and returns the result of fontRenderPrepare for that font and the provided pattern. This function should be called only after configSubstitute and defaultSubstitute have been called for pattern; otherwise the results will not be correct.

Variant of fontSetMatch operating upon registered default Config.

Returns the list of fonts from sets sorted by closeness to pattern. If trim is True, elements in the list which don't include Unicode coverage not provided by earlier elements in the list are elided. The union of Unicode coverage of all of the fonts is returned in csp. This function should be called only after configSubstitute and defaultSubstitute have been called for p; otherwise the results will not be correct. The returned FcFontSet references Pattern structures which may be shared by the return value from multiple fontSort calls, applications cannot modify these patterns. Instead, they should be passed, along with pattern to fontRenderPrepare which combines them into a complete pattern.

Variant of fontSetSort operating upon registered default Config.

Loads the default configuration file and returns the resulting configuration. Does not load any font information.

Loads the default configuration file and builds information about the available fonts. Returns the resulting configuration.

Initialize fontconfig library Loads the default configuration file and the fonts referenced therein and sets the default configuration to that result. Returns whether this process succeeded or not. If the default configuration has already been loaded, this routine does nothing and returns FcTrue.

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.

Forces the default configuration file to be reloaded and resets the default configuration. Returns False if the configuration cannot be reloaded (due to configuration file errors, allocation failures or other issues) and leaves the existing configuration unchanged. Otherwise returns True.

Checks the rescan interval in the default configuration, checking the configuration if the interval has passed and reloading the configuration if when any changes are detected. Returns False if the configuration cannot be reloaded (see FcInitReinitialize). Otherwise returns True.

Library version number Returns the version number of the library.

An LangSet is a set of language names (each of which include language and an optional territory). They are used when selecting fonts to indicate which languages the fonts need to support. Each font is marked, using language orthography information built into fontconfig, with the set of supported languages.

Returns a string set of the default languages according to the environment variables on the system. This function looks for them in order of FC_LANG, LC_ALL, LC_CTYPE and LANG then. If there are no valid values in those environment variables, "en" will be set as fallback.

Returns a string set of all known languages.

langSetCompare compares language coverage for ls_a and ls_b. If they share any language and territory pair, returns SameLang. If they share a language but differ in which territory that language is for, this function returns DifferentTerritory. If they share no languages in common, this function returns DifferentLang.

Returns a string to make lang suitable on FontConfig.

Returns the FcCharMap for a language.

Returns whether pa and pb have exactly the same values for all of the objects in os.

Restructures a Pattern so each key repeats at most once.

Returns a new pattern that only has those objects from p that are in os. If os is NULL, a duplicate of p is returned.

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 given one computed from any specified point size (default 12), dpi (default 75) and scale (default 1).

Converts name from the standard text format described above into a pattern.

Converts the given pattern into the standard text format described above.

Converts given pattern into text described fy given format specifier. See for details: https://www.freedesktop.org/software/fontconfig/fontconfig-devel/fcpatternformat.html

Replaces the values under the given "key" in given "pattern" with given "binding" & "value".

Replaces the values under the given "key" in given "pattern" with given "binding" & "value"s.

Deletes all entries in the given pattern under a given key.

Retrieves all values in the given pattern under a given key.

Retrieves all values under a given key & coerces to desired Maybe type.

Retrieves first value in the given pattern under a given key.