(This function is part of SDL_ttf, a separate library from SDL.)

TTF_OpenFontIndex

Create a font from a file, using a specified face index.

Header File

Syntax

TTF_Font * TTF_OpenFontIndex(const char *file, int ptsize, long index);

Function Parameters

const char *	file	path to font file.
int	ptsize	point size to use for the newly-opened font.
long	index	index of the face in the font file.

Return Value

(TTF_Font *) Returns a valid TTF_Font, or NULL on error.

Remarks

Some .fon fonts will have several sizes embedded in the file, so the point size becomes the index of choosing which size. If the value is too high, the last indexed size will be the default.

Some fonts have multiple "faces" included. The index specifies which face to use from the font file. Font files with only one face should specify zero for the index.

When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.

Version

This function is available since SDL_ttf 2.0.12.