IDirectDrawSurface::SetColorKey

HRESULT SetColorKey(DWORD dwFlags,

LPDDCOLORKEY lpDDColorKey);

Sets the color key value for the DirectDrawSurface object if the hardware supports color keys on a per surface basis.

·Returns DD_OK is successful, or one of the following error values otherwise:

DDERR_GENERIC DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS DDERR_INVALIDSURFACETYPE
DDERR_NOOVERLAYHW DDERR_NOTAOVERLAYSURFACE
DDERR_SURFACELOST DDERR_UNSUPPORTED
DDERR_WASSTILLDRAWING  

dwFlags

Determines which color key is requested.

DDCKEY_COLORSPACE

Set if the structure contains a color space. Not set if the structure contains a single color key.

DDCKEY_DESTBLT

Set if the structure specifies a color key or color space to be used as a destination color key for blit operations.

DDCKEY_DESTOVERLAY

Set if the structure specifies a color key or color space to be used as a destination color key for overlay operations.

DDCKEY_SRCBLT

Set if the structure specifies a color key or color space to be used as a source color key for blit operations.

DDCKEY_SRCOVERLAY

Set if the structure specifies a color key or color space to be used as a source color key for overlay operations.

lpDDColorKey

Address of the DDCOLORKEY structure that has the new color key values for the DirectDrawSurface object.