Windows Mobile 6.5
A version of this page is also available for

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

HRESULT put_BackgroundPalette(
  long BackgroundPalette


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

Returns an HRESULT value.

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.

Windows Embedded CEWindows CE 2.12 and later
Windows MobilePocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later
NoteMicrosoft 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