IOverlay::SetPalette

  • Article
 
Microsoft DirectShow 9.0

IOverlay::SetPalette

The SetPalette method sets the palette.

Syntax

  HRESULT SetPalette(
  DWORD dwColors,
  PALETTEENTRY *pPalette
);

Parameters

dwColors

[in] Number of colors present.

pPalette

[in] Pointer to colors to use for the palette.

Return Value

Returns S_OK if successful. If the method fails, it returns an HRESULT error code.

Remarks

This method sets a logical palette for the window. The window is not guaranteed to always have the colors requested in the actual system device palette. The Microsoft® Windows® operating system only guarantees those colors when the window is the foreground active window. The current device palette can be obtained by calling IOverlay::GetPalette.

If the device does not have a palette, it returns VFW_E_NO_DISPLAY_PALETTE.

The Overlay Mixer filter returns E_NOTIMPL.

Requirements

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

Library: Use Strmiids.lib.

See Also