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

SDL_SetSurfaceColorKey

サーフェイスのカラーキー(透過ピクセル)を設定する

ヘッダ

SDL3/SDL_surface.h

構文

bool SDL_SetSurfaceColorKey(SDL_Surface *surface, bool enabled, Uint32 key);

引数

SDL_Surface *surface設定するSDL_Surface
boolenabled真のときカラーキーを有効にする. 偽のとき無効にする
Uint32key透過ピクセル

戻り値

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

詳細

ここでカラーキーとしたピクセルは, 転送時に透明として扱われる. 例えば, これを使用してシアンのピクセルを透明として, レンダリングさせないことができる.

このカラーキーはSDL_MapRGB()で生成されたこのサーフェイスの形式のピクセルである.

スレッドセーフ

この関数はどのスレッドからも安全に呼べる.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_SetSurfaceColorKey - SDL Wiki