IVideoWindow::put_BackgroundPalette

  • Article
 
Microsoft DirectShow 9.0

IVideoWindow::put_BackgroundPalette

The put_BackgroundPalette method specifies whether the video window realizes its palette in the background.

Syntax

  HRESULT put_BackgroundPalette(
    long BackgroundPalette
);

Parameters

BackgroundPalette

[in] Value that specifies whether the video renderer realizes it palette in the background. Must be one of the following values:

Value Description
OATRUE The video renderer realizes the palette in the background.
OAFALSE The video renderer does not realize the palette in the background. (Default.)

Return Values

Possible return values include the following:

Value Description
E_INVALIDARG Invalid argument.
S_OK Success.
VFW_E_NOT_CONNECTED The video renderer filter is not connected.

Remarks

If BackgroundPalette is OATRUE and the video image requires a pallette, the video renderer will realize that palette in the background. Any colors that the palette uses will change to their closest match in the display palette prior to drawing. This ensures that an application will not have its palette disturbed. However, it imposes severe performance penalties on the video.

Requirements

Header: Declared in Control.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also