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

TTF_OpenFontIndexRW

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

Header File

Defined in <SDL_ttf.h>

Syntax

TTF_Font * TTF_OpenFontIndexRW(SDL_RWops *src, int freesrc, int ptsize, long index);

Function Parameters

SDL_RWops * src an SDL_RWops to provide a font file's data.
int freesrc non-zero to close the RWops when the font is closed, zero to leave it open.
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.

If freesrc is non-zero, 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.

Version

This function is available since SDL_ttf 2.0.12.

See Also


CategoryAPI, CategoryAPIFunction


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.