TTF_GetGlyphImageForIndex - Man Page

Get the pixel image for a character index.

Header File

Defined in SDL3_ttf/SDL_ttf.h

Synopsis

#include "SDL3_ttf/SDL_ttf.h"

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

Description

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.

Info

SDL_ttf 3.2.2 SDL_ttf3 FUNCTIONS