Microsoft DirectX 8.1 (C++)

IVMRWindowlessControl::SetBorderColor

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

The SetBorderColor method sets the border color to be used by the VMR.

Syntax

HRESULT SetBorderColor(
  COLORREF  Clr
);

Parameters

Clr

[in]  Specifies the border color.

Return Values

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

Error Code Description
VFW_E_WRONG_STATE The VMR is not in windowless mode.

Remarks

The border color is color used to fill any area of the destination rectangle that does not contain video. It is typically used in two instances: (1) when the video straddles two monitors and (2) when the VMR is trying to maintain the aspect ratio of the movie by letter boxing the video to fit within the specified destination rectangle. See the IVMRWindowlessControl::SetAspectRatioMode method.

See Also