目次 - SDL 3.0 API(機能別) - サーフェイスの生成と単純な描画 - SDL_LockSurface

SDL_LockSurface

ピクセル領域に直接アクセスできるように設定する

ヘッダ

SDL3/SDL_surface.h

構文

int SDL_LockSurface(SDL_Surface* surface)

引数

SDL_SurfacesurfaceロックするSDL_Surface

戻り値

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

詳細

SDL_LockSurface()とSDL_UnlockSurface()の間で, surface->formatに格納されたピクセル形式でsurface->pixelの読み込みと書き込みができる. サーフェイスへのアクセスを終えたなら, SDL_UnlockSurface()を呼んでロックを解放する必要がある.

全てのサーフェイスがロックを必要としているとは限らない SDL_MUSTLOCK(surface)が0ならば, いつでもサーフェイスに読み書き可能で, サーフェイスのピクセル形式は変化しない.

スレッドセーフ

この関数は別のスレッドから別のサーフェイスに対して呼ぶことができる. この関数のロックは, ピクセルに直接アクセスできるようにするためのもので, スレッドセーフのためのロックではない.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_LockSurface - SDL Wiki