Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method determines whether any palette required will be realized in the background.

Syntax 

HRESULT put_BackgroundPalette(
  long 
BackgroundPalette
);

Parameters

BackgroundPalette

[in] OATRUE to realize the palette in the background; otherwise, OAFALSE.

Return Value

Returns an HRESULTvalue.

Remarks

If this is OATRUE (–1), any palette required by the video is realized by the renderer in the background. This means that any colors 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 when playing a video. However, this imposes severe performance penalties on the video and should not be used unless absolutely necessary.

The default value for this property is OAFALSE.

Requirements

Windows Embedded CE Windows CE 2.12 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment,
Version 2.12 requires DXPAK 1.0 or later

See Also