TTF_GetTextSubString(3)

📦 version 3.2.2, in debian trixie, fedora 43, fedora 44, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 TTF_GetTextSubString 💖

okay bestie, welcome to the SDL_ttf3 FUNCTIONS corner of the manual, this one's literally about grabbing the little slice of a text object that wraps around a text offset 🎀

✨ NAME ✨

TTF_GetTextSubString — Get the substring of a text object that surrounds a text offset.

🌸 HEADER FILE 🌸

Defined in SDL3_ttf/SDL_ttf.h — that's the one, no cap 🫶

🦋 SYNOPSIS 🦋

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_GetTextSubString(TTF_Text *text, int offset, TTF_SubString *substring);

💅 DESCRIPTION 💅

So here's the vibe check 👑

If offset is less than 0, this will return a zero length substring at the beginning of the text with the TTF_SUBSTRING_TEXT_START flag set.

If offset is greater than or equal to the length of the text string, this will return a zero length substring at the end of the text with the TTF_SUBSTRING_TEXT_END flag set.

like. it never crashes out on you, it just clamps to the edges and flags it. iconic behaviour fr fr ✨

🍓 FUNCTION PARAMETERS 🍓

  • text — the TTF_Text to query. the main character of this whole situation 💖
  • offset — a byte offset into the text string. yes, byte, not character, don't come for me 🙈
  • substring — a pointer filled in with the substring containing the offset. it writes into this, so hand it something real 🎀

⭐ RETURN VALUE ⭐

Returns true on success or false on failure; call SDL_GetError() for more information. no silent L's here, it tells you what went wrong 🫶

🧚 THREAD SAFETY 🧚

This function should be called on the thread that created the text. like, don't be messy about it, stay on your own thread bestie 💀

🌈 AVAILABILITY 🌈

This function is available since SDL_ttf 3.0.0 — she's been around, she's established, she's serving longevity 👑

💜 quick reminder: the TTF_SUBSTRING_TEXT_START and TTF_SUBSTRING_TEXT_END flags only show up in those out-of-range cases, and the substring is zero length when they do. that's not a bug, that's the design, periodt.

mwah 💋 this page comes to you courtesy of SDL_ttf 3.2.2 — go off, read the rest of the docs, and stay hydrated 🦋✨

📦 where this page comes from