Sync SDL3_ttf header -> wiki

libsdl-org · Sep 18, 2024 · fd6dbb9 · fd6dbb9
1 parent 9f1ea58
commit fd6dbb9
Show file tree

Hide file tree

Showing 23 changed files with 96 additions and 100 deletions.
diff --git a/SDL3_ttf/TTF_ByteSwappedUNICODE.md b/SDL3_ttf/TTF_ByteSwappedUNICODE.md
@@ -10,14 +10,14 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-void TTF_ByteSwappedUNICODE(SDL_bool swapped);
+void TTF_ByteSwappedUNICODE(bool swapped);
 ```
 
 ## Function Parameters
 
-|  | | |
-| -------- | ----------- | ------------------------------------------------ |
-| SDL_bool | **swapped** | boolean to indicate whether text is byteswapped. |
+| | | |
+| ---- | ----------- | ------------------------------------------------ |
+| bool | **swapped** | boolean to indicate whether text is byteswapped. |
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_FontFaceIsFixedWidth.md b/SDL3_ttf/TTF_FontFaceIsFixedWidth.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_FontFaceIsFixedWidth(const TTF_Font *font);
+bool TTF_FontFaceIsFixedWidth(const TTF_Font *font);
 ```
 
 ## Function Parameters
@@ -21,7 +21,7 @@ SDL_bool TTF_FontFaceIsFixedWidth(const TTF_Font *font);
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE if fixed-width, SDL_FALSE if not.
+(bool) Returns true if fixed-width, false if not.
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_GetFontKerning.md b/SDL3_ttf/TTF_GetFontKerning.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_GetFontKerning(const TTF_Font *font);
+bool TTF_GetFontKerning(const TTF_Font *font);
 ```
 
 ## Function Parameters
@@ -21,7 +21,7 @@ SDL_bool TTF_GetFontKerning(const TTF_Font *font);
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE if kerning is enabled, SDL_FALSE otherwise.
+(bool) Returns true if kerning is enabled, false otherwise.
 
 ## Version
 

diff --git a/SDL3_ttf/TTF_GlyphIsProvided.md b/SDL3_ttf/TTF_GlyphIsProvided.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_GlyphIsProvided(TTF_Font *font, Uint16 ch);
+bool TTF_GlyphIsProvided(TTF_Font *font, Uint16 ch);
 ```
 
 ## Function Parameters
@@ -22,8 +22,8 @@ SDL_bool TTF_GlyphIsProvided(TTF_Font *font, Uint16 ch);
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE if font provides a glyph for this character,
-SDL_FALSE if not.
+(bool) Returns true if font provides a glyph for this character, false if
+not.
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_GlyphIsProvided32.md b/SDL3_ttf/TTF_GlyphIsProvided32.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_GlyphIsProvided32(TTF_Font *font, Uint32 ch);
+bool TTF_GlyphIsProvided32(TTF_Font *font, Uint32 ch);
 ```
 
 ## Function Parameters
@@ -22,8 +22,8 @@ SDL_bool TTF_GlyphIsProvided32(TTF_Font *font, Uint32 ch);
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE if font provides a glyph for this character,
-SDL_FALSE if not.
+(bool) Returns true if font provides a glyph for this character, false if
+not.
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_GlyphMetrics.md b/SDL3_ttf/TTF_GlyphMetrics.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_GlyphMetrics(TTF_Font *font, Uint16 ch,
+bool TTF_GlyphMetrics(TTF_Font *font, Uint16 ch,
  int *minx, int *maxx,
  int *miny, int *maxy, int *advance);
 ```
@@ -24,8 +24,8 @@ SDL_bool TTF_GlyphMetrics(TTF_Font *font, Uint16 ch,
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
-SDL_GetError() for more information.
+(bool) Returns true on success or false on failure; call SDL_GetError() for
+more information.
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_GlyphMetrics32.md b/SDL3_ttf/TTF_GlyphMetrics32.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_GlyphMetrics32(TTF_Font *font, Uint32 ch,
+bool TTF_GlyphMetrics32(TTF_Font *font, Uint32 ch,
  int *minx, int *maxx,
  int *miny, int *maxy, int *advance);
 ```
@@ -24,8 +24,8 @@ SDL_bool TTF_GlyphMetrics32(TTF_Font *font, Uint32 ch,
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
-SDL_GetError() for more information.
+(bool) Returns true on success or false on failure; call SDL_GetError() for
+more information.
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_Init.md b/SDL3_ttf/TTF_Init.md
@@ -10,13 +10,13 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_Init(void);
+bool TTF_Init(void);
 ```
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
-SDL_GetError() for more information.
+(bool) Returns true on success or false on failure; call SDL_GetError() for
+more information.
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_MeasureText.md b/SDL3_ttf/TTF_MeasureText.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_MeasureText(TTF_Font *font, const char *text, int measure_width, int *extent, int *count);
+bool TTF_MeasureText(TTF_Font *font, const char *text, int measure_width, int *extent, int *count);
 ```
 
 ## Function Parameters
@@ -25,8 +25,8 @@ SDL_bool TTF_MeasureText(TTF_Font *font, const char *text, int measure_width, in
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
-SDL_GetError() for more information.
+(bool) Returns true on success or false on failure; call SDL_GetError() for
+more information.
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_MeasureUNICODE.md b/SDL3_ttf/TTF_MeasureUNICODE.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_MeasureUNICODE(TTF_Font *font, const Uint16 *text, int measure_width, int *extent, int *count);
+bool TTF_MeasureUNICODE(TTF_Font *font, const Uint16 *text, int measure_width, int *extent, int *count);
 ```
 
 ## Function Parameters
@@ -25,8 +25,8 @@ SDL_bool TTF_MeasureUNICODE(TTF_Font *font, const Uint16 *text, int measure_widt
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
-SDL_GetError() for more information.
+(bool) Returns true on success or false on failure; call SDL_GetError() for
+more information.
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_MeasureUTF8.md b/SDL3_ttf/TTF_MeasureUTF8.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_MeasureUTF8(TTF_Font *font, const char *text, int measure_width, int *extent, int *count);
+bool TTF_MeasureUTF8(TTF_Font *font, const char *text, int measure_width, int *extent, int *count);
 ```
 
 ## Function Parameters
@@ -25,8 +25,8 @@ SDL_bool TTF_MeasureUTF8(TTF_Font *font, const char *text, int measure_width, in
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
-SDL_GetError() for more information.
+(bool) Returns true on success or false on failure; call SDL_GetError() for
+more information.
 
 ## Remarks
 

diff --git a/SDL3_ttf/TTF_OpenFontDPIIO.md b/SDL3_ttf/TTF_OpenFontDPIIO.md
@@ -10,18 +10,18 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-TTF_Font * TTF_OpenFontDPIIO(SDL_IOStream *src, SDL_bool closeio, int ptsize, unsigned int hdpi, unsigned int vdpi);
+TTF_Font * TTF_OpenFontDPIIO(SDL_IOStream *src, bool closeio, int ptsize, unsigned int hdpi, unsigned int vdpi);
 ```
 
 ## Function Parameters
 
-| | |  |
-| -------------- | ----------- | ---------------------------------------------------------------------------- |
-| SDL_IOStream * | **src** | an SDL_IOStream to provide a font file's data.  |
-| SDL_bool | **closeio** | SDL_TRUE to close `src` when the font is closed, SDL_FALSE to leave it open. |
-| int | **ptsize** | point size to use for the newly-opened font.  |
-| unsigned int | **hdpi** | the target horizontal DPI.  |
-| unsigned int | **vdpi** | the target vertical DPI.  |
+| | | |
+| -------------- | ----------- | -------------------------------------------------------------------- |
+| SDL_IOStream * | **src** | an SDL_IOStream to provide a font file's data. |
+| bool  | **closeio** | true to close `src` when the font is closed, false to leave it open. |
+| int | **ptsize** | point size to use for the newly-opened font. |
+| unsigned int | **hdpi** | the target horizontal DPI. |
+| unsigned int | **vdpi** | the target vertical DPI. |
 
 ## Return Value
 
@@ -36,9 +36,8 @@ 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 `closeio` is SDL_TRUE `src` will be automatically closed once the font
-is closed. Otherwise you should close `src` yourself after closing the
-font.
+If `closeio` is true `src` will be automatically closed once the font is
+closed. Otherwise you should close `src` yourself after closing the font.
 
 When done with the returned [TTF_Font](TTF_Font), use
 [TTF_CloseFont](TTF_CloseFont)() to dispose of it.

diff --git a/SDL3_ttf/TTF_OpenFontIO.md b/SDL3_ttf/TTF_OpenFontIO.md
@@ -10,16 +10,16 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-TTF_Font * TTF_OpenFontIO(SDL_IOStream *src, SDL_bool closeio, int ptsize);
+TTF_Font * TTF_OpenFontIO(SDL_IOStream *src, bool closeio, int ptsize);
 ```
 
 ## Function Parameters
 
-| | |  |
-| -------------- | ----------- | ---------------------------------------------------------------------------- |
-| SDL_IOStream * | **src** | an SDL_IOStream to provide a font file's data.  |
-| SDL_bool | **closeio** | SDL_TRUE to close `src` when the font is closed, SDL_FALSE to leave it open. |
-| int | **ptsize** | point size to use for the newly-opened font.  |
+| | | |
+| -------------- | ----------- | -------------------------------------------------------------------- |
+| SDL_IOStream * | **src** | an SDL_IOStream to provide a font file's data. |
+| bool  | **closeio** | true to close `src` when the font is closed, false to leave it open. |
+| int | **ptsize** | point size to use for the newly-opened font. |
 
 ## Return Value
 
@@ -32,9 +32,8 @@ 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 `closeio` is SDL_TRUE, `src` will be automatically closed once the font
-is closed. Otherwise you should close `src` yourself after closing the
-font.
+If `closeio` is true, `src` will be automatically closed once the font is
+closed. Otherwise you should close `src` yourself after closing the font.
 
 When done with the returned [TTF_Font](TTF_Font), use
 [TTF_CloseFont](TTF_CloseFont)() to dispose of it.

diff --git a/SDL3_ttf/TTF_OpenFontIndexDPIIO.md b/SDL3_ttf/TTF_OpenFontIndexDPIIO.md
@@ -10,19 +10,19 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-TTF_Font * TTF_OpenFontIndexDPIIO(SDL_IOStream *src, SDL_bool closeio, int ptsize, long index, unsigned int hdpi, unsigned int vdpi);
+TTF_Font * TTF_OpenFontIndexDPIIO(SDL_IOStream *src, bool closeio, int ptsize, long index, unsigned int hdpi, unsigned int vdpi);
 ```
 
 ## Function Parameters
 
-| | |  |
-| -------------- | ----------- | ---------------------------------------------------------------------------- |
-| SDL_IOStream * | **src** | an SDL_IOStream to provide a font file's data.  |
-| SDL_bool | **closeio** | SDL_TRUE to close `src` when the font is closed, SDL_FALSE 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.  |
-| unsigned int | **hdpi** | the target horizontal DPI.  |
-| unsigned int | **vdpi** | the target vertical DPI.  |
+| | | |
+| -------------- | ----------- | -------------------------------------------------------------------- |
+| SDL_IOStream * | **src** | an SDL_IOStream to provide a font file's data. |
+| bool  | **closeio** | true to close `src` when the font is closed, false 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. |
+| unsigned int | **hdpi** | the target horizontal DPI. |
+| unsigned int | **vdpi** | the target vertical DPI. |
 
 ## Return Value
 
@@ -37,9 +37,8 @@ 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 `closeio` is SDL_TRUE `src` will be automatically closed once the font
-is closed. Otherwise you should close `src` yourself after closing the
-font.
+If `closeio` is true `src` will be automatically closed once the font is
+closed. Otherwise you should close `src` 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

diff --git a/SDL3_ttf/TTF_OpenFontIndexIO.md b/SDL3_ttf/TTF_OpenFontIndexIO.md
@@ -10,17 +10,17 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-TTF_Font * TTF_OpenFontIndexIO(SDL_IOStream *src, SDL_bool closeio, int ptsize, long index);
+TTF_Font * TTF_OpenFontIndexIO(SDL_IOStream *src, bool closeio, int ptsize, long index);
 ```
 
 ## Function Parameters
 
-| | |  |
-| -------------- | ----------- | ---------------------------------------------------------------------------- |
-| SDL_IOStream * | **src** | an SDL_IOStream to provide a font file's data.  |
-| SDL_bool | **closeio** | SDL_TRUE to close `src` when the font is closed, SDL_FALSE 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.  |
+| | | |
+| -------------- | ----------- | -------------------------------------------------------------------- |
+| SDL_IOStream * | **src** | an SDL_IOStream to provide a font file's data. |
+| bool  | **closeio** | true to close `src` when the font is closed, false 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
 
@@ -33,9 +33,8 @@ 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 `closeio` is SDL_TRUE `src` will be automatically closed once the font
-is closed. Otherwise you should close `src` yourself after closing the
-font.
+If `closeio` is true `src` will be automatically closed once the font is
+closed. Otherwise you should close `src` 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

diff --git a/SDL3_ttf/TTF_SetFontDirection.md b/SDL3_ttf/TTF_SetFontDirection.md
@@ -10,7 +10,7 @@ Defined in [<SDL3_ttf/SDL_ttf.h>](https://github.com/libsdl-org/SDL_ttf/blob/mai
 ## Syntax
 
 ```c
-SDL_bool TTF_SetFontDirection(TTF_Font *font, TTF_Direction direction);
+bool TTF_SetFontDirection(TTF_Font *font, TTF_Direction direction);
 ```
 
 ## Function Parameters
@@ -22,8 +22,8 @@ SDL_bool TTF_SetFontDirection(TTF_Font *font, TTF_Direction direction);
 
 ## Return Value
 
-(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call
-SDL_GetError() for more information.
+(bool) Returns true on success or false on failure; call SDL_GetError() for
+more information.
 
 ## Remarks