From c05a9441942d244fbcb0b22f678b7d745d04a357 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Fri, 24 Jan 2025 20:32:20 +0000 Subject: [PATCH] Sync SDL3_ttf header -> wiki --- SDL3_ttf/TTF_AppendTextString.md | 4 ++++ SDL3_ttf/TTF_DeleteTextString.md | 4 ++++ SDL3_ttf/TTF_InsertTextString.md | 4 ++++ SDL3_ttf/TTF_SetTextEngine.md | 4 ++++ SDL3_ttf/TTF_SetTextFont.md | 2 ++ SDL3_ttf/TTF_SetTextPosition.md | 2 ++ SDL3_ttf/TTF_SetTextString.md | 4 ++++ SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md | 2 ++ SDL3_ttf/TTF_SetTextWrapWidth.md | 4 ++++ 9 files changed, 30 insertions(+) diff --git a/SDL3_ttf/TTF_AppendTextString.md b/SDL3_ttf/TTF_AppendTextString.md index c5e119358..db14a059a 100644 --- a/SDL3_ttf/TTF_AppendTextString.md +++ b/SDL3_ttf/TTF_AppendTextString.md @@ -26,6 +26,10 @@ bool TTF_AppendTextString(TTF_Text *text, const char *string, size_t length); (bool) Returns true on success or false on failure; call SDL_GetError() for more information. +## Remarks + +This function may cause the internal text representation to be rebuilt. + ## Thread Safety This function should be called on the thread that created the text. diff --git a/SDL3_ttf/TTF_DeleteTextString.md b/SDL3_ttf/TTF_DeleteTextString.md index b20286bd5..d45efafa4 100644 --- a/SDL3_ttf/TTF_DeleteTextString.md +++ b/SDL3_ttf/TTF_DeleteTextString.md @@ -26,6 +26,10 @@ bool TTF_DeleteTextString(TTF_Text *text, int offset, int length); (bool) Returns true on success or false on failure; call SDL_GetError() for more information. +## Remarks + +This function may cause the internal text representation to be rebuilt. + ## Thread Safety This function should be called on the thread that created the text. diff --git a/SDL3_ttf/TTF_InsertTextString.md b/SDL3_ttf/TTF_InsertTextString.md index 77677695e..eb18e838b 100644 --- a/SDL3_ttf/TTF_InsertTextString.md +++ b/SDL3_ttf/TTF_InsertTextString.md @@ -27,6 +27,10 @@ bool TTF_InsertTextString(TTF_Text *text, int offset, const char *string, size_t (bool) Returns true on success or false on failure; call SDL_GetError() for more information. +## Remarks + +This function may cause the internal text representation to be rebuilt. + ## Thread Safety This function should be called on the thread that created the text. diff --git a/SDL3_ttf/TTF_SetTextEngine.md b/SDL3_ttf/TTF_SetTextEngine.md index 656b7e40c..c9928d85c 100644 --- a/SDL3_ttf/TTF_SetTextEngine.md +++ b/SDL3_ttf/TTF_SetTextEngine.md @@ -25,6 +25,10 @@ bool TTF_SetTextEngine(TTF_Text *text, TTF_TextEngine *engine); (bool) Returns true on success or false on failure; call SDL_GetError() for more information. +## Remarks + +This function may cause the internal text representation to be rebuilt. + ## Thread Safety This function should be called on the thread that created the text. diff --git a/SDL3_ttf/TTF_SetTextFont.md b/SDL3_ttf/TTF_SetTextFont.md index 10e2f99ce..e25c5b0bc 100644 --- a/SDL3_ttf/TTF_SetTextFont.md +++ b/SDL3_ttf/TTF_SetTextFont.md @@ -31,6 +31,8 @@ When a text object has a font, any changes to the font will automatically regenerate the text. If you set the font to NULL, the text will continue to render but changes to the font will no longer affect the text. +This function may cause the internal text representation to be rebuilt. + ## Thread Safety This function should be called on the thread that created the text. diff --git a/SDL3_ttf/TTF_SetTextPosition.md b/SDL3_ttf/TTF_SetTextPosition.md index b09fa3dc0..543864e99 100644 --- a/SDL3_ttf/TTF_SetTextPosition.md +++ b/SDL3_ttf/TTF_SetTextPosition.md @@ -26,6 +26,8 @@ bool TTF_SetTextPosition(TTF_Text *text, int x, int y); This can be used to position multiple text objects within a single wrapping text area. +This function may cause the internal text representation to be rebuilt. + ## Thread Safety This function should be called on the thread that created the text. diff --git a/SDL3_ttf/TTF_SetTextString.md b/SDL3_ttf/TTF_SetTextString.md index 78e761767..3bd4026ff 100644 --- a/SDL3_ttf/TTF_SetTextString.md +++ b/SDL3_ttf/TTF_SetTextString.md @@ -26,6 +26,10 @@ bool TTF_SetTextString(TTF_Text *text, const char *string, size_t length); (bool) Returns true on success or false on failure; call SDL_GetError() for more information. +## Remarks + +This function may cause the internal text representation to be rebuilt. + ## Thread Safety This function should be called on the thread that created the text. diff --git a/SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md b/SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md index 414c2e411..de30acd28 100644 --- a/SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md +++ b/SDL3_ttf/TTF_SetTextWrapWhitespaceVisible.md @@ -32,6 +32,8 @@ 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. +This function may cause the internal text representation to be rebuilt. + ## Thread Safety This function should be called on the thread that created the text. diff --git a/SDL3_ttf/TTF_SetTextWrapWidth.md b/SDL3_ttf/TTF_SetTextWrapWidth.md index 09777412a..872dfb40f 100644 --- a/SDL3_ttf/TTF_SetTextWrapWidth.md +++ b/SDL3_ttf/TTF_SetTextWrapWidth.md @@ -25,6 +25,10 @@ bool TTF_SetTextWrapWidth(TTF_Text *text, int wrap_width); (bool) Returns true on success or false on failure; call SDL_GetError() for more information. +## Remarks + +This function may cause the internal text representation to be rebuilt. + ## Thread Safety This function should be called on the thread that created the text.