Scroll to navigation

TTF_OpenFontIndexRW(3) SDL_ttf3 FUNCTIONS TTF_OpenFontIndexRW(3)

NAME

TTF_OpenFontIndexRW - Create a font from an SDL_RWops, using a specified face index.

SYNOPSIS

#include "SDL3_ttf/SDL_ttf.h"
TTF_Font * TTF_OpenFontIndexRW(SDL_RWops *src, SDL_bool freesrc, int ptsize, long index);

DESCRIPTION

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.

If freesrc is SDL_TRUE the RWops will be automatically closed once the font is closed. Otherwise you should close the RWops yourself after closing the font.

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.

FUNCTION PARAMETERS

an SDL_RWops to provide a font file's data.
SDL_TRUE to close the RWops when the font is closed, SDL_FALSE to leave it open.
point size to use for the newly-opened font.
index of the face in the font file.

RETURN VALUE

Returns a valid TTF_Font , or NULL on error.

AVAILABILITY

This function is available since SDL_ttf 3.0.0.

SEE ALSO

TTF_CloseFont(3)

SDL_ttf 3.0.0 SDL_ttf