DirectX SDK

DirectDrawSurface7.GetColorKey

The DirectDrawSurface7.GetColorKey method retrieves the color key value for the DirectDrawSurface object.

object.GetColorKey(flags As Long, val As DDCOLORKEY)

Parameters

object
Object expression that resolves to a DirectDrawSurface7 object.
flags
Color key requested. One of the following:
DDCKEY_DESTBLT
A color key or color space to be used as a destination color key for blit operations.
DDCKEY_DESTOVERLAY
A color key or color space to be used as a destination color key for overlay operations.
DDCKEY_SRCBLT
A color key or color space to be used as a source color key for blit operations.
DDCKEY_SRCOVERLAY
A color key or color space to be used as a source color key for overlay operations.
val
DDCOLORKEY type to be filled with the current values for the specified color key of the DirectDrawSurface object.

Error Codes

If the method fails, it raises an error, and Err.Number can be set to one of the following values:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_NOCOLORKEY
DDERR_NOCOLORKEYHW
DDERR_SURFACELOST
DDERR_UNSUPPORTED

See Also

DirectDrawSurface7.SetColorKey