Microsoft DirectX 8.1 (C++)

IMSVidCtl::get_ColorKey

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The get_ColorKey method retrieves the color key that the video renderer is using.

Syntax

HRESULT get_ColorKey(
  OLE_COLOR*  pCurrentValue
);

Parameters

  pCurrentValue

[out]  Pointer to a variable that receives an OLE_COLOR value.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The color key is used when the video renderer draws to an overlay surface.

Example Code

OLE_COLOR ocBack;
pVideoControl->get_ColorKey(&ocBack);
COLORREF clrBack = TranslateColor(ocBack);

See Also