From a214f0951de771b125a763573bbc331c4e934f50 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Wed, 29 Jan 2025 13:50:50 -0800
Subject: [PATCH] Expand the text engine documentation a bit
---
include/SDL3_ttf/SDL_ttf.h | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/include/SDL3_ttf/SDL_ttf.h b/include/SDL3_ttf/SDL_ttf.h
index 57bcd18e..18996218 100644
--- a/include/SDL3_ttf/SDL_ttf.h
+++ b/include/SDL3_ttf/SDL_ttf.h
@@ -1565,10 +1565,16 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL TTF_RenderGlyph_LCD(TTF_Font *font, Ui
/**
- * A text engine used to create text objects
+ * A text engine used to create text objects.
*
- * This is a public interface that can be used by applications and libraries.
- * See <SDL3_ttf/SDL_textengine.h> for details.
+ * This is a public interface that can be used by applications and libraries to
+ * perform customize rendering with text objects. See <SDL3_ttf/SDL_textengine.h> for details.
+ *
+ * There are three text engines provided with the library:
+ *
+ * - Drawing to an SDL_Surface, created with TTF_CreateSurfaceTextEngine()
+ * - Drawing with an SDL 2D renderer, created with TTF_CreateRendererTextEngine()
+ * - Drawing with the SDL GPU API, created with TTF_CreateGPUTextEngine()
*
* \since This struct is available since SDL_ttf 3.0.0.
*/