Platform SDK: DirectX

IDirectDrawSurface7::SetColorKey

IDirectDrawSurface7::SetColorKey メソッドは、ハードウェアがサーフェス基準ごとにカラー キーをサポートする場合、DirectDrawSurface オブジェクトに対するカラー キー値を設定する。

HRESULT SetColorKey(
  DWORD dwFlags,             
  LPDDCOLORKEY lpDDColorKey  
);

パラメータ

dwFlags
要求されるカラー キーを決定する。以下のフラグが定義されている。
DDCKEY_COLORSPACE
色空間 を含む構造体。構造体に単一のカラー キーがある場合は設定しない。
DDCKEY_DESTBLT
ブリット処理の転送先カラー キーとして使用するカラー キーまたは色空間。
DDCKEY_DESTOVERLAY
オーバーレイ処理の転送先カラー キーとして使用するカラー キーまたは色空間。
DDCKEY_SRCBLT
ブリット処理の転送元カラー キーとして使用するカラー キーまたは色空間。
DDCKEY_SRCOVERLAY
オーバーレイ処理の転送元カラー キーとして使用するカラー キーまたは色空間。
lpDDColorKey
DirectDrawSurface オブジェクトの新しいカラー キー値を含む DDCOLORKEY 構造体のアドレス。前もって設定したカラー キーを削除するには、この値を NULL にする。

戻り値

成功すれば、DD_OK を返す。

失敗すれば、以下のエラー値のいずれかを返す。

DDERR_GENERIC
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDSURFACETYPE
DDERR_NOOVERLAYHW
DDERR_NOTAOVERLAYSURFACE
DDERR_SURFACELOST
DDERR_UNSUPPORTED
DDERR_WASSTILLDRAWING

注意

透過型ブリットおよびオーバーレイに対して、転送先サーフェスの転送先の色および転送元サーフェスの転送元の色を設定すること。

動作環境

  Windows NT/2000 :Windows 2000 が必要。
  Windows 95/98 : Windows 98 が必要。
  ヘッダー : ddraw.h で宣言。

参照

IDirectDrawSurface7::GetColorKey