Skip to content

Commit

Permalink
Sync SDL3_ttf wiki -> header
Browse files Browse the repository at this point in the history
  • Loading branch information
SDLWikiBot committed Jan 15, 2024
1 parent d3b0814 commit 398dbd4
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions include/SDL3_ttf/SDL_ttf.h
Original file line number Diff line number Diff line change
Expand Up @@ -216,14 +216,15 @@ extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontIndex(const char *file, int ptsiz
* 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.
* 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.
*
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param src an SDL_RWops to provide a font file's data.
* \param freesrc SDL_TRUE to close the RWops when the font is closed, SDL_FALSE to leave it open.
* \param freesrc SDL_TRUE to close the RWops when the font is closed,
* SDL_FALSE to leave it open.
* \param ptsize point size to use for the newly-opened font.
* \returns a valid TTF_Font, or NULL on error.
*
Expand All @@ -240,9 +241,9 @@ extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontRW(SDL_RWops *src, SDL_bool frees
* 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.
* 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
Expand All @@ -251,7 +252,8 @@ extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontRW(SDL_RWops *src, SDL_bool frees
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param src an SDL_RWops to provide a font file's data.
* \param freesrc SDL_TRUE to close the RWops when the font is closed, SDL_FALSE to leave it open.
* \param freesrc SDL_TRUE to close the RWops when the font is closed,
* SDL_FALSE to leave it open.
* \param ptsize point size to use for the newly-opened font.
* \param index index of the face in the font file.
* \returns a valid TTF_Font, or NULL on error.
Expand Down Expand Up @@ -322,14 +324,15 @@ extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontIndexDPI(const char *file, int pt
* 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.
* 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.
*
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param src an SDL_RWops to provide a font file's data.
* \param freesrc SDL_TRUE to close the RWops when the font is closed, SDL_FALSE to leave it open.
* \param freesrc SDL_TRUE to close the RWops when the font is closed,
* SDL_FALSE to leave it open.
* \param ptsize point size to use for the newly-opened font.
* \param hdpi the target horizontal DPI.
* \param vdpi the target vertical DPI.
Expand All @@ -350,9 +353,9 @@ extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontDPIRW(SDL_RWops *src, SDL_bool fr
* 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.
* 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
Expand All @@ -361,7 +364,8 @@ extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontDPIRW(SDL_RWops *src, SDL_bool fr
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param src an SDL_RWops to provide a font file's data.
* \param freesrc SDL_TRUE to close the RWops when the font is closed, SDL_FALSE to leave it open.
* \param freesrc SDL_TRUE to close the RWops when the font is closed,
* SDL_FALSE to leave it open.
* \param ptsize point size to use for the newly-opened font.
* \param index index of the face in the font file.
* \param hdpi the target horizontal DPI.
Expand Down

0 comments on commit 398dbd4

Please sign in to comment.