TTF_GetGlyphImageForIndex(3)

TTF_GetGlyphImageForIndex3

Get the pixel image for a character index.

Usage

#include "SDL3_ttf/SDL_ttf.h"

SDL_Surface * TTF_GetGlyphImageForIndex(TTF_Font *font, Uint32 glyph_index, TTF_ImageType *image_type);

Header file

Defined in SDL3_ttf/SDL_ttf.h

Overview

This is useful for text engine implementations, which can call this with the glyph_index in a TTF_CopyOperation

Function parameters

font

the font to query.

glyph_index

the index of the glyph to return.

image_type

a pointer filled in with the glyph image type, may be NULL.

Return value

Returns an SDL_Surface containing the glyph, or NULL on failure; call SDL_GetError() for more information.

Thread safety

This function should be called on the thread that created the font.

Availability

This function is available since SDL_ttf 3.0.0.

From libsdl3-ttf-doc 3.2.2+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.