Microsoft DirectX 9.0

IMSVidCtl::put_BackColor

This topic applies to Windows XP only.

The put_BackColor method specifies the background color of the Video Control.

Syntax

HRESULT put_BackColor(
  OLE_COLOR  backcolor
);

Parameters

  backcolor

[in]  Specifies the background color as an OLE_COLOR value.

Return Values

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

Remarks

The Video Control uses the background color when the filter graph is stopped or unbuilt. It also uses this color in letterbox mode to paint unused areas of the video rectangle. The background color is sometimes called the "border" color.

Example Code

COLORREF orange = RGB(0xFF, 0x80, 0x00);
hr = pVideoControl->put_BackColor(static_cast<OLE_COLOR>(orange));

See Also