.\" 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_rasterize_grapheme_utf32" "3" "2024-02-01" "3.1.7" "fcft"
.P
.SH NAME
.P
fcft_rasterize_grapheme_utf32 - rasterize glyph(s) for a  grapheme cluster
.P
.SH SYNOPSIS
.P
\fB#include <fcft/fcft.\&h>\fR
.P
\fBconst struct fcft_grapheme *fcft_rasterize_grapheme_utf32(\fR
.RS 4
\fBstruct fcft_font *\fR\fIfont\fR\fB,\fR
\fBsize_t \fR\fIlen\fR\fB, const uint32_t \fR\fIgrapheme_cluster[static len]\fR\fB,\fR
\fBenum fcft_subpixel \fR\fIsubpixel\fR\fB);\fR
.P
.RE
.SH DESCRIPTION
.P
\fBfcft_rasterize_grapheme_utf32\fR() rasterizes the grapheme cluster \fIcluster\fR
using the primary font, or one of the fallback fonts, in \fIfont\fR.\&
.P
Each cluster element is an UTF-32 encoded Unicode codepoint.\&
.P
The fonts are searched for \fIall\fR codepoints in the grapheme cluster,
starting with the primary font and then the custom fallback fonts, and
finally the FontConfig provided fallback fonts.\&
.P
\fIsubpixel\fR allows you to specify which subpixel mode to use.\& See
\fBfcft_rasterize_char_utf32\fR() for details.\&
.P
.SH RETURN VALUE
.P
On error, NULL is returned.\&
.P
On success, a pointer to a rasterized grapheme is returned.\& The
grapheme is cached in fcft, making subsequent calls with the same
arguments very fast (i.\&e.\& there is no need for programs to cache
glyphs by themselves).\&
.P
The grapheme object is managed by \fIfont\fR.\& There is no need to
explicitly free it; it is freed when \fIfont\fR is destroyed (with
\fBfcft_destroy\fR()).\&
.P
.nf
.RS 4
struct fcft_grapheme {
    int cols;

    size_t count;
    const struct fcft_glyph **glyphs;
};
.fi
.RE
.P
\fIcols\fR is the number of "columns" the glyph occupies (effectively,
\fBwcswidth\fR(\fIcluster\fR\fB)\fR).\&
.P
\fIglyphs\fR is an array of \fIcount\fR rasterized glyphs.\& See
\fBfcft_rasterize_char_utf32\fR() for a description of \fBstruct
fcft_glyph\fR.\&
.P
.SH SEE ALSO
.P
\fBfcft_destroy\fR(), \fBfcft_rasterize_char_utf32\fR(),
\fBfcft_rasterize_text_run_utf32\fR()