ttfGetTextSubStringForLine function ttf

bool ttfGetTextSubStringForLine(Pointer<TtfText> text, int line, Pointer<TtfSubString> substring)

Get the substring of a text object that contains the given line.

If line 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 line is greater than or equal to text->num_lines this will return a zero length substring at the end of the text with the TTF_SUBSTRING_TEXT_END flag set.

\param text the TTF_Text to query. \param line a zero-based line index, in the range 0 .. text->num_lines-1. \param substring a pointer filled in with the substring containing the offset. \returns true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should be called on the thread that created the text.

\since This function is available since SDL_ttf 3.0.0.

extern SDL_DECLSPEC bool SDLCALL TTF_GetTextSubStringForLine(TTF_Text *text, int line, TTF_SubString *substring)

Implementation

bool ttfGetTextSubStringForLine(
  Pointer<TtfText> text,
  int line,
  Pointer<TtfSubString> substring,
) {
  final ttfGetTextSubStringForLineLookupFunction = _libTtf
      .lookupFunction<
        Uint8 Function(
          Pointer<TtfText> text,
          Int32 line,
          Pointer<TtfSubString> substring,
        ),
        int Function(
          Pointer<TtfText> text,
          int line,
          Pointer<TtfSubString> substring,
        )
      >('TTF_GetTextSubStringForLine');
  return ttfGetTextSubStringForLineLookupFunction(text, line, substring) == 1;
}