.\" Generated by scdoc 1.11.3
.\" 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" "2025-01-02" "3.1.10" "fcft"
.PP
.SH NAME
.PP
fcft_kerning - calculate kerning distance between two wide characters
.PP
.SH SYNOPSIS
.PP
\fB#include <fcft/fcft.\&h>\fR
.PP
\fBbool fcft_kerning(\fR
.RS 4
\fBstruct fcft_font *\fR\fIfont\fR\fB, uint32_t \fR\fIleft\fR\fB, uint32_t \fR\fIright\fR\fB,\fR
\fBlong *restrict \fR\fIx\fR\fB, long *restrict \fR\fIy\fR\fB);\fR
.PP
.RE
.SH DESCRIPTION
.PP
\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.\&
.PP
Both characters must exist in the primary font.\&
.PP
\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.\&
.PP
.SH RETURN VALUE
.PP
On success, \fBfcft_kerning\fR() returns true, and \fIx\fR and \fIy\fR are updated
with the kerning distance, in pixels.\&
.PP
On error, false is returned.\& This may happen for several reasons:
.PP
.PD 0
.IP \(bu 4
The primary font does not have any kerning information.\&
.IP \(bu 4
One, or both, of the two characters have no corresponding glyph in
the primary font.\&
.IP \(bu 4
There is no kerning information for this character combination.\&
.PD
.PP
.SH EXAMPLE
.PP
See \fBfcft_from_name\fR()