目次 - SDL_ttf 3.0 - TTF_GetTextSubStringForLine

TTF_GetTextSubStringForLine

テキストオブジェクト内の指定された行が含まれる部分文字列を得る

ヘッダ

SDL3_ttf/SDL_ttf.h

構文

bool TTF_GetTextSubStringForLine(TTF_Text *text, int line, TTF_SubString *substring);

引数

TTF_Text *text部分文字列を得るTTF_Text
intline0から始まる行のインデックス番号. 範囲は[0 .. text->num_lines-1]
TTF_SubString *substringlineの行が含まれる部分文字列の代入先へのポインタ

戻り値

(bool) 成功のとき真, 失敗のとき偽を戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

lineが0未満の場合, この関数はTTF_SUBSTRING_TEXT_STARTフラグを付けてテキストの先頭から始まる長さ0の部分文字列を戻す. lineがtext->num_lines以上の場合, この関数はTTF_SUBSTRING_TEXT_ENDフラグを付けてテキストの末尾から始まる長さ0の部分文字列を戻す.

スレッドセーフ

この関数はテキストを生成したスレッドから呼ぶ必要がある.

バージョン

SDL_ttf 3.0.0

SDL Wikiへのリンク

SDL3_ttf/TTF_GetTextSubStringForLine