.\" Generated by scdoc 1.11.0
.\" 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_kerning" "3" "2020-11-07" "2.3.1" "fcft"
.P
.SH NAME
.P
fcft_kerning - calculate kerning distance between two wide characters
.P
.SH SYNOPSIS
.P
\fB#include <fcft/fcft.h>\fR
.P
\fBbool fcft_kerning(\fR
.RS 4
\fBstruct fcft_font *\fR\fIfont\fR\fB, wchar_t \fR\fIleft\fR\fB, wchar_t \fR\fIright\fR\fB,\fR
\fBlong *restrict \fR\fIx\fR\fB, long *restrict \fR\fIy\fR\fB);\fR
.P
.RE
.SH DESCRIPTION
.P
\fBfcft_kerning\fR() calculates the kerning distances \fIx\fR (horizontal) and
\fIy\fR (vertical) between the two wide characters \fIleft\fR and \fIright\fR, in
pixels.
.P
Both characters must exist in the primary font.
.P
\fBfcft_kerning\fR() is just a convenience function around
\fBFT_Get_Kerning\fR() and as such, it only supports legacy \fIkern\fR
tables. In particular, OpenType fonts' \fIGPOS\fR tables are \fBnot\fR
supported. fcft is not a text shaping library.
.P
.SH RETURN VALUE
.P
On success, \fBfcft_kerning\fR() returns true, and \fIx\fR and \fIy\fR are updated
with the kerning distance, in pixels.
.P
On error, false is returned. This may happen for several reasons:
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
The primary font does not have any kerning information.
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
One, or both, of the two characters have no corresponding glyph in
the primary font.
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
There is no kerning information for this character combination.

.RE
.P
.SH EXAMPLE
.P
See \fBfcft_from_name\fR(3)