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

SDL_LockSurface

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

構文

int SDL_LockSurface(SDL_Surface* surface)

引数

surfaceロックするSDL_Surface

戻り値

成功のとき0, 失敗のとき負の数のエラーコードを戻す. SDL_GetError()を呼んで詳細を知ることができる.

サンプルコード

/* サーフェイスのピクセルにアクセスできるようにする */

SDL_LockSurface(surface);

/* サーフェイスがロックされた */
/* ここで直接ピクセルにアクセスできる */

SDL_UnlockSurface(surface);

/* サーフェイスはアンロックされた */

詳細

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

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

バージョン

SDL 2.0.0以降

関連項目(関数)

SDL_MUSTLOCK
SDL_UnlockSurface

SDL Wikiへのリンク

SDL_LockSurface - SDL Wiki