TTF_SubStringFlags(3type)

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

✨ TTF_SubStringFlags ✨

okay bestie, welcome to the TTF_SubStringFlags page from the SDL_ttf3 datatypes era 💖 this is a lil type page, not a function page, so buckle up for flags and vibes only.

🌸 NAME 🌸

TTF_SubStringFlags — the flags for TTF_SubString 🎀

🦋 HEADER FILE 🦋

Defined in SDL3_ttf/SDL_ttf.h — that's where you go to find it, no cap.

✨ SYNOPSIS ✨

#include "SDL3_ttf/SDL_ttf.h"

typedef Uint32 TTF_SubStringFlags;

#define TTF_SUBSTRING_DIRECTION_MASK    0x000000FF  /**< The mask for the flow direction for this substring */
#define TTF_SUBSTRING_TEXT_START        0x00000100  /**< This substring contains the beginning of the text */
#define TTF_SUBSTRING_LINE_START        0x00000200  /**< This substring contains the beginning of line `line_index` */
#define TTF_SUBSTRING_LINE_END          0x00000400  /**< This substring contains the end of line `line_index` */
#define TTF_SUBSTRING_TEXT_END          0x00000800  /**< This substring contains the end of the text */

so it's literally just a Uint32 wearing a fancy name 💅 and then a whole lil squad of #defines living inside it. let's meet them one by one, they're all icons:

  • TTF_SUBSTRING_DIRECTION_MASK — 0x000000FF — the mask for the flow direction for this substring 🧭 (iykyk, you mask the direction bits out of the flags)
  • TTF_SUBSTRING_TEXT_START — 0x00000100 — this substring contains the beginning of the text 🌅
  • TTF_SUBSTRING_LINE_START — 0x00000200 — this substring contains the beginning of line line_index 📍
  • TTF_SUBSTRING_LINE_END — 0x00000400 — this substring contains the end of line line_index 🏁
  • TTF_SUBSTRING_TEXT_END — 0x00000800 — this substring contains the end of the text 🌇
not me staring at these hex values like they're a mood ring. they're not, bestie, they're bit flags. do not freestyle them. 🙈

💜 AVAILABILITY 💜

this datatype has been available since SDL_ttf 3.0.0 ⭐ so if you're on anything older, that's a no from her.

👑 SEE ALSO 👑

like, go read TTF_SubString(3type) next, it's the main character this whole flag situation is serving 🫶

and that's the whole page, bestie!! written by the SDL_ttf girlies, version SDL_ttf 3.2.2, for TTF_SubStringFlags(3type) — slay, ate, no crumbs, periodt 💖✨🎀🦋🌸

📦 where this page comes from