From 2b35e3cf0cf190f957ddbfdbddf53d57aa4d76c2 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Sun, 16 Feb 2025 03:29:07 +0000
Subject: [PATCH] Sync SDL3_ttf wiki -> header
[ci skip]
---
include/SDL3_ttf/SDL_ttf.h | 45 ++++++++++++++++++++++----------------
1 file changed, 26 insertions(+), 19 deletions(-)
diff --git a/include/SDL3_ttf/SDL_ttf.h b/include/SDL3_ttf/SDL_ttf.h
index 15af373f..613450a3 100644
--- a/include/SDL3_ttf/SDL_ttf.h
+++ b/include/SDL3_ttf/SDL_ttf.h
@@ -628,18 +628,22 @@ extern SDL_DECLSPEC TTF_HintingFlags SDLCALL TTF_GetFontHinting(const TTF_Font *
/**
* Enable Signed Distance Field rendering for a font.
*
- * SDF is a technique that helps fonts look sharp even when scaling and rotating, and requires special shader support for display.
+ * SDF is a technique that helps fonts look sharp even when scaling and
+ * rotating, and requires special shader support for display.
*
- * This works with Blended APIs, and generates the raw signed distance values in the alpha channel of the resulting texture.
+ * This works with Blended APIs, and generates the raw signed distance values
+ * in the alpha channel of the resulting texture.
*
- * This updates any TTF_Text objects using this font, and clears already-generated glyphs, if any, from the cache.
+ * This updates any TTF_Text objects using this font, and clears
+ * already-generated glyphs, if any, from the cache.
*
* \param font the font to set SDF support on.
* \param enabled true to enable SDF, false to disable.
- * \returns true on success or false on failure; call SDL_GetError()
- * for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ * information.
*
- * \threadsafety This function should be called on the thread that created the font.
+ * \threadsafety This function should be called on the thread that created the
+ * font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
@@ -650,8 +654,7 @@ extern SDL_DECLSPEC bool SDLCALL TTF_SetFontSDF(TTF_Font *font, bool enabled);
/**
* Query whether Signed Distance Field rendering is enabled for a font.
*
- * \param font the font to query
- *
+ * \param font the font to query.
* \returns true if enabled, false otherwise.
*
* \threadsafety It is safe to call this function from any thread.
@@ -838,8 +841,7 @@ extern SDL_DECLSPEC bool SDLCALL TTF_FontIsFixedWidth(const TTF_Font *font);
*
* Scalability lets us distinguish between outline and bitmap fonts.
*
- * \param font the font to query
- *
+ * \param font the font to query.
* \returns true if the font is scalable, false otherwise.
*
* \threadsafety It is safe to call this function from any thread.
@@ -1032,16 +1034,19 @@ extern SDL_DECLSPEC Uint32 SDLCALL TTF_GetGlyphScript(Uint32 ch);
/**
* Set language to be used for text shaping by a font.
*
- * If SDL_ttf was not built with HarfBuzz support, this function returns false.
+ * If SDL_ttf was not built with HarfBuzz support, this function returns
+ * false.
*
* This updates any TTF_Text objects using this font.
*
* \param font the font to specify a language for.
- * \param language_bcp47 a null-terminated string containing the desired language's BCP47 code. Or null to reset the value.
- * \returns true on success or false on failure; call SDL_GetError()
- * for more information.
+ * \param language_bcp47 a null-terminated string containing the desired
+ * language's BCP47 code. Or null to reset the value.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ * information.
*
- * \threadsafety This function should be called on the thread that created the font.
+ * \threadsafety This function should be called on the thread that created the
+ * font.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
@@ -1148,11 +1153,13 @@ extern SDL_DECLSPEC bool SDLCALL TTF_GetGlyphMetrics(TTF_Font *font, Uint32 ch,
* \param font the font to query.
* \param previous_ch the previous codepoint.
* \param ch the current codepoint.
- * \param kerning a pointer filled in with the kerning size between the two glyphs, in pixels, may be NULL.
- * \returns true on success or false on failure; call SDL_GetError()
- * for more information.
+ * \param kerning a pointer filled in with the kerning size between the two
+ * glyphs, in pixels, may be NULL.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ * information.
*
- * \threadsafety This function should be called on the thread that created the font.
+ * \threadsafety This function should be called on the thread that created the
+ * font.
*
* \since This function is available since SDL_ttf 3.0.0.
*/