.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "fcft_set_scaling_filter" "3" "2024-02-01" "3.1.7" "fcft"
.P
.SH NAME
.P
fcft_set_scaling_filter - configures the filter to use when downscaling bitmap fonts
.P
.SH SYNOPSIS
.P
\fB#include <fcft/fcft.\&h>\fR
.P
\fBbool fcft_set_scaling_filter(enum fcft_scaling_filter \fR\fIfilter\fR\fB);\fR
.P
.SH DESCRIPTION
.P
\fBfcft_set_scaling_filter\fR() configures the filter the use when
downscaling bitmap fonts (typically emoji fonts).\& The setting affects
\fBall\fR font instances.\&
.P
This function does \fBnot\fR clear the glyph caches and should therefore be
called before any calls to \fBfcft_codepoint_rasterize\fR().\&
.P
Possible values for \fIfilter\fR are:
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBFCFT_SCALING_FILTER_NONE\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBFCFT_SCALING_FILTER_NEAREST\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBFCFT_SCALING_FILTER_BILINEAR\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBFCFT_SCALING_FILTER_CUBIC\fR
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBFCFT_SCALING_FILTER_LANCZOS3\fR

.RE
.P
\fBFCFT_SCALING_FILTER_NONE\fR disables filtering.\&
.P
\fBFCFT_SCALING_FILTER_NEAREST\fR and
\fBFCFT_SCALING_FILTER_BILINEAR\fR are traditional filters, with
\fInearest\fR being the fastest.\&
.P
\fBFCFT_SCALING_FILTER_CUBIC\fR and
\fBFCFT_SCALING_FILTER_LANCZOS3\fR are both examples of separable
convolution filters.\& \fICubic\fR is faster than \fIlanczos3\fR, but with
slightly worse result.\& However, both produce much better looking glyphs
than \fInearest\fR.\&
.P
If this function is not called, fcft defaults to
\fBFCFT_SCALING_FILTER_CUBIC\fR.\&
.P
.SH RETURN VALUE
.P
On success, \fBfcft_set_scaling_filter\fR() returns true.\& On error, false
is returned.\&
.P
.SH EXAMPLE
.P
See \fBfcft_from_name\fR()