目次 - SDL_ttf 3.0 - TTF_GetStringSizeWrapped

TTF_GetStringSizeWrapped

UTF-8テキストのレンダリングされた文字列のサイズを得る

ヘッダ

SDL3_ttf/SDL_ttf.h

構文

bool TTF_GetStringSizeWrapped(TTF_Font *font, const char *text, size_t length, int wrap_width, int *w, int *h);

引数

TTF_Font *font問い合わせるフォント
const char *textサイズを求めるUTF-8でエンコードされたテキスト
size_tlengthテキストのバイト数. 0のときNUL終端テキスト
intwrap_width最大幅, または改行文字のみで改行する場合は0
int *w幅のピクセル数の代入先へのポインタ
int *h高さのピクセル数の代入先へのポインタ

戻り値

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

詳細

この関数は指定の文字列を全てレンダリングするために必要な領域の幅と高さを戻す.

wrap_widthピクセルに達するとき, テキストは単語の間と行の終端で複数行に改行される.

wrap_widthが0の場合, 改行文字のみで改行する.

スレッドセーフ

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

バージョン

SDL_ttf 3.0.0

SDL Wikiへのリンク

SDL3_ttf/TTF_GetStringSizeWrappeds