From 08ecbff9b014a090260a2c29cdc637660b53976a Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Sun, 20 Oct 2024 12:35:04 +0000 Subject: [PATCH] Sync SDL3_ttf header -> wiki --- SDL3_ttf/TTF_AppendTextString.md | 6 +++ SDL3_ttf/TTF_DeleteTextString.md | 6 +++ SDL3_ttf/TTF_GetTextColor.md | 46 ++++++++++++++++++ SDL3_ttf/TTF_GetTextColorFloat.md | 46 ++++++++++++++++++ SDL3_ttf/TTF_GetTextEngine.md | 4 ++ SDL3_ttf/TTF_GetTextFont.md | 4 ++ SDL3_ttf/TTF_GetTextPosition.md | 4 ++ SDL3_ttf/TTF_GetTextWrapping.md | 4 ++ SDL3_ttf/TTF_InsertTextString.md | 6 +++ SDL3_ttf/TTF_SetTextColor.md | 50 ++++++++++++++++++++ SDL3_ttf/TTF_SetTextColorFloat.md | 50 ++++++++++++++++++++ SDL3_ttf/TTF_SetTextEngine.md | 4 ++ SDL3_ttf/TTF_SetTextFont.md | 4 ++ SDL3_ttf/TTF_SetTextPosition.md | 4 ++ SDL3_ttf/TTF_SetTextString.md | 6 +++ SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md | 49 +++++++++++++++++++ SDL3_ttf/TTF_SetTextWrapping.md | 4 ++ SDL3_ttf/TTF_Text.md | 1 - SDL3_ttf/TTF_TextWrapWhitespaceVisible.md | 41 ++++++++++++++++ 19 files changed, 338 insertions(+), 1 deletion(-) create mode 100644 SDL3_ttf/TTF_GetTextColor.md create mode 100644 SDL3_ttf/TTF_GetTextColorFloat.md create mode 100644 SDL3_ttf/TTF_SetTextColor.md create mode 100644 SDL3_ttf/TTF_SetTextColorFloat.md create mode 100644 SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md create mode 100644 SDL3_ttf/TTF_TextWrapWhitespaceVisible.md diff --git a/SDL3_ttf/TTF_AppendTextString.md b/SDL3_ttf/TTF_AppendTextString.md index c4550105a..2c4604ee4 100644 --- a/SDL3_ttf/TTF_AppendTextString.md +++ b/SDL3_ttf/TTF_AppendTextString.md @@ -34,6 +34,12 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_DeleteTextString](TTF_DeleteTextString) +- [TTF_InsertTextString](TTF_InsertTextString) +- [TTF_SetTextString](TTF_SetTextString) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_DeleteTextString.md b/SDL3_ttf/TTF_DeleteTextString.md index 289fd0ff6..1089f6f8e 100644 --- a/SDL3_ttf/TTF_DeleteTextString.md +++ b/SDL3_ttf/TTF_DeleteTextString.md @@ -34,6 +34,12 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_AppendTextString](TTF_AppendTextString) +- [TTF_InsertTextString](TTF_InsertTextString) +- [TTF_SetTextString](TTF_SetTextString) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_GetTextColor.md b/SDL3_ttf/TTF_GetTextColor.md new file mode 100644 index 000000000..d6665736e --- /dev/null +++ b/SDL3_ttf/TTF_GetTextColor.md @@ -0,0 +1,46 @@ +###### (This function is part of SDL_ttf, a separate library from SDL.) +# TTF_GetTextColor + +Get the color of a text object. + +## Header File + +Defined in [](https://github.com/libsdl-org/SDL_ttf/blob/main/include/SDL3_ttf/SDL_ttf.h) + +## Syntax + +```c +bool TTF_GetTextColor(TTF_Text *text, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a); +``` + +## Function Parameters + +| | | | +| ---------------------- | -------- | ---------------------------------------------------------------------------------- | +| [TTF_Text](TTF_Text) * | **text** | the [TTF_Text](TTF_Text) to query. | +| Uint8 * | **r** | a pointer filled in with the red color value in the range of 0-255, may be NULL. | +| Uint8 * | **g** | a pointer filled in with the green color value in the range of 0-255, may be NULL. | +| Uint8 * | **b** | a pointer filled in with the blue color value in the range of 0-255, may be NULL. | +| Uint8 * | **a** | a pointer filled in with the alpha value in the range of 0-255, may be NULL. | + +## Return Value + +(bool) Returns true on success or false on failure; call SDL_GetError() for +more information. + +## Thread Safety + +This function should be called on the thread that created the text. + +## Version + +This function is available since SDL_ttf 3.0.0. + +## See Also + +- [TTF_GetTextColorFloat](TTF_GetTextColorFloat) +- [TTF_SetTextColor](TTF_SetTextColor) + +---- +[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) + diff --git a/SDL3_ttf/TTF_GetTextColorFloat.md b/SDL3_ttf/TTF_GetTextColorFloat.md new file mode 100644 index 000000000..2dd908d96 --- /dev/null +++ b/SDL3_ttf/TTF_GetTextColorFloat.md @@ -0,0 +1,46 @@ +###### (This function is part of SDL_ttf, a separate library from SDL.) +# TTF_GetTextColorFloat + +Get the color of a text object. + +## Header File + +Defined in [](https://github.com/libsdl-org/SDL_ttf/blob/main/include/SDL3_ttf/SDL_ttf.h) + +## Syntax + +```c +bool TTF_GetTextColorFloat(TTF_Text *text, float *r, float *g, float *b, float *a); +``` + +## Function Parameters + +| | | | +| ---------------------- | -------- | ------------------------------------------------------------------------------------------ | +| [TTF_Text](TTF_Text) * | **text** | the [TTF_Text](TTF_Text) to query. | +| float * | **r** | a pointer filled in with the red color value, normally in the range of 0-1, may be NULL. | +| float * | **g** | a pointer filled in with the green color value, normally in the range of 0-1, may be NULL. | +| float * | **b** | a pointer filled in with the blue color value, normally in the range of 0-1, may be NULL. | +| float * | **a** | a pointer filled in with the alpha value in the range of 0-1, may be NULL. | + +## Return Value + +(bool) Returns true on success or false on failure; call SDL_GetError() for +more information. + +## Thread Safety + +This function should be called on the thread that created the text. + +## Version + +This function is available since SDL_ttf 3.0.0. + +## See Also + +- [TTF_GetTextColor](TTF_GetTextColor) +- [TTF_SetTextColorFloat](TTF_SetTextColorFloat) + +---- +[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) + diff --git a/SDL3_ttf/TTF_GetTextEngine.md b/SDL3_ttf/TTF_GetTextEngine.md index d90247373..74e962c0e 100644 --- a/SDL3_ttf/TTF_GetTextEngine.md +++ b/SDL3_ttf/TTF_GetTextEngine.md @@ -33,6 +33,10 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_SetTextEngine](TTF_SetTextEngine) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_GetTextFont.md b/SDL3_ttf/TTF_GetTextFont.md index 9eaa883b2..935031d3c 100644 --- a/SDL3_ttf/TTF_GetTextFont.md +++ b/SDL3_ttf/TTF_GetTextFont.md @@ -32,6 +32,10 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_SetTextFont](TTF_SetTextFont) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_GetTextPosition.md b/SDL3_ttf/TTF_GetTextPosition.md index 9de253e94..02367ccc7 100644 --- a/SDL3_ttf/TTF_GetTextPosition.md +++ b/SDL3_ttf/TTF_GetTextPosition.md @@ -29,6 +29,10 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_SetTextPosition](TTF_SetTextPosition) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_GetTextWrapping.md b/SDL3_ttf/TTF_GetTextWrapping.md index 4d26f5d9c..dcd25e4ca 100644 --- a/SDL3_ttf/TTF_GetTextWrapping.md +++ b/SDL3_ttf/TTF_GetTextWrapping.md @@ -33,6 +33,10 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_SetTextWrapping](TTF_SetTextWrapping) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_InsertTextString.md b/SDL3_ttf/TTF_InsertTextString.md index 9663d7e59..457aff69a 100644 --- a/SDL3_ttf/TTF_InsertTextString.md +++ b/SDL3_ttf/TTF_InsertTextString.md @@ -35,6 +35,12 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_AppendTextString](TTF_AppendTextString) +- [TTF_DeleteTextString](TTF_DeleteTextString) +- [TTF_SetTextString](TTF_SetTextString) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_SetTextColor.md b/SDL3_ttf/TTF_SetTextColor.md new file mode 100644 index 000000000..1e02ab11e --- /dev/null +++ b/SDL3_ttf/TTF_SetTextColor.md @@ -0,0 +1,50 @@ +###### (This function is part of SDL_ttf, a separate library from SDL.) +# TTF_SetTextColor + +Set the color of a text object. + +## Header File + +Defined in [](https://github.com/libsdl-org/SDL_ttf/blob/main/include/SDL3_ttf/SDL_ttf.h) + +## Syntax + +```c +bool TTF_SetTextColor(TTF_Text *text, Uint8 r, Uint8 g, Uint8 b, Uint8 a); +``` + +## Function Parameters + +| | | | +| ---------------------- | -------- | -------------------------------------------- | +| [TTF_Text](TTF_Text) * | **text** | the [TTF_Text](TTF_Text) to modify. | +| Uint8 | **r** | the red color value in the range of 0-255. | +| Uint8 | **g** | the green color value in the range of 0-255. | +| Uint8 | **b** | the blue color value in the range of 0-255. | +| Uint8 | **a** | the alpha value in the range of 0-255. | + +## Return Value + +(bool) Returns true on success or false on failure; call SDL_GetError() for +more information. + +## Remarks + +The default text color is white (255, 255, 255, 255). + +## Thread Safety + +This function should be called on the thread that created the text. + +## Version + +This function is available since SDL_ttf 3.0.0. + +## See Also + +- [TTF_GetTextColor](TTF_GetTextColor) +- [TTF_SetTextColorFloat](TTF_SetTextColorFloat) + +---- +[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) + diff --git a/SDL3_ttf/TTF_SetTextColorFloat.md b/SDL3_ttf/TTF_SetTextColorFloat.md new file mode 100644 index 000000000..2427f60be --- /dev/null +++ b/SDL3_ttf/TTF_SetTextColorFloat.md @@ -0,0 +1,50 @@ +###### (This function is part of SDL_ttf, a separate library from SDL.) +# TTF_SetTextColorFloat + +Set the color of a text object. + +## Header File + +Defined in [](https://github.com/libsdl-org/SDL_ttf/blob/main/include/SDL3_ttf/SDL_ttf.h) + +## Syntax + +```c +bool TTF_SetTextColorFloat(TTF_Text *text, float r, float g, float b, float a); +``` + +## Function Parameters + +| | | | +| ---------------------- | -------- | ---------------------------------------------------- | +| [TTF_Text](TTF_Text) * | **text** | the [TTF_Text](TTF_Text) to modify. | +| float | **r** | the red color value, normally in the range of 0-1. | +| float | **g** | the green color value, normally in the range of 0-1. | +| float | **b** | the blue color value, normally in the range of 0-1. | +| float | **a** | the alpha value in the range of 0-1. | + +## Return Value + +(bool) Returns true on success or false on failure; call SDL_GetError() for +more information. + +## Remarks + +The default text color is white (1.0f, 1.0f, 1.0f, 1.0f). + +## Thread Safety + +This function should be called on the thread that created the text. + +## Version + +This function is available since SDL_ttf 3.0.0. + +## See Also + +- [TTF_GetTextColorFloat](TTF_GetTextColorFloat) +- [TTF_SetTextColor](TTF_SetTextColor) + +---- +[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) + diff --git a/SDL3_ttf/TTF_SetTextEngine.md b/SDL3_ttf/TTF_SetTextEngine.md index 438a0d90f..2656c71e6 100644 --- a/SDL3_ttf/TTF_SetTextEngine.md +++ b/SDL3_ttf/TTF_SetTextEngine.md @@ -33,6 +33,10 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_GetTextEngine](TTF_GetTextEngine) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_SetTextFont.md b/SDL3_ttf/TTF_SetTextFont.md index 4eb4b5db5..638e2aa6d 100644 --- a/SDL3_ttf/TTF_SetTextFont.md +++ b/SDL3_ttf/TTF_SetTextFont.md @@ -34,6 +34,10 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_GetTextFont](TTF_GetTextFont) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_SetTextPosition.md b/SDL3_ttf/TTF_SetTextPosition.md index 5dacfd84c..f741aa414 100644 --- a/SDL3_ttf/TTF_SetTextPosition.md +++ b/SDL3_ttf/TTF_SetTextPosition.md @@ -34,6 +34,10 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_GetTextPosition](TTF_GetTextPosition) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_SetTextString.md b/SDL3_ttf/TTF_SetTextString.md index 9a16e7b28..855353c0d 100644 --- a/SDL3_ttf/TTF_SetTextString.md +++ b/SDL3_ttf/TTF_SetTextString.md @@ -34,6 +34,12 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_AppendTextString](TTF_AppendTextString) +- [TTF_DeleteTextString](TTF_DeleteTextString) +- [TTF_InsertTextString](TTF_InsertTextString) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md b/SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md new file mode 100644 index 000000000..9cb63e037 --- /dev/null +++ b/SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md @@ -0,0 +1,49 @@ +###### (This function is part of SDL_ttf, a separate library from SDL.) +# TTF_SetTextWrapWhitespaceVisible + +Set whether whitespace should be visible when wrapping a text object. + +## Header File + +Defined in [](https://github.com/libsdl-org/SDL_ttf/blob/main/include/SDL3_ttf/SDL_ttf.h) + +## Syntax + +```c +bool TTF_SetTextWrapWhitespaceVisible(TTF_Text *text, bool visible); +``` + +## Function Parameters + +| | | | +| ---------------------- | ----------- | ------------------------------------------------------------- | +| [TTF_Text](TTF_Text) * | **text** | the [TTF_Text](TTF_Text) to modify. | +| bool | **visible** | true to show whitespace when wrapping text, false to hide it. | + +## Return Value + +(bool) Returns true on success or false on failure; call SDL_GetError() for +more information. + +## Remarks + +If the whitespace is visible, it will take up space for purposes of +alignment and wrapping. This is good for editing, but looks better when +centered or aligned if whitespace around line wrapping is hidden. This +defaults false. + +## Thread Safety + +This function should be called on the thread that created the text. + +## Version + +This function is available since SDL_ttf 3.0.0. + +## See Also + +- [TTF_TextWrapWhitespaceVisible](TTF_TextWrapWhitespaceVisible) + +---- +[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) + diff --git a/SDL3_ttf/TTF_SetTextWrapping.md b/SDL3_ttf/TTF_SetTextWrapping.md index 72192b224..4074594f0 100644 --- a/SDL3_ttf/TTF_SetTextWrapping.md +++ b/SDL3_ttf/TTF_SetTextWrapping.md @@ -33,6 +33,10 @@ This function should be called on the thread that created the text. This function is available since SDL_ttf 3.0.0. +## See Also + +- [TTF_GetTextWrapping](TTF_GetTextWrapping) + ---- [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) diff --git a/SDL3_ttf/TTF_Text.md b/SDL3_ttf/TTF_Text.md index 0a39e8422..96ce2c6b2 100644 --- a/SDL3_ttf/TTF_Text.md +++ b/SDL3_ttf/TTF_Text.md @@ -13,7 +13,6 @@ Defined in [](https://github.com/libsdl-org/SDL_ttf/blob/mai typedef struct TTF_Text { char *text; /**< A copy of the text used to create this text object, useful for layout and debugging. This will be freed automatically when the object is destroyed. */ - SDL_FColor color; /**< The color of the text, read-write. You can change this anytime. */ int num_lines; /**< The number of lines in the text, 0 if it's empty */ int refcount; /**< Application reference count, used when freeing surface */ diff --git a/SDL3_ttf/TTF_TextWrapWhitespaceVisible.md b/SDL3_ttf/TTF_TextWrapWhitespaceVisible.md new file mode 100644 index 000000000..14239efca --- /dev/null +++ b/SDL3_ttf/TTF_TextWrapWhitespaceVisible.md @@ -0,0 +1,41 @@ +###### (This function is part of SDL_ttf, a separate library from SDL.) +# TTF_TextWrapWhitespaceVisible + +Return whether whitespace is shown when wrapping a text object. + +## Header File + +Defined in [](https://github.com/libsdl-org/SDL_ttf/blob/main/include/SDL3_ttf/SDL_ttf.h) + +## Syntax + +```c +bool TTF_TextWrapWhitespaceVisible(TTF_Text *text); +``` + +## Function Parameters + +| | | | +| ---------------------- | -------- | ---------------------------------- | +| [TTF_Text](TTF_Text) * | **text** | the [TTF_Text](TTF_Text) to query. | + +## Return Value + +(bool) Returns true if whitespace is shown when wrapping text, or false +otherwise. + +## Thread Safety + +This function should be called on the thread that created the text. + +## Version + +This function is available since SDL_ttf 3.0.0. + +## See Also + +- [TTF_SetTextWrapWhitespaceVisible](TTF_SetTextWrapWhitespaceVisible) + +---- +[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction) +