目次 - SDL_ttf - API(機能別) - レンダリング - TTF_RenderUNICODE_Shaded_Wrapped

TTF_RenderUNICODE_Shaded_Wrapped

UCS-2の改行するテキストを, 生成した8ビットサーフェイスに陰影(Shaded)モードでレンダリングする

構文

SDL_Surface *TTF_RenderUNICODE_Shaded_Wrapped(TTF_Font *font, const Uint16 *text, SDL_Color fg, SDL_Color bg, Uint32 wrapLength)

引数

fontレンダリングで使用するフォント
textレンダリングするUCS-2テキスト
fgテキストの前景色
bgテキストの背景色
wrapLength改行するピクセル数の長さ

戻り値

成功のとき生成された8ビットパレットサーフェイス, エラーのときNULLを戻す.

詳細

この関数は新たに8ビットパレットサーフェイスを生成する. サーフェイスの0ピクセルは背景色で, それ以外のピクセルは様々な明るさの前景色を表している. この関数の戻り値は生成されたサーフェイス, またはエラーが発生した場合はNULLである.

テキストはピクセル数がwrapLengthを超えるとき行末または語の区切りで改行される.

wrapLengthが0のとき, 改行コードの場合のみ改行する.

この関数の名前は"Unicode"となっているが, 現在の実際の入力はUCS-2(1コードポイント16ビット)である. 絵文字のようなそれよりも大きなUnicodeの値は渡せない. そのようなコードポイントはUTF-8版でアクセスできる.

TTF_RenderUNICODE_Solid_Wrapped, TTF_RenderUNICODE_Blended_Wrapped, TTF_RenderUNICODE_LCD_Wrappedを使うと別の画質でレンダリングできる.

バージョン

SDL_ttf 2.0.18以降

関連項目(関数)

TTF_RenderUNICODE_Solid_Wrapped
TTF_RenderUNICODE_Blended_Wrapped
TTF_RenderUNICODE_LCD_Wrapped

SDL Wikiへのリンク

SDL2_ttf/TTF_RenderUNICODE_Shaded_Wrapped