IVideoWindow::put_BackgroundPalette method

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

Syntax


HRESULT put_BackgroundPalette(
  [inlong BackgroundPalette
);

Parameters

BackgroundPalette [in]

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 value

Possible return values include the following:

Return codeDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Control.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
IVideoWindow Interface
IVideoWindow::get_BackgroundPalette

 

 

Show: