目次 - SDL 3.0 API(機能別) - 2Dレンダリング - SDL_UpdateTexture

SDL_UpdateTexture

テクスチャの領域を新しいピクセルデータで更新する

ヘッダ

SDL3/SDL_render.h

構文

bool SDL_UpdateTexture(SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch);

引数

SDL_Texture *texture更新するテクスチャ
const SDL_Rect *rectテクスチャを更新する領域のSDL_Rect. NULLのときテクスチャ全体
const void *pixelsテクスチャの形式の生のピクセルデータ
intpitchピクセルデータの水平方向のバイト数. ライン間のパッディングを含む

戻り値

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

詳細

ピクセルデータはテクスチャのピクセル形式でなければならない. テクスチャのピクセル形式はSDL_PROP_TEXTURE_FORMAT_NUMBERプロパティで得ることができる.

この関数はやや遅いので, あまり変更のない静的なテクスチャでの使用に向いている.

もしテクスチャを頻繁に更新するならば, ストリーミングとしてテクスチャを生成し, 下の関連項目のロック関数を使うほうがよい. この関数はストリーミングテクスチャを扱えるが, 最適化の観点からはもし後でロックするならばピクセルを戻さない方がよい.

スレッドセーフ

この関数を呼べるのはメインスレッドのみである.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_UpdateTexture - SDL Wiki