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

# SDL_SetColorKey

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

## 構文

`int SDL_SetColorKey(SDL_Surface* surface, int flag, Uint32 key)`

## 引数

surface | 設定するSDL_Surface
flag | SDL_TRUEのときカラーキーを有効, SDL_FALSEのときを無効にする
key | 透過ピクセル

## 戻り値

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

## 詳細

カラーキーは, 転送時に透明として扱われるピクセル値である. 例えば, この関数を使えば, シアンピクセルを透明としてレンダリングしないようにできる.

カラーキーはsurfaceのピクセル形式で, SDL_MapRGB()で生成できる.

RLEアクセラレーションを使うと透過ピクセルが水平方向に長い画像のコピーが大幅に高速化される. 詳細はSDL_SetSurfaceRLE()を参照すること.

## バージョン

SDL 2.0.0以降

## 関連項目(関数)

SDL_BlitSurface
SDL_GetColorKey

## SDL Wikiへのリンク

SDL_SetColorKey - SDL Wiki