From 099520d9bf907a38e16ed3f1d22a0d98035c9c57 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Fri, 31 Jan 2025 21:17:03 +0000
Subject: [PATCH] Sync SDL3_ttf wiki -> header
[ci skip]
---
include/SDL3_ttf/SDL_ttf.h | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/include/SDL3_ttf/SDL_ttf.h b/include/SDL3_ttf/SDL_ttf.h
index 1f20d713..551fec22 100644
--- a/include/SDL3_ttf/SDL_ttf.h
+++ b/include/SDL3_ttf/SDL_ttf.h
@@ -1842,6 +1842,12 @@ typedef struct TTF_GPUAtlasDrawSequence
* `text` must have been created using a TTF_TextEngine from
* TTF_CreateGPUTextEngine().
*
+ * The positive X-axis is taken towards the right and the positive Y-axis is
+ * taken upwards for both the vertex and the texture coordinates, i.e, it
+ * follows the same convention used by the SDL_GPU API. If you want to use a
+ * different coordinate system you will need to transform the vertices
+ * yourself.
+ *
* If the text looks blocky use linear filtering.
*
* \param text the text to draw.