TTF_GetText...ingsForRange(3)

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

💖 TTF_GetTextSubStringsForRange(3) 💖

okay bestie, welcome to the SDL_ttf3 FUNCTIONS section of the manual, and lemme tell you, this one is a lil baddie. It's literally the function that gets you the substrings of a text object that contain a range of text. That's it, that's the vibe. 🦋

🌸 NAME 🌸

TTF_GetTextSubStringsForRange — get the substrings of a text object that contain a range of text. no cap, that's the whole job description. ✨

📁 HEADER FILE 📁

It's defined in SDL3_ttf/SDL_ttf.h, bestie. go get it. 💅

✨ SYNOPSIS ✨

#include "SDL3_ttf/SDL_ttf.h"

TTF_SubString ** TTF_GetTextSubStringsForRange(TTF_Text *text, int offset, int length, int *count);

look at her. so clean. so iconic. 👑

🎀 FUNCTION PARAMETERS 🎀

  • text — the TTF_Text to query. this is the text object you're asking about, she's the main character here.
  • offset — a byte offset into the text string. like, where do you wanna start looking, bestie?
  • length — the length of the range being queried, in bytes, or -1 for the remainder of the string. so if you're feeling lazy (real), -1 means "yeah just gimme everything from there to the end". periodt.
  • count — a pointer that gets filled in with the number of substrings returned. it may be NULL, so if you don't care, you can just vibe and pass NULL. 🙈

💜 RETURN VALUE 💜

( TTF_SubString ) It returns a NULL terminated array of substring pointers, or NULL on failure. 😭 and if it fails? call SDL_GetError() for more information, she'll tell you what went wrong.

⚠️ heads up bestie: this is a single allocation that should be freed with SDL_free() when it is no longer needed. do NOT forget, we do not leak memory in this house. 💀

🧚 THREAD SAFETY 🧚

This function should be called on the thread that created the text. no jumping threads, she's loyal like that. 🫶

🌈 AVAILABILITY 🌈

This function is available since SDL_ttf 3.0.0. she's been around, she's got history. ⭐

🍓 SIGN-OFF 🍓

and that's the whole page, bestie!! this came to you from SDL_ttf 3.2.2 (the SDL_ttf manual), and honestly? slay. go forth and get those substrings. 💖🎀✨🔥💅🌸

📦 where this page comes from