Package fontconfig-devel

Font configuration and customization library

http://fontconfig.org

The fontconfig-devel package includes the header files,
and developer docs for the fontconfig package.

Install fontconfig-devel if you want to develop programs which
will use fontconfig.

Library Functions (Section 3)
FcAtomicCreate
Creates a data structure containing data needed to control access to file. Writing is done to a separate file. Once that file is complete, the original...
FcAtomicDeleteNew
Deletes the new file. Used in error recovery to back out changes.
FcAtomicDestroy
destroy an FcAtomic object
FcAtomicLock
Attempts to lock the file referenced by atomic. Returns FcFalse if the file is already locked, else returns FcTrue and leaves the file locked.
FcAtomicNewFile
Returns the filename for writing a new version of the file referenced by atomic.
FcAtomicOrigFile
Returns the file referenced by atomic.
FcAtomicReplaceOrig
Replaces the original file referenced by atomic with the new file. Returns FcFalse if the file cannot be replaced due to permission issues in the filesystem...
FcAtomicUnlock
unlock a file
FcBlanksAdd
Adds a single character to an FcBlanks object, returning FcFalse if this process ran out of memory.
FcBlanksCreate
Creates an empty FcBlanks object.
FcBlanksDestroy
Destroys an FcBlanks object, freeing any associated memory.
FcBlanksIsMember
Returns whether the specified FcBlanks object contains the indicated Unicode value.
FcCacheCopySet
The returned fontset contains each of the font patterns from cache. This fontset may be modified, but the patterns from the cache are read-only.
FcCacheCreateTagFile
This tries to create CACHEDIR.TAG file at the cache directory registered to config.
FcCacheDir
This function returns the directory from which the cache was constructed.
FcCacheNumFont
This returns the number of fonts which would be included in the return from FcCacheCopySet.
FcCacheNumSubdir
This returns the total number of subdirectories in the cache.
FcCacheSubdir
The set of subdirectories stored in a cache file are indexed by this function, i should range from 0 to n-1, where n is the return value from FcCacheNumSubdir.
FcCharSetAddChar
FcCharSetAddChar adds a single Unicode char to the set, returning FcFalse on failure, either as a result of a constant set or from running out of memory.
FcCharSetCopy
Makes a copy of src; note that this may not actually do anything more than increment the reference count on src.
FcCharSetCount
Returns the total number of Unicode chars in a.
FcCharSetCoverage
DEPRECATED This function returns a bitmask in result which indicates which code points in page are included in a. FcCharSetCoverage returns the next page in the...
FcCharSetCreate
FcCharSetCreate allocates and initializes a new empty character set object.
FcCharSetDelChar
FcCharSetDelChar deletes a single Unicode char from the set, returning FcFalse on failure, either as a result of a constant set or from running out of memory.
FcCharSetDestroy
FcCharSetDestroy decrements the reference count fcs. If the reference count becomes zero, all memory referenced is freed.
FcCharSetEqual
Returns whether a and b contain the same set of Unicode chars.
FcCharSetFirstPage
Builds an array of bits in map marking the first page of Unicode coverage of a. *next is set to contains the base code point for the next page in a. Returns the...
FcCharSetHasChar
Returns whether fcs contains the char ucs4.
FcCharSetIntersect
Returns a set including only those chars found in both a and b.
FcCharSetIntersectCount
Returns the number of chars that are in both a and b.
FcCharSetIsSubset
Returns whether a is a subset of b.
FcCharSetMerge
Adds all chars in b to a. In other words, this is an in-place version of FcCharSetUnion. If changed is not NULL, then it returns whether any new chars from b...
FcCharSetNew
FcCharSetNew is a DEPRECATED alias for FcCharSetCreate.
FcCharSetNextPage
Builds an array of bits in map marking the Unicode coverage of a for page containing *next (see the FcCharSetFirstPage description for details). *next is set to...
FcCharSetSubtract
Returns a set including only those chars found in a but not b.
FcCharSetSubtractCount
Returns the number of chars that are in a but not in b.
FcCharSetUnion
Returns a set including only those chars found in either a or b.
FcConfigAppFontAddDir
Scans the specified directory for fonts, adding each one found to the application-specific set of fonts. Returns FcFalse if the fonts cannot be added (due to...
FcConfigAppFontAddFile
Adds an application-specific font to the configuration. Returns FcFalse if the fonts cannot be added (due to allocation failure or no fonts found). Otherwise...
FcConfigAppFontClear
Clears the set of application-specific fonts. If config is NULL, the current configuration is used.
FcConfigBuildFonts
Builds the set of available fonts for the given configuration. Note that any changes to the configuration after this call have indeterminate effects. Returns...
FcConfigCreate
Creates an empty configuration.
FcConfigDestroy
Decrements the config reference count. If all references are gone, destroys the configuration and any data associated with it. Note that calling this function...
FcConfigEnableHome
If enable is FcTrue, then Fontconfig will use various files which are specified relative to the user's home directory (using the ~ notation in the...
FcConfigFilename
Given the specified external entity name, return the associated filename. This provides applications a way to convert various configuration file references into...
FcConfigGetBlanks
Returns the FcBlanks object associated with the given configuration, if no blanks were present in the configuration, this function will return 0. The returned...
FcConfigGetCache
With fontconfig no longer using per-user cache files, this function now simply returns NULL to indicate that no per-user file exists.
FcConfigGetCacheDirs
FcConfigGetCacheDirs returns a string list containing all of the directories that fontconfig will search when attempting to load a cache file for a font...
FcConfigGetConfigDirs
Returns the list of font directories specified in the configuration files for config. Does not include any subdirectories. If config is NULL, the current...
FcConfigGetConfigFiles
Returns the list of known configuration files used to generate config. If config is NULL, the current configuration is used.
FcConfigGetCurrent
Returns the current default configuration.
FcConfigGetFontDirs
Returns the list of font directories in config. This includes the configured font directories along with any directories below those in the filesystem. If...
FcConfigGetFonts
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...
FcConfigGetRescanInterval
Returns the interval between automatic checks of the configuration (in seconds) specified in config. The configuration is checked during a call to FcFontList...
FcConfigGetSysRoot
Obtrains the system root directory in 'config' if available.
FcConfigHome
Return the current user's home directory, if it is available, and if using it is enabled, and NULL otherwise. See also FcConfigEnableHome).
FcConfigParseAndLoad
Walks the configuration in 'file' and constructs the internal representation in 'config'. Any include files referenced from within 'file' will be loaded and...
FcConfigReference
Add another reference to config. Configs are freed only when the reference count reaches zero. If config is NULL, the current configuration is used. In that...
FcConfigSetCurrent
Sets the current default configuration to config. Implicitly calls FcConfigBuildFonts if necessary, and FcConfigReference() to inrease the reference count in...
FcConfigSetRescanInterval
Sets the rescan interval. Returns FcFalse if the interval cannot be set (due to allocation failure). Otherwise returns FcTrue. An interval setting of zero...
FcConfigSetSysRoot
Set 'sysroot' as the system root directory. fontconfig prepend 'sysroot' to the cache directories in order to allow people to generate caches at the build time...
FcConfigSubstitute
Calls FcConfigSubstituteWithPat setting p_pat to NULL. Returns FcFalse if the substitution cannot be performed (due to allocation failure). Otherwise returns...
FcConfigSubstituteWithPat
Performs the sequence of pattern modification operations, if kind is FcMatchPattern, then those tagged as pattern operations are applied, else if kind is...
FcConfigUptoDate
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...
FcDefaultSubstitute
Perform default substitutions in a pattern
FcDirCacheClean
This tries to clean up the cache directory of cache_dir.This returns FcTrue if the operation is successfully complete. otherwise FcFalse.
FcDirCacheLoad
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...
FcDirCacheLoadFile
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.
FcDirCacheRead
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...
FcDirCacheRescan
Re-scan directories only at dir and update the cache. returns NULL if failed.
FcDirCacheUnlink
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)...
FcDirCacheUnload
This function dereferences cache. When no other references to it remain, all memory associated with the cache will be freed.
FcDirCacheValid
Returns FcTrue if dir has an associated valid cache file, else returns FcFalse
FcDirSave
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...
FcDirScan
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 set...
FcFileIsDir
Returns FcTrue if file is a directory, otherwise returns FcFalse.
FcFileScan
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 is a...
FcFini
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...
FcFontList
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...
FcFontMatch
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...
FcFontRenderPrepare
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...
FcFontSetAdd
Adds 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...
FcFontSetCreate
Creates an empty font set.
FcFontSetDestroy
Destroys a font set. Note that this destroys any referenced patterns as well.
FcFontSetList
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...
FcFontSetMatch
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...
FcFontSetPrint
This 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...
FcFontSetSort
Returns 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...
FcFontSetSortDestroy
This function is DEPRECATED. FcFontSetSortDestroy destroys set by calling FcFontSetDestroy. Applications should use FcFontSetDestroy directly instead.
FcFontSort
Returns 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...
FcFreeTypeCharIndex
Maps 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...
FcFreeTypeCharSet
Scans a FreeType face and returns the set of encoded Unicode chars. This scans several encoding tables to build as complete a list as possible. If 'blanks' is...
FcFreeTypeCharSetAndSpacing
Scans a FreeType face and returns the set of encoded Unicode chars. This scans several encoding tables to build as complete a list as possible. If 'blanks' is...
FcFreeTypeQuery
Constructs a pattern representing the 'id'th font in 'file'. The number of fonts in 'file' is returned in 'count'.
FcFreeTypeQueryFace
Constructs a pattern representing 'face'. 'file' and 'id' are used solely as data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY).
FcGetDefaultLangs
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...
FcGetLangs
Returns a string set of all known languages.
FcGetVersion
Returns the version number of the library.
FcInit
Loads the default configuration file and the fonts referenced therein and sets the default configuration to that result. Returns whether this process succeeded...
FcInitBringUptoDate
Checks the rescan interval in the default configuration, checking the configuration if the interval has passed and reloading the configuration if when any...
FcInitLoadConfig
Loads the default configuration file and returns the resulting configuration. Does not load any font information.
FcInitLoadConfigAndFonts
Loads the default configuration file and builds information about the available fonts. Returns the resulting configuration.
FcInitReinitialize
Forces the default configuration file to be reloaded and resets the default configuration. Returns FcFalse if the configuration cannot be reloaded (due to...
FcIsLower
This macro checks whether c is an lower case ASCII letter.
FcIsUpper
This macro checks whether c is a upper case ASCII letter.
FcLangGetCharSet
Returns the FcCharMap for a language.
FcLangNormalize
Returns a string to make lang suitable on fontconfig.
FcLangSetAdd
lang is added to ls. lang should be of the form Ll-Tt where Ll is a two or three letter language from ISO 639 and Tt is a territory from ISO 3166.
FcLangSetCompare
FcLangSetCompare compares language coverage for ls_a and ls_b. If they share any language and territory pair, this function returns FcLangEqual. If they share a...
FcLangSetContains
FcLangSetContains returns FcTrue if ls_a contains every language in ls_b. ls_a will 'contain' a language from ls_b if ls_a has exactly the language, or either...
FcLangSetCopy
FcLangSetCopy creates a new FcLangSet object and populates it with the contents of ls.
FcLangSetCreate
FcLangSetCreate creates a new FcLangSet object.
FcLangSetDel
lang is removed from ls. lang should be of the form Ll-Tt where Ll is a two or three letter language from ISO 639 and Tt is a territory from ISO 3166.
FcLangSetDestroy
FcLangSetDestroy destroys a FcLangSet object, freeing all memory associated with it.
FcLangSetEqual
Returns FcTrue if and only if ls_a supports precisely the same language and territory combinations as ls_b.
FcLangSetGetLangs
Returns a string set of all languages in langset.
FcLangSetHash
This function returns a value which depends solely on the languages supported by ls. Any language which equals ls will have the same result from FcLangSetHash...
FcLangSetHasLang
FcLangSetHasLang checks whether ls supports lang. If ls has a matching language and territory pair, this function returns FcLangEqual. If ls has a matching...
FcLangSetSubtract
Returns a set including only those languages found in ls_a but not in ls_b.
FcLangSetUnion
Returns a set including only those languages found in either ls_a or ls_b.
FcMatrixCopy
FcMatrixCopy allocates a new FcMatrix and copies mat into it.
FcMatrixEqual
FcMatrixEqual compares matrix1 and matrix2 returning FcTrue when they are equal and FcFalse when they are not.
FcMatrixInit
FcMatrixInit initializes matrix to the identity matrix.
FcMatrixMultiply
FcMatrixMultiply multiplies matrix1 and matrix2 storing the result in result.
FcMatrixRotate
FcMatrixRotate rotates matrix by the angle who's sine is sin and cosine is cos.
FcMatrixScale
FcMatrixScale multiplies matrix x values by sx and y values by dy.
FcMatrixShear
FcMatrixShare shears matrix horizontally by sh and vertically by sv.
FcNameConstant
Returns whether a symbolic constant with name string is registered, placing the value of the constant in result if present.
FcNameGetConstant
Return the FcConstant structure related to symbolic constant string.
FcNameGetObjectType
Return the object type for the pattern element named object.
FcNameParse
Converts name from the standard text format described above into a pattern.
FcNameRegisterConstants
Deprecated. Does nothing. Returns FcFalse.
FcNameRegisterObjectTypes
Deprecated. Does nothing. Returns FcFalse.
FcNameUnparse
Converts the given pattern into the standard text format described above. The return value is not static, but instead refers to newly allocated memory which...
FcNameUnregisterConstants
Deprecated. Does nothing. Returns FcFalse.
FcNameUnregisterObjectTypes
Deprecated. Does nothing. Returns FcFalse.
FcObjectSetAdd
Adds a property name to the set. Returns FcFalse if the property name cannot be inserted into the set (due to allocation failure). Otherwise returns FcTrue.
FcObjectSetBuild
These build an object set from a null-terminated list of property names. FcObjectSetVapBuild is a macro version of FcObjectSetVaBuild which returns the result...
FcObjectSetCreate
Create an object set
FcObjectSetDestroy
Destroy an object set
FcPatternAdd
Adds a single value to the list of values associated with the property named `object. If `append is FcTrue, the value is added at the end of any existing list...
FcPatternAdd-Type
These are all convenience functions that insert objects of the specified type into the pattern. Use these in preference to FcPatternAdd as they will provide...
FcPatternAddWeak
FcPatternAddWeak is essentially the same as FcPatternAdd except that any values added to the list have binding weak instead of strong.
FcPatternBuild
Builds a pattern using a list of objects, types and values.
FcPatternCreate
Creates a pattern with no properties; used to build patterns from scratch.
FcPatternDel
Deletes all values associated with the property `object', returning whether the property existed or not.
FcPatternDestroy
Decrement the pattern reference count. If all references are gone, destroys the pattern, in the process destroying all related values.
FcPatternDuplicate
Copy a pattern, returning a new pattern that matches p. Each pattern may be modified without affecting the other.
FcPatternEqual
Returns whether pa and pb are exactly alike.
FcPatternEqualSubset
Returns whether pa and pb have exactly the same values for all of the objects in os.
FcPatternFilter
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.
FcPatternFormat
Converts given pattern pat into text described by the format specifier format. The return value refers to newly allocated memory which should be freed by the...
FcPatternGet
Returns in v the id'th value associated with the property object. The value returned is not a copy, but rather refers to the data stored within the pattern...
FcPatternGet-Type
These are convenience functions that call FcPatternGet and verify that the returned data is of the expected type. They return FcResultTypeMismatch if this is...
FcPatternHash
Returns a 32-bit number which is the same for any two patterns which are equal.
FcPatternPrint
Prints an easily readable version of the pattern to stdout. There is no provision for reparsing data in this format, it's just for diagnostics and debugging.
FcPatternReference
Add another reference to p. Patterns are freed only when the reference count reaches zero.
FcPatternRemove
Removes the value associated with the property `object' at position `id', returning whether the property existed and had a value at that position or not.
FcRangeCopy
FcRangeCopy creates a new FcRange object and populates it with the contents of range.
FcRangeCreateDouble
FcRangeCreateDouble creates a new FcRange object with double sized value.
FcRangeCreateInteger
FcRangeCreateInteger creates a new FcRange object with integer sized value.
FcRangeDestroy
FcRangeDestroy destroys a FcRange object, freeing all memory associated with it.
FcRangeGetDouble
Returns in begin and end as the range.
FcStrBasename
Returns the filename of file stripped of any leading directory names. This is returned in newly allocated storage which should be freed when no longer needed.
FcStrCmp
Returns the usual <0, 0, >0 result of comparing s1 and s2.
FcStrCmpIgnoreCase
Returns the usual <0, 0, >0 result of comparing s1 and s2. This test is case-insensitive for all proper UTF-8 encoded strings.
FcStrCopy
Allocates memory, copies s and returns the resulting buffer. Yes, this is strdup, but that function isn't available on every platform.
FcStrCopyFilename
FcStrCopyFilename constructs an absolute pathname from s. It converts any leading '~' characters in to the value of the HOME environment variable, and any...
FcStrDirname
Returns the directory containing file. This is returned in newly allocated storage which should be freed when no longer needed.
FcStrDowncase
Allocates memory, copies s, converting upper case letters to lower case and returns the allocated buffer.
FcStrFree
This is just a wrapper around free(3) which helps track memory usage of strings within the fontconfig library.
FcStrListCreate
Creates an iterator to list the strings in set.
FcStrListDone
Destroys the enumerator list.
FcStrListFirst
Returns the first string in list.
FcStrListNext
Returns the next string in list.
FcStrPlus
This function allocates new storage and places the concatenation of s1 and s2 there, returning the new string.
FcStrSetAdd
add to a string set
FcStrSetAddFilename
Adds a copy s to set, The copy is created with FcStrCopyFilename so that leading '~' values are replaced with the value of the HOME environment variable.
FcStrSetCreate
create a string set
FcStrSetDel
Removes s from set, returning FcTrue if s was a member else FcFalse.
FcStrSetDestroy
destroy a string set
FcStrSetEqual
Returns whether set_a contains precisely the same strings as set_b. Ordering of strings within the two sets is not considered.
FcStrSetMember
Returns whether s is a member of set.
FcStrStr
Returns the location of s2 in s1. Returns NULL if s2 is not present in s1. This test will operate properly with UTF8 encoded strings.
FcStrStrIgnoreCase
Returns the location of s2 in s1, ignoring case. Returns NULL if s2 is not present in s1. This test is case-insensitive for all proper UTF-8 encoded strings.
FcToLower
This macro converts upper case ASCII c to the equivalent lower case letter.
FcUcs4ToUtf8
Converts the Unicode char from src into dst and returns the number of bytes needed to encode the char.
FcUtf16Len
Counts the number of Unicode chars in len bytes of src. Bytes of src are combined into 16-bit units according to endian. Places that count in nchar. wchar...
FcUtf16ToUcs4
Converts the next Unicode char from src into dst and returns the number of bytes containing the char. src must be at least len bytes long. Bytes of src are...
FcUtf8Len
Counts the number of Unicode chars in len bytes of src. Places that count in nchar. wchar contains 1, 2 or 4 depending on the number of bytes needed to hold the...
FcUtf8ToUcs4
Converts the next Unicode char from src into dst and returns the number of bytes containing the char. src must be at least len bytes long.
FcValueDestroy
Frees any memory referenced by v. Values of type FcTypeString, FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
FcValueEqual
Compares two values. Integers and Doubles are compared as numbers; otherwise the two values have to be the same type to be considered equal. Strings are...
FcValuePrint
Prints a human-readable representation of v to stdout. The format should not be considered part of the library specification as it may change in the future.
FcValueSave
Returns a copy of v duplicating any object referenced by it so that v may be safely destroyed without harming the new value.
FcWeightFromOpenType
FcWeightFromOpenType returns an integer value to use with FC_WEIGHT, from an integer in the 1..1000 range, resembling the numbers from OpenType specification's...
FcWeightToOpenType
FcWeightToOpenType is the inverse of FcWeightFromOpenType. If the input is less than FC_WEIGHT_THIN or greater than FC_WEIGHT_EXTRABLACK, returns -1. Otherwise...