Imported Upstream version 2.13.0

[platform/upstream/fontconfig.git] / doc / fcfreetype.fncs

diff --git a/doc/fcfreetype.fncs b/doc/fcfreetype.fncs
index e4cca46..af63e83 100644 (file)
--- a/doc/fcfreetype.fncs
+++ b/doc/fcfreetype.fncs
@@ -47,10 +47,9 @@ higher level functions.
 @TYPE2@         FcBlanks *                     @ARG2@          blanks
 @PURPOSE@      compute Unicode coverage
 @DESC@
-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 not 0, the glyphs in the font are examined and any blank glyphs
-not in 'blanks' are not placed in the returned FcCharSet.
+Scans a FreeType face and returns the set of encoded Unicode chars.
+FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
+accepted only for compatibility with older code.
 @@
 
 @SYNOPSIS@
@@ -64,10 +63,8 @@ not in 'blanks' are not placed in the returned FcCharSet.
 @PURPOSE@      compute Unicode coverage and spacing type
 @DESC@
 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 not 0, the glyphs in the font are examined and any blank glyphs
-not in 'blanks' are not placed in the returned FcCharSet.
+FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
+accepted only for compatibility with older code.
 <parameter>spacing</parameter> receives the computed spacing type of the
 font, one of FC_MONO for a font where all glyphs have the same width,
 FC_DUAL, where the font has glyphs in precisely two widths, one twice as
@@ -86,8 +83,38 @@ widths.
 @TYPE4@         int *                          @ARG4@          count      
 @PURPOSE@      compute pattern from font file (and index)
 @DESC@
-Constructs a pattern representing the 'id'th font in 'file'.  The number
-of fonts in 'file' is returned in 'count'.
+Constructs a pattern representing the 'id'th face in 'file'.  The number
+of faces in 'file' is returned in 'count'.
+FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
+accepted only for compatibility with older code.
+@@
+
+unsigned int
+FcFreeTypeQueryAll(const FcChar8       *file,
+                  int                  id,
+                  FcBlanks             *blanks,
+                  int                  *count,
+                  FcFontSet            *set)
+@SYNOPSIS@
+#include &lt;fontconfig.h&gt;
+#include &lt;fcfreetype.h&gt;
+@RET@           unsigned int
+@FUNC@          FcFreeTypeQueryAll
+@TYPE1@         const FcChar8 *                        @ARG1@          file
+@TYPE2@         int%                           @ARG2@          id
+@TYPE3@         FcBlanks *                     @ARG3@          blanks
+@TYPE4@         int *                          @ARG4@          count
+@TYPE5@         FcFontSet *                    @ARG5@          set
+@PURPOSE@      compute all patterns from font file (and index)
+@DESC@
+Constructs patterns found in 'file'.
+If id is -1, then all patterns found in 'file' are added to 'set'.
+Otherwise, this function works exactly like FcFreeTypeQuery().
+The number of faces in 'file' is returned in 'count'.
+The number of patterns added to 'set' is returned.
+FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
+accepted only for compatibility with older code.
+@SINCE@                2.12.91
 @@
 
 @SYNOPSIS@
@@ -103,4 +130,6 @@ of fonts in 'file' is returned in 'count'.
 @DESC@
 Constructs a pattern representing 'face'. 'file' and 'id' are used solely as
 data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY).
+FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
+accepted only for compatibility with older code.
 @@