From 42bcefc89108f4f6730581de49d949c679e430b4 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Wed, 29 Jan 2025 15:31:40 +0000
Subject: [PATCH] Sync SDL3_ttf wiki -> header
[ci skip]
---
include/SDL3_ttf/SDL_ttf.h | 22 +++++++++++++---------
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/include/SDL3_ttf/SDL_ttf.h b/include/SDL3_ttf/SDL_ttf.h
index f6e7acca..57bcd18e 100644
--- a/include/SDL3_ttf/SDL_ttf.h
+++ b/include/SDL3_ttf/SDL_ttf.h
@@ -1676,15 +1676,17 @@ extern SDL_DECLSPEC void SDLCALL TTF_DestroySurfaceTextEngine(TTF_TextEngine *en
extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateRendererTextEngine(SDL_Renderer *renderer);
/**
- * Create a text engine for drawing text on an SDL renderer, with the specified properties.
- *
+ * Create a text engine for drawing text on an SDL renderer, with the
+ * specified properties.
+ *
* These are the supported properties:
*
- * - `TTF_PROP_RENDERER_TEXT_ENGINE_RENDERER`: the renderer to use for creating textures
- * and drawing text
- * - `TTF_PROP_RENDERER_TEXT_ENGINE_ATLAS_TEXTURE_SIZE`: the size of the texture atlas
+ * - `TTF_PROP_RENDERER_TEXT_ENGINE_RENDERER`: the renderer to use for
+ * creating textures and drawing text
+ * - `TTF_PROP_RENDERER_TEXT_ENGINE_ATLAS_TEXTURE_SIZE`: the size of the
+ * texture atlas
*
- * \param props the properties to use
+ * \param props the properties to use.
* \returns a TTF_TextEngine object or NULL on failure; call SDL_GetError()
* for more information.
*
@@ -1761,13 +1763,15 @@ extern SDL_DECLSPEC void SDLCALL TTF_DestroyRendererTextEngine(TTF_TextEngine *e
extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateGPUTextEngine(SDL_GPUDevice *device);
/**
- * Create a text engine for drawing text with the SDL GPU API, with the specified properties.
- *
+ * Create a text engine for drawing text with the SDL GPU API, with the
+ * specified properties.
+ *
* These are the supported properties:
*
* - `TTF_PROP_GPU_TEXT_ENGINE_DEVICE`: the SDL_GPUDevice to use for creating
* textures and drawing text.
- * - `TTF_PROP_GPU_TEXT_ENGINE_ATLAS_TEXTURE_SIZE`: the size of the texture atlas
+ * - `TTF_PROP_GPU_TEXT_ENGINE_ATLAS_TEXTURE_SIZE`: the size of the texture
+ * atlas
*
* \param props the properties to use.
* \returns a TTF_TextEngine object or NULL on failure; call SDL_GetError()