Document that Match calls FcFontRenderPrepare (bug 13162).

The behaviour of FcFontMatch and FcFontSetMatch is hard to understand without
knowing that they call FcFontRenderPrepare.
This commit is contained in:
Keith Packard 2007-11-13 15:11:35 -08:00
parent fab44f3cb6
commit 3fb38716ae
2 changed files with 16 additions and 8 deletions

View File

@ -243,9 +243,13 @@ if the substitution cannot be performed (due to allocation failure). Otherwise r
@TYPE3@ FcResult * @ARG3@ result @TYPE3@ FcResult * @ARG3@ result
@PURPOSE@ Return best font @PURPOSE@ Return best font
@DESC@ @DESC@
Returns the font in <parameter>config</parameter> most close matching <parameter>p</parameter>. This function Finds the font in <parameter>sets</parameter> most closely matching
should be called only after FcConfigSubstitute and FcDefaultSubstitute have <parameter>pattern</parameter> and returns the result of
been called for <parameter>p</parameter>; otherwise the results will not be correct. <function>FcFontRenderPrepare</function> for that font and the provided
pattern. This function should be called only after
<function>FcConfigSubstitute</function> and
<function>FcDefaultSubstitute</function> have been called for
<parameter>p</parameter>; otherwise the results will not be correct.
@@ @@
@RET@ FcFontSet * @RET@ FcFontSet *
@ -267,7 +271,7 @@ been called for <parameter>p</parameter>; otherwise the results will not be corr
The returned FcFontSet references FcPattern structures which may be shared The returned FcFontSet references FcPattern structures which may be shared
by the return value from multiple FcFontSort calls, applications must not by the return value from multiple FcFontSort calls, applications must not
modify these patterns. Instead, they should be passed, along with <parameter>p</parameter> to modify these patterns. Instead, they should be passed, along with <parameter>p</parameter> to
FcFontRenderPrepare which combines them into a complete pattern. <function>FcFontRenderPrepare</function> which combines them into a complete pattern.
</para><para> </para><para>
The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy. The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
@@ @@

View File

@ -73,10 +73,14 @@ the set of unique such patterns.
@TYPE5@ FcResult * @ARG5@ result @TYPE5@ FcResult * @ARG5@ result
@PURPOSE@ Return the best font from a set of font sets @PURPOSE@ Return the best font from a set of font sets
@DESC@ @DESC@
Returns the font in <parameter>sets</parameter> most close matching Finds the font in <parameter>sets</parameter> most closely matching
<parameter>pattern</parameter>. This function should be called only after <parameter>pattern</parameter> and returns the result of
FcConfigSubstitute and FcDefaultSubstitute have been called for <function>FcFontRenderPrepare</function> for that font and the provided
pattern. This function should be called only after
<function>FcConfigSubstitute</function> and
<function>FcDefaultSubstitute</function> have been called for
<parameter>pattern</parameter>; otherwise the results will not be correct. <parameter>pattern</parameter>; otherwise the results will not be correct.
Returns NULL if an error occurs during this process.
@@ @@
@RET@ void @RET@ void
@ -116,7 +120,7 @@ The returned FcFontSet references FcPattern structures which may be shared
by the return value from multiple FcFontSort calls, applications cannot by the return value from multiple FcFontSort calls, applications cannot
modify these patterns. Instead, they should be passed, along with modify these patterns. Instead, they should be passed, along with
<parameter>pattern</parameter> to <parameter>pattern</parameter> to
FcFontRenderPrepare which combines them into a complete pattern. <function>FcFontRenderPrepare</function> which combines them into a complete pattern.
</para><para> </para><para>
The FcFontSet returned by FcFontSetSort is destroyed by caling FcFontSetDestroy. The FcFontSet returned by FcFontSetSort is destroyed by caling FcFontSetDestroy.
@@ @@