public:
     virtual bool __fastcall SetColorKey( dword pFlags, TDDColorKey* pColorKey );

• Description
• Parameters
• See Also

If you would like to submit additions or improvements to this page, click: admin@bcb-tools.com.

The TDx_DrawSurface::SetColorKey method will set the surface's color key.

Hardware support for "per surface" color keys must exist.

When performing transparent blits and overlays, the destination color key should be set on the destination surface and the source color key set on the source surface.

If the method call fails, the OnError event will be triggered with one of the following values:
DDERR_GENERIC
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDSURFACETYPE
DDERR_NOOVERLAYHW
DDERR_NOTAOVERLAYSURFACE
DDERR_SURFACELOST
DDERR_UNSUPPORTED
DDERR_WASSTILLDRAWING

Flags
The Flags parameter defines flags indicating which color key is being set.
The described effect applies when the flag is set.
DDCKEY_COLORSPACE
The key being set is a range of color values rather than a single color.

DDCKEY_DESTBLT
The key being set is the destination color key for blits.

DDCKEY_DESTOVERLAY
The key being set is the destination color key for overlays.

DDCKEY_SRCBLT
The key being set is the source color key for blits.

DDCKEY_SRCOVERLAY
The key being set is the source color key for overlays.

ColorKey
The ColorKey parameter references a TDDColorKey component holding the color key values to be set.
Set this parameter to NULL to remove the specified color key.

TDx_DrawSurface
TDx_DrawSurface::OnSurfaceLost()
TDDColorKey