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

SDL_GetSurfaceColorKey

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

ヘッダ

SDL3/SDL_surface.h

構文

bool SDL_GetSurfaceColorKey(SDL_Surface *surface, Uint32 *key);

引数

SDL_Surface *surface調査するSDL_Surface
Uint32 *key現在の透過ピクセルの代入先へのポインタ

戻り値

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

詳細

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

サーフェイスに有効なカラーキーがない場合は偽を戻す.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_GetSurfaceColorKey - SDL Wiki