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

SDL_LockTextureToSurface

ピクセルを書き込み専用にするためにテクスチャの一部をロックしSDLサーフェイスにする

構文

int SDL_LockTextureToSurface(SDL_Texture *texture, const SDL_Rect *rect, SDL_Surface **surface)

引数

textureアクセスのためにロックするテクスチャ. SDL_TEXTUREACCESS_STREAMINGで生成されている必要がある
rectアクセスのためロックする領域のSDL_Rect. NULLのとき全体をロックする
surfaceロックされた領域のSDLサーフェイスを代入するポインタ

戻り値

成功のとき0を戻す. テクスチャが使えない, またはSDL_TEXTUREACCESS_STREAMINGで生成されていないとき負の数のエラーコードを戻す. SDL_GetError()で詳細を知ることができる.

詳細

生のピクセルデータの代わりにSDL_Surfaceを戻すこと以外は, この関数はSDL_LockTexture()と同じである.

最適化のため, 編集のために作られたピクセルには古いテクスチャのデータが含まれているとは限らない. これは書き込み専用の操作である. そして, テクスチャデータのコピーを保持したいならば, アプリケーションレベルで行う必要がある.

ピクセルはSDL_UnlockTexture()でアンロックする必要がある.

戻されたサーフェイスはSDL_UnlockTexture()またはSDL_DestroyTexture()を呼んだとき内部で自動的に解放される. 呼び出し元で解放する必要はない.

バージョン

SDL 2.0.12以降

関連項目(関数)

SDL_LockTexture
SDL_UnlockTexture

SDL Wikiへのリンク

SDL_LockTextureToSurface - SDL Wiki