Microsoft DirectX 9.0

IMSVidCtl::get_ColorKey

This topic applies to Windows XP 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 ocKey;
COLORREF clrKey;
pVideoControl->get_ColorKey(&ocKey);
OleTranslateColor(ocKey, 0, &clrKey);

See Also