Added more related functions for the text engine API

slouken · slouken · commit 55bcac4d456d · 2025-02-01T09:59:51.000-08:00
diff --git a/include/SDL3_ttf/SDL_ttf.h b/include/SDL3_ttf/SDL_ttf.h
@@ -1726,6 +1726,8 @@ extern SDL_DECLSPEC void SDLCALL TTF_DestroySurfaceTextEngine(TTF_TextEngine *en
  * \since This function is available since SDL_ttf 3.0.0.
  *
  * \sa TTF_DestroyRendererTextEngine
+ * \sa TTF_DrawRendererText
+ * \sa TTF_CreateRendererTextEngineWithProperties
  */
 extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateRendererTextEngine(SDL_Renderer *renderer);
 
@@ -1749,7 +1751,9 @@ extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateRendererTextEngine(SDL_Re
  *
  * \since This function is available since SDL_ttf 3.0.0.
  *
+ * \sa TTF_CreateRendererTextEngine
  * \sa TTF_DestroyRendererTextEngine
+ * \sa TTF_DrawRendererText
  */
 extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateRendererTextEngineWithProperties(SDL_PropertiesID props);
 
@@ -1812,7 +1816,9 @@ extern SDL_DECLSPEC void SDLCALL TTF_DestroyRendererTextEngine(TTF_TextEngine *e
  *
  * \since This function is available since SDL_ttf 3.0.0.
  *
+ * \sa TTF_CreateGPUTextEngineWithProperties
  * \sa TTF_DestroyGPUTextEngine
+ * \sa TTF_GetGPUTextDrawData
  */
 extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateGPUTextEngine(SDL_GPUDevice *device);
 
@@ -1836,7 +1842,9 @@ extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateGPUTextEngine(SDL_GPUDevi
  *
  * \since This function is available since SDL_ttf 3.0.0.
  *
+ * \sa TTF_CreateGPUTextEngine
  * \sa TTF_DestroyGPUTextEngine
+ * \sa TTF_GetGPUTextDrawData
  */
 extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateGPUTextEngineWithProperties(SDL_PropertiesID props);
 
@@ -1890,7 +1898,7 @@ typedef struct TTF_GPUAtlasDrawSequence
  * \sa TTF_CreateGPUTextEngine
  * \sa TTF_CreateText
  */
-extern SDL_DECLSPEC TTF_GPUAtlasDrawSequence* SDLCALL TTF_GetGPUTextDrawData(TTF_Text *text);
+extern SDL_DECLSPEC TTF_GPUAtlasDrawSequence * SDLCALL TTF_GetGPUTextDrawData(TTF_Text *text);
 
 /**
  * Destroy a text engine created for drawing text with the SDL GPU API.

Original file line number	Diff line number	Diff line change
`@@ -1726,6 +1726,8 @@ extern SDL_DECLSPEC void SDLCALL TTF_DestroySurfaceTextEngine(TTF_TextEngine *en`
`1726`	`1726`	`* \since This function is available since SDL_ttf 3.0.0.`
`1727`	`1727`	`*`
`1728`	`1728`	`* \sa TTF_DestroyRendererTextEngine`
	`1729`	`+ * \sa TTF_DrawRendererText`
	`1730`	`+ * \sa TTF_CreateRendererTextEngineWithProperties`
`1729`	`1731`	`*/`
`1730`	`1732`	`extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateRendererTextEngine(SDL_Renderer *renderer);`
`1731`	`1733`
`@@ -1749,7 +1751,9 @@ extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateRendererTextEngine(SDL_Re`
`1749`	`1751`	`*`
`1750`	`1752`	`* \since This function is available since SDL_ttf 3.0.0.`
`1751`	`1753`	`*`
	`1754`	`+ * \sa TTF_CreateRendererTextEngine`
`1752`	`1755`	`* \sa TTF_DestroyRendererTextEngine`
	`1756`	`+ * \sa TTF_DrawRendererText`
`1753`	`1757`	`*/`
`1754`	`1758`	`extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateRendererTextEngineWithProperties(SDL_PropertiesID props);`
`1755`	`1759`
`@@ -1812,7 +1816,9 @@ extern SDL_DECLSPEC void SDLCALL TTF_DestroyRendererTextEngine(TTF_TextEngine *e`
`1812`	`1816`	`*`
`1813`	`1817`	`* \since This function is available since SDL_ttf 3.0.0.`
`1814`	`1818`	`*`
	`1819`	`+ * \sa TTF_CreateGPUTextEngineWithProperties`
`1815`	`1820`	`* \sa TTF_DestroyGPUTextEngine`
	`1821`	`+ * \sa TTF_GetGPUTextDrawData`
`1816`	`1822`	`*/`
`1817`	`1823`	`extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateGPUTextEngine(SDL_GPUDevice *device);`
`1818`	`1824`
`@@ -1836,7 +1842,9 @@ extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateGPUTextEngine(SDL_GPUDevi`
`1836`	`1842`	`*`
`1837`	`1843`	`* \since This function is available since SDL_ttf 3.0.0.`
`1838`	`1844`	`*`
	`1845`	`+ * \sa TTF_CreateGPUTextEngine`
`1839`	`1846`	`* \sa TTF_DestroyGPUTextEngine`
	`1847`	`+ * \sa TTF_GetGPUTextDrawData`
`1840`	`1848`	`*/`
`1841`	`1849`	`extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_CreateGPUTextEngineWithProperties(SDL_PropertiesID props);`
`1842`	`1850`
`@@ -1890,7 +1898,7 @@ typedef struct TTF_GPUAtlasDrawSequence`
`1890`	`1898`	`* \sa TTF_CreateGPUTextEngine`
`1891`	`1899`	`* \sa TTF_CreateText`
`1892`	`1900`	`*/`
`1893`		`-extern SDL_DECLSPEC TTF_GPUAtlasDrawSequence* SDLCALL TTF_GetGPUTextDrawData(TTF_Text *text);`
	`1901`	`+extern SDL_DECLSPEC TTF_GPUAtlasDrawSequence * SDLCALL TTF_GetGPUTextDrawData(TTF_Text *text);`
`1894`	`1902`
`1895`	`1903`	`/**`
`1896`	`1904`	`* Destroy a text engine created for drawing text with the SDL GPU API.`