x31.html
Prev
4. FUNCTIONS
These are grouped by functionality, often using the main datatype being
manipulated.
4.1. Initialization
Table of Contents
r99.html
FcInitLoadConfig
-- load configuration
r120.html
FcInitLoadConfigAndFonts
-- load configuration and font data
r141.html
FcInit
-- initialize fontconfig library
r162.html
FcFini
-- finalize fonconfig library
r183.html
FcGetVersion
-- library version number
r204.html
FcInitReinitialize
-- re-initialize library
r225.html
FcInitBringUptoDate
-- reload configuration files if needed
These functions provide some control over how the library is initialized.
4.2. FcPattern
Table of Contents
r249.html
FcPatternCreate
-- Create a pattern
r270.html
FcPatternDestroy
-- Destroy a pattern
r291.html
FcPatternEqual
-- Compare patterns
r316.html
FcPatternEqualSubset
-- Compare portions of patterns
r344.html
FcPatternHash
-- Compute a pattern hash value
r365.html
FcPatternAdd
-- Add a value to a pattern
r393.html
FcPatternAddWeak
-- Add a value to a pattern with weak binding
r422.html
FcPatternAdd-Type
-- Add a typed value to a pattern
r497.html
FcPatternGet
-- Return a value from a pattern
r527.html
FcPatternGet-Type
-- Return a typed value from a pattern
r614.html
FcPatternBuild
-- Create patterns from arguments
r655.html
FcPatternDel
-- Delete a property from a pattern
r678.html
FcPatternRemove
-- Remove one object of the specified type from the pattern
r703.html
FcPatternPrint
-- Print a pattern for debugging
r724.html
FcDefaultSubstitute
-- Perform default substitutions in a pattern
r752.html
FcNameParse
-- Parse a pattern string
r774.html
FcNameUnparse
-- Convert a pattern back into a string that can be parsed
An FcPattern is an opaque type that holds both patterns to match against the
available fonts, as well as the information about each font.
4.3. FcFontSet
Table of Contents
r798.html
FcFontSetCreate
-- Create a font set
r819.html
FcFontSetDestroy
-- Destroy a font set
r840.html
FcFontSetAdd
-- Add to a font set
An FcFontSet simply holds a list of patterns; these are used to return the
results of listing available fonts.
4.4. FcObjectSet
Table of Contents
r866.html
FcObjectSetCreate
-- Create an object set
r887.html
FcObjectSetAdd
-- Add to an object set
r910.html
FcObjectSetDestroy
-- Destroy an object set
r931.html
FcObjectSetBuild
-- Build object set from args
An FcObjectSet holds a list of pattern property names; it is used to
indiciate which properties are to be returned in the patterns from
FcFontList.
4.5. FreeType specific functions
Table of Contents
r965.html
FcFreeTypeCharIndex
-- map Unicode to glyph id
r988.html
FcFreeTypeCharSet
-- compute unicode coverage
r1011.html
FcFreeTypeQuery
-- compute font file pattern
While the fontconfig library doesn't insist that FreeType be used as the
rasterization mechanism for fonts, it does provide some convenience
functions.
4.6. FcValue
Table of Contents
r1042.html
FcValueDestroy
-- Free a value
r1064.html
FcValueSave
-- Copy a value
FcValue is a structure containing a type tag and a union of all possible
datatypes.  The tag is an enum of type
FcType
and is intended to provide a measure of run-time
typechecking, although that depends on careful programming.
4.7. FcCharSet
Table of Contents
r1090.html
FcCharSetCreate
-- Create an empty character set
r1112.html
FcCharSetDestroy
-- Destroy a character set
r1135.html
FcCharSetAddChar
-- Add a character to a charset
r1159.html
FcCharSetCopy
-- Copy a charset
r1182.html
FcCharSetEqual
-- Compare two charsets
r1207.html
FcCharSetIntersect
-- Intersect charsets
r1232.html
FcCharSetUnion
-- Add charsets
r1257.html
FcCharSetSubtract
-- Subtract charsets
r1282.html
FcCharSetHasChar
-- Check a charset for a char
r1307.html
FcCharSetCount
-- Count entries in a charset
r1329.html
FcCharSetIntersectCount
-- Intersect and count charsets
r1354.html
FcCharSetSubtractCount
-- Subtract and count charsets
r1379.html
FcCharSetIsSubset
-- Test for charset inclusion
r1404.html
FcCharSetFirstPage
-- Start enumerating charset contents
r1431.html
FcCharSetNextPage
-- Continue enumerating charset contents
An FcCharSet is a boolean array indicating a set of unicode chars.  Those
associated with a font are marked constant and cannot be edited.
FcCharSets may be reference counted internally to reduce memory consumption;
this may be visible to applications as the result of FcCharSetCopy may
return it's argument, and that CharSet may remain unmodifiable.
4.8. FcMatrix
Table of Contents
r1462.html
FcMatrixInit
-- initialize an FcMatrix structure
r1485.html
FcMatrixCopy
-- Copy a matrix
r1508.html
FcMatrixEqual
-- Compare two matrices
r1534.html
FcMatrixMultiply
-- Multiply matrices
r1563.html
FcMatrixRotate
-- Rotate a matrix
r1593.html
FcMatrixScale
-- Scale a matrix
r1623.html
FcMatrixShear
-- Shear a matrix
FcMatrix structures hold an affine transformation in matrix form.
4.9. FcConfig
Table of Contents
r1656.html
FcConfigCreate
-- Create a configuration
r1677.html
FcConfigDestroy
-- Destroy a configuration
r1698.html
FcConfigSetCurrent
-- Set configuration as default
r1720.html
FcConfigGetCurrent
-- Return current configuration
r1741.html
FcConfigUptoDate
-- Check timestamps on config files
r1763.html
FcConfigBuildFonts
-- Build font database
r1784.html
FcConfigGetConfigDirs
-- Get config directories
r1806.html
FcConfigGetFontDirs
-- Get font directories
r1828.html
FcConfigGetConfigFiles
-- Get config files
r1850.html
FcConfigGetCache
-- Get cache filename
r1871.html
FcConfigGetFonts
-- Get config font set
r1895.html
FcConfigGetBlanks
-- Get config blanks
r1916.html
FcConfigGetRescanInverval
-- Get config rescan interval
r1938.html
FcConfigSetRescanInverval
-- Set config rescan interval
r1961.html
FcConfigAppFontAddFile
-- Add font file to font database
r1984.html
FcConfigAppFontAddDir
-- Add fonts from directory to font database
r2007.html
FcConfigAppFontClear
-- Remove all app fonts from font database
r2028.html
FcConfigSubstituteWithPat
-- Execute substitutions
r2057.html
FcConfigSubstitute
-- Execute substitutions
r2082.html
FcFontMatch
-- Return best font
r2110.html
FcFontSort
-- Return list of matching fonts
r2147.html
FcFontRenderPrepare
-- Prepare pattern for loading font file
r2178.html
FcFontList
-- List fonts
r2205.html
FcConfigFilename
-- Find a config file
r2229.html
FcConfigParseAndLoad
-- load a configuration file
An FcConfig object holds the internal representation of a configuration.
There is a default configuration which applications may use by passing 0 to
any function using the data within an FcConfig.
4.10. FcObjectType
Table of Contents
r2255.html
FcNameRegisterObjectTypes
-- Register object types
r2279.html
FcNameUnregisterObjectTypes
-- Unregister object types
r2303.html
FcNameGetObjectType
-- Lookup an object type
Provides for applcation-specified font name object types so that new
pattern elements can be generated from font names.
4.11. FcConstant
Table of Contents
r2328.html
FcNameRegisterConstants
-- Register symbolic constants
r2352.html
FcNameUnregisterConstants
-- Unregister symbolic constants
r2376.html
FcNameGetConstant
-- Lookup symbolic constant
r2398.html
FcNameConstant
-- Get the value for a symbolic constant
Provides for application-specified symbolic constants for font names.
4.12. FcBlanks
Table of Contents
r2426.html
FcBlanksCreate
-- Create an FcBlanks
r2447.html
FcBlanksDestroy
-- Destroy and FcBlanks
r2468.html
FcBlanksAdd
-- Add a character to an FcBlanks
r2491.html
FcBlanksIsMember
-- Query membership in an FcBlanks
An FcBlanks object holds a list of Unicode chars which are expected to
be blank when drawn.  When scanning new fonts, any glyphs which are
empty and not in this list will be assumed to be broken and not placed in
the FcCharSet associated with the font.  This provides a significantly more
accurate CharSet for applications.
4.13. FcAtomic
Table of Contents
r2517.html
FcAtomicCreate
-- create an FcAtomic object
r2539.html
FcAtomicLock
-- lock a file
r2561.html
FcAtomicNewFile
-- return new temporary file name
r2583.html
FcAtomicOrigFile
-- return original file name
r2605.html
FcAtomicReplaceOrig
-- replace original with new
r2627.html
FcAtomicDeleteNew
-- delete new file
r2648.html
FcAtomicUnlock
-- unlock a file
r2669.html
FcAtomicDestroy
-- destroy an FcAtomic object
These functions provide a safe way to update config files, allowing ongoing
reading of the old config file while locked for writing and ensuring that a
consistent and complete version of the config file is always available.
4.14. File and Directory routines
Table of Contents
r2694.html
FcFileScan
-- scan a font file
r2730.html
FcDirScan
-- scan a font directory
r2765.html
FcDirSave
-- save a directory cache
r2793.html
FcDirCacheValid
-- check directory cache timestamp
These routines work with font files and directories, including font
directory cache files.
4.15. FcStrSet and FcStrList
Table of Contents
r2818.html
FcStrSetCreate
-- create a string set
r2839.html
FcStrSetMember
-- check set for membership
r2864.html
FcStrSetAdd
-- add to a string set
r2889.html
FcStrSetAddFilename
-- add a filename to a string set
r2914.html
FcStrSetDel
-- delete from a string set
r2940.html
FcStrSetDestroy
-- destroy a string set
r2962.html
FcStrListCreate
-- create a string iterator
r2984.html
FcStrListNext
-- get next string in iteration
r3006.html
FcStrListDone
-- destroy a string iterator
A data structure for enumerating strings, used to list directories while
scanning the configuration as directories are added while scanning.
4.16. String utilities
Table of Contents
r3031.html
FcUtf8ToUcs4
-- convert UTF-8 to UCS4
r3060.html
FcUcs4ToUtf8
-- convert UCS4 to UTF-8
r3085.html
FcUtf8Len
-- count UTF-8 encoded chars
r3117.html
FcUtf16ToUcs4
-- convert UTF-16 to UCS4
r3150.html
FcUtf16Len
-- count UTF-16 encoded chars
r3186.html
FcStrCopy
-- duplicate a string
r3209.html
FcStrDowncase
-- create a lower case translation of a string
r3231.html
FcStrCopyFilename
-- copy a string, expanding '~'
r3254.html
FcStrCmpIgnoreCase
-- compare UTF-8 strings ignoring ASCII case
r3279.html
FcStrStr
-- locate UTF-8 substring
r3306.html
FcStrStrIgnoreCase
-- locate UTF-8 substring ignoring ASCII case
r3333.html
FcStrDirname
-- directory part of filename
r3355.html
FcStrBasename
-- last component of filename
Fontconfig manipulates many UTF-8 strings represented with the FcChar8 type.
These functions are exposed to help applications deal with these UTF-8
strings in a locale-insensitive manner.
x31.html
Prev
index.html
Home
Datatypes
