TTF_CreateG...thProperties(3)

💖 TTF_CreateGPUTextEngineWithProperties(3) 💖

okay bestie, so we're deep in the SDL_ttf3 function zone, and this one is giving "I make text engines for the GPU" ✨ It's TTF_CreateGPUTextEngineWithProperties, and yes the title is truncated with ... because Unix manpage titles have a character budget and honestly, same. 🫶

---

🌸 NAME 🌸

TTF_CreateGPUTextEngineWithProperties — Create a text engine for drawing text with the SDL GPU API, with the specified properties. periodt 💅

---

🎀 HEADER FILE 🎀

Defined in SDL3_ttf/SDL_ttf.h — that's the one you're gonna #include, no cap.

---

✨ SYNOPSIS ✨

#include "SDL3_ttf/SDL_ttf.h"

TTF_TextEngine * TTF_CreateGPUTextEngineWithProperties(SDL_PropertiesID props);

#define TTF_PROP_GPU_TEXT_ENGINE_DEVICE                   SDL_ttf.gpu_text_engine.create.device"
#define TTF_PROP_GPU_TEXT_ENGINE_ATLAS_TEXTURE_SIZE       SDL_ttf.gpu_text_engine.create.atlas_texture_size"

Like, look at those two macros. They're the whole vibe check for this function. 🌈

---

💜 DESCRIPTION 💜

So these are the supported properties, and bestie, there are exactly two:

• TTF_PROP_GPU_TEXT_ENGINE_DEVICE — the SDL_GPUDevice you wanna use for creating textures and drawing text. This is your main character. 👑
• TTF_PROP_GPU_TEXT_ENGINE_ATLAS_TEXTURE_SIZE — the size of the texture atlas. Big atlas, big energy.

---

🦋 FUNCTION PARAMETERS 🦋

• props — the properties to use. That's it, that's the whole list, she's low maintenance. 🍓

---

💀 RETURN VALUE 💀

Returns a TTF_TextEngine object... or NULL on failure 😭 and if that happens you gotta call SDL_GetError() for more information. Not me manifesting a non-NULL return for you tho 🙈✨

---

🧚 THREAD SAFETY 🧚

This function should be called on the thread that created the device. Like, don't be messy about it — same thread, same energy, no side quests. 🔥

---

⭐ AVAILABILITY ⭐

This function is available since SDL_ttf 3.0.0. She's been here, she's established, she ate. 💅

---

🌈 SEE ALSO 🌈

• •(3)
• TTF_CreateGPUTextEngine(3)
• •(3)
• TTF_DestroyGPUTextEngine(3)
• •(3)
• TTF_GetGPUTextDrawData(3)

iykyk 👑

---

SDL_ttf — SDL_ttf 3.2.2 — mwah, that's a wrap bestie, go make something iconic with your GPU text engine 🎀💖🫶