Blame doc/FcFontSort.3

Packit 352660
.\" auto-generated by docbook2man-spec from docbook-utils package
Packit 352660
.TH "FcFontSort" "3" "30 8月 2018" "Fontconfig 2.13.1" ""
Packit 352660
.SH NAME
Packit 352660
FcFontSort \- Return list of matching fonts
Packit 352660
.SH SYNOPSIS
Packit 352660
.nf
Packit 352660
\fB#include <fontconfig/fontconfig.h>
Packit 352660
.sp
Packit 352660
FcFontSet * FcFontSort (FcConfig *\fIconfig\fB, FcPattern *\fIp\fB, FcBool \fItrim\fB, FcCharSet **\fIcsp\fB, FcResult *\fIresult\fB);
Packit 352660
.fi\fR
Packit 352660
.SH "DESCRIPTION"
Packit 352660
.PP
Packit 352660
Returns the list of fonts sorted by closeness to \fIp\fR\&. If \fItrim\fR is FcTrue,
Packit 352660
elements in the list which don't include Unicode coverage not provided by
Packit 352660
earlier elements in the list are elided. The union of Unicode coverage of
Packit 352660
all of the fonts is returned in \fIcsp\fR, if \fIcsp\fR is not NULL. This function
Packit 352660
should be called only after FcConfigSubstitute and FcDefaultSubstitute have
Packit 352660
been called for \fIp\fR; otherwise the results will not be correct.
Packit 352660
.PP
Packit 352660
The returned FcFontSet references FcPattern structures which may be shared
Packit 352660
by the return value from multiple FcFontSort calls, applications must not
Packit 352660
modify these patterns. Instead, they should be passed, along with \fIp\fR to
Packit 352660
\fBFcFontRenderPrepare\fR which combines them into a complete pattern.
Packit 352660
.PP
Packit 352660
The FcFontSet returned by FcFontSort is destroyed by calling FcFontSetDestroy.
Packit 352660
If \fIconfig\fR is NULL, the current configuration is used.